Skip to content
Port OS

List relationships

← HTTP API reference
View source specification ↗
GET /relationships

Read-only enumeration of typed relationships between endpoints, routes, groups and group routes. Both vertices must be readable by the caller. Defaults to caller-owned relationships with a bounded page. Provider discovery and group membership operations manage the edges.

Required scope

group:read

Query parameters

ownerstring

Filter the results by the owner of the resource. Defaults to the authenticated caller's resources when omitted. Use '~caller' to make that scope explicit. Another owner can be selected only for resources the caller can read.

groupIdstring

Relationships touching this group or a group route belonging to it.

routeIdstring

Only relationships with this route or group route ID as a vertex

endpointIdstring

Relationships touching this endpoint or a route belonging to it.

vertexIdstring

Relationships touching this exact resource ID.

parentIdstring

Relationships with a route or group-route vertex belonging to this resource ID.

typestring

Only relationships of this type.

Allowed values: IS_PART_OF, CAN_CONTROL, LOCATED_IN, MEMBER_OF.

nextTokenstring

Opaque token for the next page of results. Pass the continuation token returned by the previous response, unchanged. Omit it to start from the first page.

maxResultsinteger

Maximum number of results to return in one page. Defaults to 100. Values from 1 through 100 are accepted.

minimum: 1

maximum: 100

Default: 100

expandarray<string>

Expansion tokens that request related or computed fields for each result. When omitted, the response contains only the default, shallower set of fields for each result.

Returns

200

Relationships retrieved successfully

Fields

resultsarray<Relationship>Required
paginationContextPaginationContext
errorsarray<Error>

Partial query errors collected while returning available results.

Errors

400 BAD_REQUEST

Bad request - missing or invalid parameters

Check the request fields and any validation details, then correct the payload.

401 UNAUTHORIZED

Unauthorized - invalid or missing authentication token

Obtain a valid access token, then retry.

403 FORBIDDEN

Forbidden - insufficient permissions

Check the linked account and its permissions for the device or resource.

500 INTERNAL

Internal server error

Retry with backoff only when the operation is safe to repeat. Include the error code when reporting persistent failures.