Skip to Content
CerebrumDocs
GuidesAPI referenceTrust & security

List affiliates for a primary organization

Related workflow: CRA organization set-up · Package access

GET
/v1/organizations/{organizationId}/affiliates

Returns direct affiliates of the requested type. Defaults to CRA; PARENT lists direct children only.

Related: Create affiliate · Get direct child

Authorization

apiKey
headerapikey<token>

Path Parameters

organizationId*string

Primary organization ID

Query Parameters

offset?integer
Range0 <= value
Default0
limit?integer
Range1 <= value <= 30
Default20
type?string

Defaults to CRA

Value in"CRA""PARENT"

Response Body

One page of the organization's direct affiliates of the requested type, each with its relation ID.

application/json
  1. response
data*array<AffiliateListItemResponse>
meta*PaginationMetaResponse
links*PaginationLinksResponse
Example Request
curl -X GET 'https://api.cerebrum.com/v1/organizations/string/affiliates' \  -H 'apikey: CEREBRUM_API_KEY'
Example Response

GET /v1/organizations/{CRA id}/affiliates. Results are ordered by affiliate name.

{  "data": [    {      "affiliate": {        "lifecycleStatus": "ACTIVE",        "id": "a3f1c9d2-6b4e-4c8a-b7e5-2d9f0e1a3c47",        "name": "Northwind Staffing",        "shortName": "northwind-staffing",        "delegateWebhooksToCra": false,        "metadata": null,        "createdAt": "2026-03-04T10:15:00.000Z",        "updatedAt": "2026-03-04T10:15:00.000Z"      },      "relationId": "2b6d8f0a-4c1e-4a3b-8d5f-7e9a1c3b5d02",      "type": "CRA"    },    {      "affiliate": {        "lifecycleStatus": "ACTIVE",        "id": "c8e2b4f6-1a3d-4e5b-9c7a-0f2d4b6e8a19",        "name": "Northwind Staffing West",        "shortName": "northwind-staffing-west",        "delegateWebhooksToCra": false,        "metadata": null,        "createdAt": "2026-11-01T12:00:00.000Z",        "updatedAt": "2026-11-01T12:00:00.000Z"      },      "relationId": "6f1a3c5e-8b2d-4f7a-9c1e-3d5b7f9a1c24",      "type": "CRA"    }  ],  "meta": {    "limit": 20,    "offset": 0,    "total": 2  },  "links": {    "self": "/v1/organizations/5d7c2a8e-3f41-4b6a-9e2d-1c8f0a7b6e10/affiliates?limit=20&offset=0",    "next": null,    "prev": null  }}