1. API reference
  3. Records
  5. List the records linked to one record through one relation.
  • API reference
  • GETIdentify the calling credential.
  • GETList the webhook events you can subscribe to.
  • GETList the webhook subscriptions this credential owns.
  • POSTSubscribe an HTTPS endpoint to record events on one object.
  • GETGet one webhook subscription by slug.
  • DELETEDelete a webhook subscription.
  • GETList the field types you can create.
  • GETList the file formats a file field can accept.
  • GETList the active tag fields of all objects, one page at a time.
  • GETList every field in the workspace, one page at a time.
  • GETList the fields of an object, one page at a time.
  • POSTAdd a field to an object.
  • GETList all fields an object owns, active and inactive.
  • GETList the active fields of an object, relations included.
  • GETList the select, status and priority fields of an object.
  • GETList the fields that can make another field required.
  • GETGet one field by slug.
  • POSTCopy fields of an object into other objects.
  • POSTAdd one choice to a choice field.
  • PUTChange the order of an object's fields.
  • PUTUpdate a field's settings.
  • DELETEDelete a field and its values.
  • PUTTurn a field on or off on an object.
  • GETList the workspace tags.
  • POSTAdd a tag to the workspace list.
  • PUTReorder the workspace tags.
  • POSTAdd a tag from a record of one object.
  • GETGet one tag with its usage.
  • DELETEDelete a tag, or retire it when records still hold it.
  • PATCHRename or recolor a tag.
  • GETList which optional record features this deployment has turned on.
  • GETList objects, one page at a time.
  • POSTCreate an object.
  • GETList the active objects the credential can read.
  • GETCount records and saved views for each active object.
  • GETGet workspace totals for records, saved views and objects.
  • GETList the duplicate-detection rule of every object.
  • GETCheck whether an object name is free to use.
  • GETGet one object by slug.
  • PUTUpdate an object's name, description, icon, status or folder.
  • DELETEDelete an object and all of its records.
  • GETList the other active objects, for picking a relation target.
  • GETList the active fields of an object.
  • GETGet the duplicate-detection rule of an object.
  • PUTSet the duplicate-detection rule of an object.
  • PUTChange the display order of objects.
  • PUTTurn an object on or off.
  • PUTTurn an object's public form on or off.
  • GETList records as slug and name pairs, for pickers.
  • GETList an object's records, with filters and sorting.
  • POSTCreate a record.
  • POSTSearch an object's records by free text.
  • GETList the records you can link through every relation of an object.
  • GETList the records you can link through one relation field.
  • GETList the records that share a value in one field.
  • GETList the values of dependent filter fields.
  • GETList the records linked to one record through one relation.
  • POSTList the distinct values stored in one field, most common first.
  • POSTGet badge counts for a set of records.
  • GETList the options a select-type field allows.
  • GETGet one record by slug, with its columns and change history.
  • PUTUpdate a record.
  • DELETEDelete a record.
  • GETList every change to one record, newest first.
  • GETList one page of a record's change history, with filters.
  • POSTDuplicate a record.
  • POSTCreate a record from a quick-add row in a table or board.
  • POSTUpdate, assign or delete many records in one call.
  • POSTDuplicate many records in one call.
  • POSTCancel a queued or running bulk job.
  • GETGet the report of a bulk job.
  • POSTDelete up to 500 records by slug.
  • POSTSet the assignees of up to 500 records.
  • PATCHReplace the assignees of a record.
  • PATCHMove a record between two others in manual board order.
  • POSTApply the same change to up to 500 records.
  • DELETEDelete all records of an object.
  • GETGet a short-lived URL for one stored file.
  • GETDownload one stored file.
  • POSTGet short-lived URLs for up to 100 stored files in one call.
GET/api/v1/object/data/{objectSlug}/{dataSlug}/relations/{relationSlug}

List the records linked to one record through one relation.

List the records linked to one record through one relation.

A relation cell on a record read holds one page of linked records. When its pagination.nextPage is not null, call this route for the rest. relationSlug is the key of that cell in the record's relations. Linked records come newest first, in the same order as the cell, so the first page starts with the records the cell already showed. Only linked records the credential can see are returned.

