v1

latestOpenAPI 3.1.02026-07-241642423.7 KB

List Integration Accesses

Returns a list of Integration Access objects, optionally filtered by company.

get/integrations/accesses

Query parameters

companystring

ID of the company

limitstring

Number of records to return. Max is 25

Response

200

nextstring

previousstring

Example response

{
  "next": "https://sandbox.checkhq.com/integrations/accesses?cursor=cD0lNUIlMjIyMDIyLTA4LTI5KzE5JTNBMTQlM0E1Ni45OTU2NDMlMkIwMCUzQTAwJTIyJTJDKyUyMjI0OSUyMiU1RA%3D%3D",
  "results": [
    {
      "id": "iac_7tbSM8GtZftxyB6I8Fz8",
      "company": "com_mzzhkhIvuWnk0uUj1vmK",
      "status": "pending",
      "integration_permission": "ipe_LEqUV3zmAwqq1W4X8Bs1",
      "access_type": "POLICY_PURCHASED",
      "integration_partner": "int_Fffk6nOGSHtuCTirWqlp",
      "scope": [
        "company:read"
      ]
    }
  ]
}