Try a request

Loading API specification…

API keyBearer authentication

Held in memory for this tab only. Clear it or refresh to forget it.

Code examplecURLJavaScriptPython

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

Requests go directly to the production API and use your key’s scopes and rate limits. GET requests only.

List Connected Agencies

GET/companies/{id}/connected-agencies

Agency-scoped keys

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

Access

Requirement	Value
Scope	read:companies
Company-scoped keys	Supported
Agency-scoped keys	Not supported

Summary

Returns the agencies connected to a company, including supplier relationship details used for access, tiering, and configuration.

The response includes supplierType (agency or umbrella) from the company connection, defaulting to agency for existing connections. Project settings do not override this classification. For umbrella suppliers, display rate types without an Agency or Umbrella prefix. Stored rateType values remain unchanged.

Path Parameters

Name	Type	Required	Description
id	string	Yes	Company identifier

Query Parameters

Name	Type	Required	Description
page	integer	No	Page number (default 1)
limit	integer	No	Records per page (default 50, max 200)
query	string	No	Case-insensitive search against connected-agency name and email
from	string	No	Created date filter start (YYYY-MM-DD)
to	string	No	Created date filter end (YYYY-MM-DD)
sortBy	enum(createdAt, updatedAt, name, tier)	No	Sort field (default name)
sortOrder	enum(asc, desc)	No	Sort direction (default asc)
fields	string	No	Comma-separated list of response fields or dot-path nested fields to return

Request Example

cURL

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

JavaScript

const response = await fetch(
  "https://api.requidex.com/api/open/v1/companies/{id}/connected-agencies",
  {
    method: "GET",
    headers: {
      Authorization: "Bearer <API_KEY>",
      Accept: "application/json",
    },
  },
);

const json = await response.json();

Python

import requests

response = requests.request(
    'GET',
    'https://api.requidex.com/api/open/v1/companies/{id}/connected-agencies',
    headers={
        'Authorization': 'Bearer <API_KEY>',
        'Accept': 'application/json',
    },
    timeout=30,
)

print(response.json())

Go

package main

import (
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://api.requidex.com/api/open/v1/companies/{id}/connected-agencies", nil)
  req.Header.Set("Authorization", "Bearer <API_KEY>")
  req.Header.Set("Accept", "application/json")

  client := &http.Client{}
  resp, err := client.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()

  payload, _ := io.ReadAll(resp.Body)
  fmt.Println(string(payload))
}

Response Fields

