Pre-release — content may change.

Connections

List connections

GET
/connections

A paginated list of connections between people and organizations. Each connection links a from party to a to party via a connection type. By default only person_to_organization connections are returned; pass a connection_type filter to widen or narrow this.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

include?string

Comma-separated list of relationships to include. Allowed values are resource-specific; consult the operation for the allowlist.

sort?string

Comma-separated list of attributes to sort by. Prefix with - for descending order (-created_at,family_name).

page?

Offset pagination parameters.

filter?

Keys take the form filter[<attribute>_<predicate>]=<value>, repeatable per query.

Common predicates by attribute type:

  • String / text / uuid: eq, not_eq, cont, not_cont, matches, start, end, present, blank, null, not_null, in, not_in
  • Integer / decimal / date / datetime: eq, not_eq, gt, gteq, lt, lteq, present, blank, null, not_null, in, not_in
  • Boolean: eq, not_eq, present, blank, null, not_null

Example: ?filter[connection_type_eq]=all&filter[active_eq]=true

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/connections"
{  "data": [    {      "type": "connections",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "attributes": {        "starts_at": "2019-08-24T14:15:22Z",        "ends_at": "2019-08-24T14:15:22Z",        "starts_on": "2019-08-24",        "ends_on": "2019-08-24",        "description": "string",        "tags": [          "string"        ],        "type": "string",        "active": true,        "created_at": "2019-08-24T14:15:22Z",        "updated_at": "2019-08-24T14:15:22Z"      },      "relationships": {},      "links": {        "self": "/connections/7247ad7d-9275-454b-9e3a-0570e403739e"      }    }  ],  "meta": {    "page": {      "total_items": 0,      "total_pages": 0,      "number": 0,      "size": 0    }  }}
{  "errors": [    {      "status": 0,      "title": "string",      "source": {        "pointer": "string",        "parameter": "string"      },      "meta": {        "error": "string",        "field": "string"      }    }  ]}
{  "errors": [    {      "status": 0,      "title": "string",      "source": {        "pointer": "string",        "parameter": "string"      },      "meta": {        "error": "string",        "field": "string"      }    }  ]}