Skip to main content
GET
/
storage
/
relationships
/
list
List relationships
curl --request GET \
  --url https://api.getcargo.io/v1/storage/relationships/list \
  --header 'Authorization: Bearer <token>'
{
  "relationships": [
    {
      "uuid": "<string>",
      "workspaceUuid": "<string>",
      "fromDatasetUuid": "<string>",
      "fromModelUuid": "<string>",
      "fromColumnSlug": "<string>",
      "fromPropertySlug": "<string>",
      "toDatasetUuid": "<string>",
      "toModelUuid": "<string>",
      "toColumnSlug": "<string>",
      "toPropertySlug": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.getcargo.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
datasetUuid
string<uuid>

Filter relationships by dataset identifier.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$
​
modelUuid
string<uuid>

Filter relationships by model identifier.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

Response

Successful response

​
relationships
Relationships · object[]
required

List of relationships.