Skip to main content

GET /companies/{id}/connected-agencies

Summary

List connected agencies

URL Parameters

NameTypeRequiredDescription
idstringYesCompany identifier

Query Parameters

NameTypeRequiredDescription
pageintegerNoPage number (default 1)
limitintegerNoRecords per page (default 50, max 200)
querystringNoCase-insensitive search against connected-agency name and email
fromstringNoCreated date filter start (YYYY-MM-DD)
tostringNoCreated date filter end (YYYY-MM-DD)
sortByenum(createdAt, updatedAt, name, tier)NoSort field (default name)
sortOrderenum(asc, desc)NoSort direction (default asc)

Request Body Fields

No request body is accepted for this endpoint.

Request Example

curl -X GET 'https://api.requidex.com/api/open/v1/companies/{id}/connected-agencies' \
-H 'Authorization: Bearer <API_KEY>' \
-H 'Accept: application/json'

Response Fields

FieldTypeDescription
idstringConnected-agency record id
agencyobject
Show child attributes
  • id string - Agency id
  • name string - Agency name
connectionLevelstringConnection level. Company results always return company
cisobjectOptional CIS status object
Show child attributes
  • name string - CIS label
  • value number - CIS numeric value
  • display string - CIS display value
tierintegerAgency tier
restrictedbooleanWhether the connected agency is restricted
invoicebooleanWhether invoicing is enabled for the connected agency
drcbooleanWhether domestic reverse charge is enabled
afpbooleanWhether AfP is enabled
emailstringOverride email address for the connected agency
paymentTermsobjectOptional payment terms object
Show child attributes
  • days number - Payment term day count
  • term string - Payment term label
markupAdjustmentnumberMarkup adjustment value
rateUpliftsarray[object]Custom uplift rules
Show child attributes
  • description string - Uplift description
  • type string - Uplift type key
  • uplift number - Default uplift percentage
  • regions array[object] - Region-specific overrides with id, name, and uplift
createdAtstringCreation timestamp
updatedAtstringLast update timestamp

Response Example (200)

{
"success": true,
"data": [
{
"id": "67bc36db80a1616ec3f47070",
"agency": {
"id": "67bc36db80a1616ec3f47060",
"name": "Agency One"
},
"connectionLevel": "company",
"cis": {
"name": "Gross",
"value": 0,
"display": "0%"
},
"tier": 1,
"restricted": false,
"invoice": true,
"drc": false,
"afp": false,
"email": "ops@agency-one.example",
"paymentTerms": {
"days": 30,
"term": "invoice"
},
"markupAdjustment": 12.5,
"rateUplifts": [
{
"description": "Saturday",
"type": "saturday",
"uplift": 50,
"regions": [
{
"id": "67bc36db80a1616ec3f47010",
"name": "South East",
"uplift": 60
}
]
}
],
"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