List relationships

If neither fromEntity or toEntity is given, it is expected that this call will take some time to complete.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The ID of a relationship type, e.g. relationshipTypeIdentifier or namespace.relationshipTypeIdentifier. The namespace must be empty (being global) or a namespace accessible to the customer. The relationship type identifier must match the regex [A-Z][A-Z0-9_]{0,63}.

Query Params
string

Resource name of entity to list relationships from, e.g. entityTypes/ns.type1/entities/ns.entity1.

string

Resource name of entity to list relationships to, e.g. entityTypes/ns.type2/entities/ns.entity2.

integer

Maximum number of results to return. Defaults to 1000, which is the maximum allowed value.

string

Token for a specific page of results, as returned from a previous list request with the same query parameters.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json