relation_type at the top level is belongsTo or hasMany. A belongs-to relation returns at most one record. An item carries columns, keyed by field slug, when the relation has display columns set.

Query parameters:

  • page — page number, from 1. Default 1.
  • limit — records per page, up to 200. Default 25.

Scope: read.<object slug>, for example read.contacts.

Errors:

  • 400 — no active object has that slug.
  • 400 — Data with slug '9f2c4b7a1e03' not found: the record does not exist or the credential cannot see it.
  • 403 — the credential lacks read.<object slug>.
  • 404 — Relation 'deals-mpoc4k2z' not found on object 'contacts'.
  • 422 — a query parameter is invalid, for example limit is above 200.

Response 200:

{
  "status": 200,
  "message": "Relation page retrieved successfully",
  "data": [
    {
      "type": "relation",
      "name": "Office renewal",
      "label": "Office renewal",
      "slug": "c81f5a0d3e97",
      "random_id": "5b2e8d14",
      "object_slug": "deals",
      "object_name": "Deals",
      "object_icon": "briefcase"
    }
  ],
  "pagination": {
    "total": 26,
    "page": 2,
    "limit": 25,
    "totalPages": 2,
    "nextPage": null,
    "prevPage": 1
  },
  "relation_type": "hasMany"
}

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL
Bearer tokenbearerAuthoptional
Stored only in this browser for the bearerAuth security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

objectSlugpath · stringrequired
dataSlugpath · stringrequired
relationSlugpath · stringrequired
paginationQueryquery · stringoptional

Responses

200application/json

Successful response

{
  "type": "string",
  "name": "string",
  "label": "string",
  "slug": "string",
  "random_id": "",
  "object_slug": "string",
  "object_name": "string",
  "object_icon": "string",
  "columns": "string"
}
typeobjectoptional
namestringrequired
labelstringrequired

Display text for slug. Same value as name, under the key every other slug-bearing shape on the wire uses for its human text.

slugstringrequired
random_idstringrequired
object_slugstringrequired
object_namestringrequired
object_iconstringrequired

The partner OBJECT's icon — a record has none of its own. "" when the object never got one, so the client keeps its per-direction fallback.

columnsobjectoptional

The relation's configured display columns for THIS linked record, keyed by the target field's slug, in the admin's configured order (RelationOptions.display_columns).

Each value is already in the shape a normal record read emits for that field type — option-backed fields arrive as {id,value,label,color,icon}[], never a raw option id — so the client renders a mirrored cell with the same renderer it uses on the Data Table, keyed off the field's own type.

Absent, not empty, when the relation has no columns configured or the feature is off. Clients must treat a missing key as "no columns", which is also what every client written before this key did.

400application/json

Bad request

{
  "status": 1,
  "message": "string",
  "code": "string",
  "data": {}
}
statusintegerrequired

The HTTP status code of the response.

messagestringrequired

What went wrong. Several validation messages are joined with ", ".

codestringoptional

A stable, machine-readable reason. Only some errors set it.

dataobjectoptional

Extra detail about the error. Only some errors set it.

401application/json

Unauthorized

{
  "status": 1,
  "message": "string",
  "code": "string",
  "data": {}
}
statusintegerrequired

The HTTP status code of the response.

messagestringrequired

What went wrong. Several validation messages are joined with ", ".

codestringoptional

A stable, machine-readable reason. Only some errors set it.

dataobjectoptional

Extra detail about the error. Only some errors set it.

500application/json

Internal server error

{
  "status": 1,
  "message": "string",
  "code": "string",
  "data": {}
}
statusintegerrequired

The HTTP status code of the response.

messagestringrequired

What went wrong. Several validation messages are joined with ", ".

codestringoptional

A stable, machine-readable reason. Only some errors set it.

dataobjectoptional

Extra detail about the error. Only some errors set it.

List the values of dependent filter fields.< PreviousList the distinct values stored in one field, most common first.Next >

Powered by heyo-docs

curl --request GET \  'https://corteksa.info/api/v1/object/data/string/string/relations/string?paginationQuery=string'
{
  "type": "string",
  "name": "string",
  "label": "string",
  "slug": "string",
  "random_id": "",
  "object_slug": "string",
  "object_name": "string",
  "object_icon": "string",
  "columns": "string"
}