List the organization's contact records

Every record this organization has, newest first. Records are org-scoped and unowned — every member sees all of them regardless of who added them. Optionally scope to a parent district or school, or look one up by corpus contact id.

Authorization

AuthorizationBearer <token>

API key (sk_live_... prefix). Generate keys in the UI under Settings > API Keys, then send it as Authorization: Bearer sk_live_...

In: header

Query Parameters

district_id?string

Only records whose parent is this district

Formatuuid

school_id?string

Only records whose parent is this school

Formatuuid

contact_id?string

The record overlaying this corpus contact, if any

Formatuuid

Response Body

`application/json`

curl -X GET "https://loading/api/v1/org-contacts"

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",
      "contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598",
      "name": "string",
      "district_id": "880bc4ee-477a-4e12-a0f0-c89f020ba05d",
      "school_id": "c1317ebe-519d-4c8a-9ab1-7bfd15017c1c",
      "notes": "string",
      "tags": [
        "string"
      ],
      "added_at": "string",
      "added_via": "reveal",
      "added_by": "6f5851d8-8a63-4597-95ec-4f964b8e7696",
      "overrides": {
        "property1": "string",
        "property2": "string"
      },
      "overridden_at": {
        "property1": "string",
        "property2": "string"
      },
      "promoted_from_brief_id": "7d555af3-e03f-40b9-9ba9-f70a244e4343",
      "promoted_person_key": "string"
    }
  ]
}

{
  "error": "string",
  "message": "string",
  "statusCode": -9007199254740991
}

List the organization's contact records

Authorization

Query Parameters

Response Body

200application/json

401application/json

`application/json`

`application/json`