> ## 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 FEM Module Data

## Specify what data fields to return (include)

```json theme={null}
        "performance",
        "focus_areas"
    ],
```

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

  * `questions` will return [ALL indicators](/v1.0/docs/fem-data-dictionary). This can be VERY large. Indicator names are same as in bulk CSV and prefixed by 'questions.'
  * `performance` will return all indicators in the [performance dataset](/v1.0/docs/fem-data-dictionary#performance)
  * `scores` will return all total, section, and subsection level [scores](/v1.0/docs/fem-data-dictionary#scores)
  * `ghg` will return all calculated [greenhouse gas emissions](/v1.0/docs/fem-data-dictionary#ghgs-greenhouse-gases)
  * `usage` will return all quantitative [resource usage metrics](/v1.0/docs/fem-data-dictionary#resource-usage)
  * `focus_areas` will return all indicators grouped in [critical risks and areas of opportunity](/v1.0/docs/fem-data-dictionary#focus-areas)
</Note>

Note that this be limited down to individual indicators.

## Specify which records to return (query)

```json theme={null}
"filters":[
   { "field": "version", "operator": "contains", "value": ["fem2020"]},
   { "field": "performance.total_fem_score", "operator": "gte", "value": 60}
   ],
"sort": [
   { "field": "created_on", "value": "desc" }
   ],
"accountIds": ["5310","8e9ac94b-5e25-48fb-b889-0b0db4e15de5"],
"from": 0,
"size": 1
```

<Note title="version">
  Specify a single module category of data to retrieve (`fem2017` / `fem2018` / `fem2019` / `fem2020` / `fem2021`/ `fem2022` / `fem2023`)
</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 Worldly account identifiers are supported as being queryable: `sacId` (0-6 digit number auto-assigned to every Worldly account), `accountId` (longer UUID auto-assigned to every Worldly account), `oarId` (15-character unique identifier assigned to each facility in the [Open Supply Hub](https://info.opensupplyhub.org/)), `ffcId` (a unique identifier assigned to every user on the Fair Factories Clearinghouse platform; numeric and no longer than 9 digits) `taxId` (a government issued tax identifier), `socialCreditId` (a state-issued identifier in China), `customId` (a custom identifier that can be assigned to another Worldly account, only visible to the author).
  For example:\
  `"accountIds": ["accountId","sacID","oarID","ffcId",
    "taxId","socialCreditId","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="performance">
  Use the filters array to query for performance data with specific field values. This is an "and" query that supports the following operators: `contains`, `startswith`, `noteq`, `eq`, `lte`, `gte`, `gt`, `lt`. Fields are identified by `performance.field_id`.
  For example, this would query for any FEM2020 where the `total_fem_score` is greater than or equal to 60.\
  `"filters":[         { "field": "version", "operator": "contains", "value": ["fem2020"]},         { "field": "performance.total_fem_score", "operator": "gte", "value": 60}
           ]`
</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>