AplasAplas API Reference

List an asset's relations

Both directions, distinguished by direction. Relations PROJECTED from an asset's own fields (integration endpoints, collection members, relation-field mirrors) are listed with projected: true — they are real relations, but they cannot be written through this API because their handler rebuilds them on the projecting asset's next save.

Cursor-paginated, like every other list here: a highly connected asset — a shared platform, an estate-wide tag — can carry thousands of edges.

GET
/workspaces/{workspaceId}/asset-types/{typeId}/assets/{assetId}/relations

Authorization

BearerAuth
AuthorizationBearer <token>

API authentication via Authorization: Bearer <your-api-key>. Obtain your API key from Config → API in the Aplas web app.

In: header

Path Parameters

workspaceId*string

The workspace's slug.

typeId*string

The asset type's slug.

assetId*string

The asset's slug. Unique within its asset type, not across the workspace — which is why assets are addressed beneath their type.

Query Parameters

limit?integer

Maximum number of resources to return in one page.

Default50
Range1 <= value <= 200
cursor?string

Opaque cursor from a previous response's nextCursor. Omit to fetch the first page.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.au.aplas.com/api/v3/workspaces/string/asset-types/string/assets/string/relations"
{
  "nextCursor": "string",
  "data": [
    {
      "relationshipType": "string",
      "direction": "outgoing",
      "asset": {
        "type": "string",
        "id": "string",
        "name": "string"
      },
      "ordinal": 0,
      "projected": true,
      "fields": {}
    }
  ]
}
{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "The permissions of your API key only allow read-only/GET calls."
}
{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "The permissions of your API key only allow read-only/GET calls."
}
{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "The permissions of your API key only allow read-only/GET calls."
}
{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "The permissions of your API key only allow read-only/GET calls."
}