Child record IDs

Description

List the IDs of the records whose parent is the given record, newest first. Results are keyset-paginated.

Unlike the Child records API, this exposes every direct child's ID — including children whose contents the caller cannot read — and never returns their fields or bodies.

This is the paged equivalent of the child_record_ids embed on the Get record API: the embed is capped at 20, whereas this endpoint pages through every direct child.

Request

HTTP Method: GET

Path parameter	Description
id	The ID of the parent record.

Query parameter	Description
limit	Optional Page size, between 1 and 500. Defaults to 20.
after	Optional Opaque forward pagination cursor from a previous response's page.next_page_token.

curl -X GET \
  https://<tenant-domain>/api/v2/records/<<record_id>>/child_record_ids \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>'

Pagination

When more results exist, the response's page object contains a next_page_token; pass it back as the after query parameter to fetch the next page. On the last page, page has no next_page_token.

Response

A successful request returns a JSON object with a data array of integer record IDs and a page pagination cursor.

Field description

Field	Description
data	An array of child record IDs (integers), newest first.
page	Pagination cursor. Contains a next_page_token when another page exists.

Sample response

{
  "data": [556, 557],
  "page": {}
}

Errors

Status	Meaning
400	Invalid request — unknown query parameter, invalid limit, or after cursor.
403	The tenant does not have access to records.
404	Record not found.

Errors are returned as { "error": { "type", "message", "field"?, "hint"? } }.