catalog.relationEdges.list

Retrieves a paginated list of relation edges for a specific entity and relation. This endpoint returns entities that are connected to the specified entity through a particular relation, either as incoming or outgoing connections.

This endpoint replaces the legacy incoming_relations and outgoing_relations fields that were previously embedded in entities.* payloads.

Facts


HTTP Method	`GET https://api.getdx.com/catalog.relationEdges.list`
Scope	`catalog:read`

Arguments

Required arguments

Name	Type	Description
`entity_identifier`	String	Identifier of the entity whose relations should be listed. Must belong to the authenticated account and not be soft deleted.
`relation_identifier`	String	Identifier of the relation definition to inspect. Must exist on the same account.

Optional arguments

Name	Type	Description
`direction`	String	Chooses whether the entity is treated as the source (`outgoing`) or target (`incoming`) of the relation edges. Must be either `incoming` or `outgoing`. Defaults to `outgoing`.
`cursor`	String	Opaque pagination token from the previous response. When supplied, the next page begins immediately after the referenced relation edge.
`limit`	Integer	Number of relations to return. Must be between `1` and `50`. Defaults to `25`.

Sorting and pagination

Relations are sorted by created_at DESC, id DESC. The cursor is based on the public_id of the entity record and should be treated as an opaque string by clients.

When response_metadata.next_cursor is null, no additional records are available.

Example request

curl -s \
  -H "Authorization: Bearer <token>" \
  -H "Accept: application/json" \
  "https://api.getdx.com/catalog.relationEdges.list?entity_identifier=payments-service&relation_identifier=service-consumes-api&direction=outgoing&limit=2"

Example response

{
  "ok": true,
  "entity_relations": [
    {
      "identifier": "payment-processing-api",
      "name": "Payment Processing API"
    },
    {
      "identifier": "core-api",
      "name": "Core API"
    }
  ],
  "response_metadata": {
    "next_cursor": "d0d93f40-e534-51ac-0a0a-c839dfa2ff35"
  }
}

Errors

Error	Description
`invalid_arguments`	Missing required parameters, unsupported `direction` value, `limit` outside the range of 1–50, or malformed/expired `cursor`. Error details will indicate the specific parameter causing the issue.
`not_authed`	No authentication token provided.
`entity_not_found`	The requested entity identifier does not exist for the account or is soft deleted.
`relation_not_found`	The relation identifier does not exist for the account.

This table lists only the common expected errors for this method. You should also expect standard service availability errors.

Legacy path

This method is temporarily still available at the following legacy path:

GET https://api.getdx.com/entityRelations.list