Records

Get a record

Fetch a single record by numeric id. Supports sparse fieldsets, inline expansion of artifact fields, and embedding related resources (record_type, child_records, cases).

get/api/v2/records/{id}

Request

  • Base URL: https://your-tenant.tines.com
  • URL: https://your-tenant.tines.com/api/v2/records/{id}
  • Auth: one of:
    • API key in header X-User-Token
    • HTTP bearer

Path parameters

idinteger required

The record ID.

Query parameters

record_type_idinteger

Optional scope; a record whose type does not match returns 404.

include[]string[]

Relationships to embed. record_type embeds a body under included; parent_record always rides in relationships as a bare ref. The to-many embeds child_records and cases return bare arrays under included, each capped at 20; when more exist, relationships.<name>.truncated is true - page the rest via the nested child_records/cases routes. child_record_ids adds relationships.child_record_ids (an IDs-only list, same cap and truncated flag, paged via the nested child_record_ids route): it exposes every direct child's ID - including children whose contents the caller cannot read - without returning their fields or bodies.

expand[]string[]

Artifact fields to hydrate inline, e.g. fields.payload or fields.*.

fieldsobject

Sparse fieldset, e.g. { "record": "status,severity" }. Matching is insensitive to case and separators.

timezonestring

IANA timezone for timestamp output. Defaults to UTC.

Response

Successful response

field_idsobject

Map of each returned field's slug key to its immutable field id.

Changes

No recorded changes to this operation across all 1 revision of this API.