Field	Type	Description
afp	boolean	Whether AfP is enabled
agency	object	Show child attributes id string - Agency id name string - Agency name
cis	object	Optional CIS status object Show child attributes name string - CIS label value number - CIS numeric value display string - CIS display value
connectionLevel	string	Connection level. Company results always return company
createdAt	string	Creation timestamp
drc	boolean	Whether domestic reverse charge is enabled
email	string	Override email address for the connected agency
id	string	Connected-agency record id
invoice	boolean	Whether invoicing is enabled for the connected agency
markupAdjustment	number	Default agency markup adjustment in percentage points
paymentTerms	object	Optional payment terms object Show child attributes days number - Payment term day count term string - Payment term label
rateUplifts	array[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
restricted	boolean	Whether the connected agency is restricted
tier	integer	Agency tier
tradeMarkupAdjustments	array[object]	Trade-specific agency markup adjustments. A matching adjustment replaces markupAdjustment for that trade. Each item contains a trade reference and numeric adjustment in percentage points Show child attributes trade object or null Show child attributes id string or null — Entity id name string — Entity name adjustment number — Agency markup adjustment percentage points for this trade. This replaces the agency default adjustment for the trade.
tradeUpliftOverrides	array[object]	Trade-specific agency uplift overrides. A matching override replaces the agency-wide uplift configuration for that trade. Each item contains a trade reference, a mode of standard or enhanced, and the corresponding rateUplifts or enhancedUplifts configuration Show child attributes trade object or null Show child attributes id string or null — Entity id name string — Entity name mode string — The uplift calculation mode used for this trade rateUplifts array of objects — Standard uplift rules. Returned when mode is standard. Show child attributes description string type string uplift number or null regions array of objects Show child attributes id string or null name string uplift number or null enhancedUplifts object — Enhanced uplift configuration. Returned when mode is enhanced. Show child attributes enabled boolean — Whether enhanced uplifts are enabled mode string or null — Enhanced uplift calculation mode weekly object or null Show child attributes threshold number or null — Weekly hours threshold enforce boolean — Whether the threshold must be worked before uplifts apply nightThreshold number or null — Weekly night-shift hours threshold nightEnforce boolean — Whether the night-shift threshold must be worked before night-shift uplifts apply backshiftThreshold number or null — Weekly backshift hours threshold backshiftEnforce boolean — Whether the backshift threshold must be worked before backshift uplifts apply reduce boolean — Whether authorised absences reduce the threshold blockThresholds object or null — Optional weekly threshold overrides keyed by uplift block index (for example block 3 or block 4) nightBlockThresholds object or null — Optional weekly night-shift threshold overrides keyed by uplift block index (for example block 3 or block 4) backshiftBlockThresholds object or null — Optional weekly backshift threshold overrides keyed by uplift block index (for example block 3 or block 4) days object or null Show child attributes mon object or null Show child attributes enabled boolean dayShift object or null Show child attributes startTime number or null breakAssumption number or null blocks array of objects Show child attributes startHour number or null endHour number or null upliftPercentage number or null nightShift object or null Show child attributes startTime number or null breakAssumption number or null blocks array of objects Show child attributes startHour number or null endHour number or null upliftPercentage number or null backShift object or null Show child attributes startTime number or null breakAssumption number or null blocks array of objects Show child attributes startHour number or null endHour number or null upliftPercentage number or null tue object or null Show child attributes enabled boolean dayShift object or null Show child attributes startTime number or null breakAssumption number or null blocks array of objects Show child attributes startHour number or null endHour number or null upliftPercentage number or null nightShift object or null Show child attributes startTime number or null breakAssumption number or null blocks array of objects Show child attributes startHour number or null endHour number or null upliftPercentage number or null backShift object or null Show child attributes startTime number or null breakAssumption number or null blocks array of objects Show child attributes startHour number or null endHour number or null upliftPercentage number or null wed object or null Show child attributes enabled boolean dayShift object or null Show child attributes startTime number or null breakAssumption number or null blocks array of objects Show child attributes startHour number or null endHour number or null upliftPercentage number or null nightShift object or null Show child attributes startTime number or null breakAssumption number or null blocks array of objects Show child attributes startHour number or null endHour number or null upliftPercentage number or null backShift object or null Show child attributes startTime number or null breakAssumption number or null blocks array of objects Show child attributes startHour number or null endHour number or null upliftPercentage number or null thu object or null Show child attributes enabled boolean dayShift object or null Show child attributes startTime number or null breakAssumption number or null blocks array of objects Show child attributes startHour number or null endHour number or null upliftPercentage number or null nightShift object or null Show child attributes startTime number or null breakAssumption number or null blocks array of objects Show child attributes startHour number or null endHour number or null upliftPercentage number or null backShift object or null Show child attributes startTime number or null breakAssumption number or null blocks array of objects Show child attributes startHour number or null endHour number or null upliftPercentage number or null fri object or null Show child attributes enabled boolean dayShift object or null Show child attributes startTime number or null breakAssumption number or null blocks array of objects Show child attributes startHour number or null endHour number or null upliftPercentage number or null nightShift object or null Show child attributes startTime number or null breakAssumption number or null blocks array of objects Show child attributes startHour number or null endHour number or null upliftPercentage number or null backShift object or null Show child attributes startTime number or null breakAssumption number or null blocks array of objects Show child attributes startHour number or null endHour number or null upliftPercentage number or null sat object or null Show child attributes enabled boolean dayShift object or null Show child attributes startTime number or null breakAssumption number or null blocks array of objects Show child attributes startHour number or null endHour number or null upliftPercentage number or null nightShift object or null Show child attributes startTime number or null breakAssumption number or null blocks array of objects Show child attributes startHour number or null endHour number or null upliftPercentage number or null backShift object or null Show child attributes startTime number or null breakAssumption number or null blocks array of objects Show child attributes startHour number or null endHour number or null upliftPercentage number or null sun object or null Show child attributes enabled boolean dayShift object or null Show child attributes startTime number or null breakAssumption number or null blocks array of objects Show child attributes startHour number or null endHour number or null upliftPercentage number or null nightShift object or null Show child attributes startTime number or null breakAssumption number or null blocks array of objects Show child attributes startHour number or null endHour number or null upliftPercentage number or null backShift object or null Show child attributes startTime number or null breakAssumption number or null blocks array of objects Show child attributes startHour number or null endHour number or null upliftPercentage number or null bankHol object or null Show child attributes enabled boolean dayShift object or null Show child attributes startTime number or null breakAssumption number or null blocks array of objects Show child attributes startHour number or null endHour number or null upliftPercentage number or null nightShift object or null Show child attributes startTime number or null breakAssumption number or null blocks array of objects Show child attributes startHour number or null endHour number or null upliftPercentage number or null backShift object or null Show child attributes startTime number or null breakAssumption number or null blocks array of objects Show child attributes startHour number or null endHour number or null upliftPercentage number or null
updatedAt	string	Last 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,
      "tradeMarkupAdjustments": [
        {
          "trade": {
            "id": "67bc36db80a1616ec3f47020",
            "name": "Electrician"
          },
          "adjustment": 4
        }
      ],
      "rateUplifts": [
        {
          "description": "Saturday",
          "type": "saturday",
          "uplift": 50,
          "regions": [
            {
              "id": "67bc36db80a1616ec3f47010",
              "name": "South East",
              "uplift": 60
            }
          ]
        }
      ],
      "tradeUpliftOverrides": [
        {
          "trade": {
            "id": "67bc36db80a1616ec3f47020",
            "name": "Electrician"
          },
          "mode": "standard",
          "rateUplifts": [
            {
              "description": "Sunday",
              "type": "sunday",
              "uplift": 75,
              "regions": []
            }
          ]
        }
      ],
      "createdAt": "2026-01-10T12:00:00.000Z",
      "updatedAt": "2026-02-20T14:03:12.111Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 50,
    "total": 1
  }
}

MCP Tool

The MCP server exposes this operation as open_api_list_company_connected_agencies with the inputs id, page, limit, query, from, to, sortBy, sortOrder, and fields.

Errors

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