Skip to main content
GET
Read Profile Connections

Filtering

This endpoint accepts filter and sort query parameters. See Filtering, sorting, and search for paging and for the shared search_with, custom_field, and json_contains filters.

Examples

Operators

The not_has operator applies to related attributes, which this endpoint does not have.

Filter attributes

Each attribute above is also a valid sort key, for example ?sort=-connected_at for descending order.

Custom field filters

Connection records carry custom fields, so this endpoint also accepts filter[custom_field][namespace:handle].
Returns one side of a Profile’s Connections. A Connection links two Profiles, stored as connected_id and connector_id, and the type parameter chooses which of those two columns the Profile in the path is matched against.

Endpoint parameters

Alongside the filters above, this endpoint accepts three parameters of its own.

Choosing a side

type names the role the Profile in the path plays, not the role of the other Profile. Omneo does not reserve either column for a particular real-world role. Which column holds which Profile depends on the Connection Definition and on what created the Connection. So the value you need depends on the direction you are reading:
connected_id and connector_id are not filter attributes, so filter[connector_id] has no effect. Use type to select the side.There is no value that returns both sides. To read every Connection touching a Profile, call the endpoint twice, once with type=connected and once with type=connector, then combine the results.

Narrowing to one relationship type

The type parameter above is unrelated to the type field on a Connection Definition. This endpoint cannot filter on the Definition’s type, so narrowing to one kind of relationship takes two steps. First resolve the Definition IDs you want. The Connection Definition endpoint does accept filter[type]:
Then filter this endpoint by those IDs:
See Connections for the Definition type values, and Browse Connection Definitions for the full filter list.

Path Parameters

profile
string<uuid>
required

The profile ID

Query Parameters

page[size]
string

Response

Array of Connection

data
Connection · object[]
required