Skip to main content

GET /trades

Agency-scoped keys

This endpoint is not available for agency-scoped API keys.

Summary

List trades

URL Parameters

  • None

Query Parameters

NameTypeRequiredDescription
companystringNoFilter by company id(s). Pass a single id or comma-separated ids. If omitted, trades for all linked companies are returned.
pageintegerNoPage number (default 1)
limitintegerNoRecords per page (default 50, max 200)
statusenum(active, inactive)NoFilter by trade status
querystringNoCase-insensitive search against trade name
fromstringNoCreated date filter start (YYYY-MM-DD)
tostringNoCreated date filter end (YYYY-MM-DD)
sortByenum(createdAt, updatedAt, name)NoSort field (default name)
sortOrderenum(asc, desc)NoSort direction (default asc)
fieldsstringNoComma-separated list of response fields or dot-path nested fields to return

Request Example

curl -X GET 'https://api.requidex.com/api/open/v1/trades' \
-H 'Authorization: Bearer <API_KEY>' \
-H 'Accept: application/json'

Response Fields

FieldTypeDescription
activebooleanWhether trade is active
companyobjectCompany reference with id and name
createdAtstringCreation timestamp
descriptionstringTrade description
idstringTrade id
masterTradeobjectMaster trade reference with id and name
namestringTrade name
tagsarrayTrade tags with id, name, and description
updatedAtstringLast update timestamp

Response Example (200)

{
"success": true,
"data": [
{
"id": "67bc36db80a1616ec3f47031",
"name": "Electrician",
"description": "Electrical installation and maintenance",
"active": true,
"company": {
"id": "67bc36db80a1616ec3f47001",
"name": "Requidex Construction Ltd"
},
"masterTrade": {
"id": "67bc36db80a1616ec3f47090",
"name": "Electrical"
},
"tags": [
{
"id": "67bc36db80a1616ec3f47111",
"name": "High Voltage",
"description": "Trades approved for high voltage works"
}
],
"createdAt": "2026-01-10T12:00:00.000Z",
"updatedAt": "2026-02-20T14:03:12.111Z"
}
],
"meta": {
"page": 1,
"limit": 50,
"total": 1
}
}

Errors

HTTP StatusDescription
400Invalid filters or parameters
401Missing, invalid, revoked, or expired API key
403Forbidden due to scope or IP restrictions
404Company not found
405Method not allowed on Open API routes
429Rate limit exceeded
500Unexpected internal error