> ## Documentation Index
> Fetch the complete documentation index at: https://developer.worldly.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get BRM Module Data

## Specify what data fields to return (include)

```json theme={null}
        "scores"
    ],
```

<Note title="include">
  Specify an array of which groups of indicators to retrieve for an assessment.

  * `questions` will return ALL indicators. This can be VERY large. Indicator names are same as in bulk CSV and prefixed by 'questions.'
  * `scores` will return all total, section, and subsection level scores
  * `focus_areas` will return all indicators grouped into areas of opportunities for improvement
</Note>

## Specify which records to return (query)

<Note title="version">
  Specify a single module category of data to retrieve (`brm2019`, `brm2020`, `brm2021`)
</Note>

<Note title="status">
  An array of assessment statuses to query for.
</Note>

<Note title="verified">
  Boolean filter for verified (true) or unverified (false) assessments
</Note>

<Note title="accountIds">
  Specify an array of account identifiers to retrieve assessments for. The following Higg account identifiers are supported as being queryable: `sacId` (0-6 digit number auto-assigned to every Higg account), `accountId` (longer UUID auto-assigned to every Higg account), `taxId` (a government issued tax identifier), `customId` (a custom identifier that can be assigned to another Higg account, only visible to the author).
  For example: `"accountIds": ["accountId","sacID","taxId","customId"]`
</Note>

<Note title="assessmentIds">
  Specify an array of specific assessments to retrieve data from. If not specified, retrieves all assessments of specified `rfi_pid` (subject to other query specifiers). Note that this can have unintuitive side-effects if you specify assessment ID's that do not come from the specified Account ID's.
</Note>

<Note title="lastUpdated">
  Filter for records that have been updated since the provided timestamp. Timestamp must be in unix time in milliseconds.
</Note>

<Note title="lastStatusChange">
  Filter for records that have changed status since the provided timestamp. Timestamp must be in unix time in milliseconds
</Note>

<Note title="from">
  Integer value of where to start the window of results. If not specified, defaults to 0.
</Note>

<Note title="size">
  Integer value of how many results to return. If not specified, defaults to 10.\
  **Note: Maximum number of results returned is 30.**
</Note>

## Sort the responses

<Note title="created_on">
  Sort the returned data by the date on which the assessment was created. Supports `ASC` and `DESC`.
  Example: `"sort": [{ "field": "created_on", "value": "desc" }],`
</Note>