Skip to main content
POST
/
fem
cURL
curl --request POST \
  --url https://api-v2.production.higg.org/api/v1/modulecsv/fem \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-developer-request-token: <api-key>' \
  --data '
{
  "from": 123,
  "size": 123,
  "oarIds": [
    "<string>"
  ],
  "assessmentIds": [
    "<string>"
  ],
  "accountIds": [
    "<string>"
  ],
  "accountSacIds": [
    "<string>"
  ],
  "version": "fem2017",
  "status": [
    "NS"
  ],
  "verified": true,
  "include": [
    "<string>"
  ],
  "lastUpdated": 123,
  "lastActivityDate": 123,
  "lastStatusChange": 123,
  "lastASCStatusDate": 123,
  "greaterThanYear": 123,
  "cafVersion": "1.7",
  "dctVersion": "<string>",
  "filters": [
    {
      "field": "<string>",
      "operator": "<string>",
      "value": {}
    }
  ],
  "nextPage": "<string>",
  "facilityPosted": true,
  "sipfacilitytype": [
    "<string>"
  ],
  "sort": [
    {
      "field": "<string>",
      "value": "asc"
    }
  ],
  "verificationPosted": 123,
  "rfi_pid": "fem2017",
  "wildcardSearch": {
    "sacId": "<string>",
    "accountName": "<string>",
    "oarId": "<string>",
    "tags": "<string>",
    "accountId": "<string>",
    "customId": "<string>",
    "ffcId": "<string>"
  },
  "reportingPeriodStart": 123,
  "reportingPeriodEnd": 123,
  "isBaseMaterialFilter": true
}
'

​
Specify what data fields to return (include)

"include": [
        "performance",
        "focus_areas"
    ],
Specify an array of which groups of indicators to retrieve for an assessment.
Note that this be limited down to individual indicators.

Limit response data to only include specific fields

View recipe

​
Specify which records to return (query)

Example json request for a combination of query parameters
"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
Specify a single module category of data to retrieve (fem2017 / fem2018 / fem2019 / fem2020 / fem2021/ fem2022 / fem2023)
An array of assessment statuses to query for.
Boolean filter for verified (true) or unverified (false) assessments
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), 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"]
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.
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} ]
Filter for records that have been updated since the provided timestamp. Timestamp must be in unix time in milliseconds.
Filter for records that have changed status since the provided timestamp. Timestamp must be in unix time in milliseconds.
Filter for records that have been shared with your account, or updated, since the provided timestamp. Timestamp must be in unix time in milliseconds.
Integer value of where to start the window of results. If not specified, defaults to 0.
Integer value of how many results to return. If not specified, defaults to 10.
Note: Maximum number of results returned is 30.

​
Sort the responses

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

Authorizations

​
x-api-key
string
header
required
​
x-developer-request-token
string
header
required

Body

application/json
​
from
number<double> | null
​
size
number<double> | null
​
oarIds
string[] | null
​
assessmentIds
string[] | null
​
accountIds
string[] | null
​
accountSacIds
string[] | null
​
version
enum<string>

This interface was referenced by Exports's JSON-Schema via the definition "assessmentRfiPid".

Available options:
fem2017,
fem2018,
fem2019,
fem2020,
fem2021,
fem2022,
fem2023,
fem2024,
fem2025,
fslm,
brm2019,
brm2020,
brm2021,
brm2022,
brm2023,
brm2024,
brm2025,
dct,
one2022,
ffc
​
status
enum<string>[] | null

This interface was referenced by Exports's JSON-Schema via the definition "assessmentStatus".

Available options:
NS,
ASI,
ASC,
VRP,
VRQ,
VRE,
VRC,
VRD,
VRF,
VRI,
ASD
​
verified
boolean | null
​
include
string[] | null
​
lastUpdated
number<double> | null
​
lastActivityDate
number<double> | null
​
lastStatusChange
number<double> | null
​
lastASCStatusDate
number<double> | null
​
greaterThanYear
number<double> | null
​
cafVersion
enum<string>
Available options:
1.7,
1.6,
1.5,
1.4,
1.3
​
dctVersion
string | null
​
filters
object[] | null
​
nextPage
string | null
​
facilityPosted
boolean | null
​
sipfacilitytype
string[] | null
​
sort
object[] | null
​
verificationPosted
number<double> | null
​
rfi_pid
enum<string>

This interface was referenced by Exports's JSON-Schema via the definition "assessmentRfiPid".

Available options:
fem2017,
fem2018,
fem2019,
fem2020,
fem2021,
fem2022,
fem2023,
fem2024,
fem2025,
fslm,
brm2019,
brm2020,
brm2021,
brm2022,
brm2023,
brm2024,
brm2025,
dct,
one2022,
ffc
​
wildcardSearch
object
​
reportingPeriodStart
number<double> | null
​
reportingPeriodEnd
number<double> | null
​
isBaseMaterialFilter
boolean | null

Response

204

No content