Get all BRM assessments

POST /brm

cURL

cURL

curl --request POST \
  --url https://api-v2.production.higg.org/api/v1/modulecsv/brm \
  --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>"
  ],
  "status": [],
  "verified": true,
  "include": [
    "<string>"
  ],
  "lastUpdated": 123,
  "lastActivityDate": 123,
  "lastStatusChange": 123,
  "lastASCStatusDate": 123,
  "greaterThanYear": 123,
  "dctVersion": "<string>",
  "filters": [
    {
      "field": "<string>",
      "operator": "<string>",
      "value": {}
    }
  ],
  "nextPage": "<string>",
  "facilityPosted": true,
  "sipfacilitytype": [
    "<string>"
  ],
  "sort": [
    {
      "field": "<string>"
    }
  ],
  "verificationPosted": 123,
  "wildcardSearch": {
    "sacId": "<string>",
    "accountName": "<string>",
    "oarId": "<string>",
    "tags": "<string>",
    "accountId": "<string>",
    "customId": "<string>",
    "ffcId": "<string>"
  },
  "reportingPeriodStart": 123,
  "reportingPeriodEnd": 123,
  "isBaseMaterialFilter": true
}
'

Retrieves BRM (Brand & Retail Module) assessment data as a CSV stream based on the filters you provide.

Request body properties

Use the following properties in the request body to filter and paginate your results.

Specify the BRM version to retrieve (e.g., brm2019, brm2020, brm2021, brm2022, brm2023, brm2024, brm2025).

An array of assessment statuses to query for. Possible values include ASI (Assessment In Progress), ASC (Assessment Completed), VRF (Verified).

Example: "status": ["ASI", "ASC"]

Filter for records that have changed status since the provided timestamp. The timestamp must be in Unix time in milliseconds.

Filter for records that have been updated since the provided timestamp. The timestamp must be in Unix time in milliseconds.

Boolean filter for verified (true) or unverified (false) assessments.

JSON request example

{
  "status": ["ASI", "ASC"],
  "lastStatusChange": 1672531200000,
  "lastUpdated": 1672531200000,
  "verified": true,
  "version": "brm2023"
}

Additional filters

Name	Type	Description
accountIds	Array<string>	List of account IDs to filter by.
accountSacIds	Array<string>	List of SAC IDs to filter by.
assessmentIds	Array<string>	List of specific assessment IDs to retrieve.
cafVersion	string	Filter by CAF version.
dctVersion	string	Filter by DCT version.
facilityPosted	boolean	Filter for facilities that have been posted.
filters	Array<object>	Advanced field filters. Each object must include field, operator, and value.
from	number	Starting index for pagination.
greaterThanYear	number	Filter assessments greater than a given year.
include	Array<string>	List of fields to include in the response.
isBaseMaterialFilter	boolean	Filter by base material status.
lastASCStatusDate	number	Filter for records with an ASC status date since the provided timestamp.
lastActivityDate	number	Filter for records that have been shared with your account, or updated, since the provided timestamp.
lastStatusChange	number	Filter for records that have changed status since the provided timestamp.
lastUpdated	number	Filter for records that have been updated since the provided timestamp.
nextPage	string	Pagination token for the next page of results.
oarIds	Array<string>	List of OAR IDs to filter by.
reportingPeriodEnd	number	Filter assessments by reporting period end.
reportingPeriodStart	number	Filter assessments by reporting period start.
rfi_pid	object	Assessment module version filters.
sipfacilitytype	Array<string>	List of SIP facility types to filter by.
size	number	Number of records to return per request.
sort	Array<object>	Sort order for the results. Each object in the array should contain field and value (asc or desc).
status	Array<string>	Array of assessment statuses to query for.
verificationPosted	number	Filter by verification posted timestamp.
verified	boolean	Boolean filter for verified (true) or unverified (false) assessments.
wildcardSearch	object	Free-text search fields such as sacId, accountName, oarId, tags, accountId, customId, and ffcId.

Implementation details

• This endpoint uses a POST request to allow for complex filtering that might exceed URL length limits for query parameters.
• The response is a CSV stream containing the requested assessment data.
• All timestamps must be in Unix time in milliseconds (e.g., 1672531200000).

Limit bulk CSV data by assessment status and timestamp of last status change

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, fem2026, 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: 2.0, 1.7, 1.6, 1.5, 1.4, 1.3

dctVersion · string | null

filters · object[] | null

Show child attributes

nextPage · string | null

facilityPosted · boolean | null

sipfacilitytype · string[] | null

sort · object[] | null

Show child attributes

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, fem2026, fslm, brm2019, brm2020, brm2021, brm2022, brm2023, brm2024, brm2025, dct, one2022, ffc

wildcardSearch · object

Show child attributes

reportingPeriodStart · number<double> | null

reportingPeriodEnd · number<double> | null

isBaseMaterialFilter · boolean | null

Response

204

No content