Records

List records

Retrieve a list of records. For aggregates, use the Query records endpoint instead.

get/api/v1/records

Request

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

Query parameters

record_type_idinteger

The ID of the record type (optional if record_field_ids are present)

record_field_ids[]integer[]

Record field IDs determining which fields are returned (optional if record_type_id is present)

range_startstring

Start of the record time range (ISO 8601 timestamp)

range_endstring

End of the record time range (ISO 8601 timestamp)

story_container_ids[]integer[]

Story IDs to filter the results. Cannot be used with story_ids

order_direction'ASC' | 'DESC'

Direction to order records (defaults to DESC)

order_field_idinteger

ID of the field used to order records. Defaults to creation date

per_pageinteger

Number of records per page (defaults to 20, maximum 500)

pageinteger

Page number

filtersstring

A JSON-array string of filter objects, each with field_id, operator, and value

test_modestring

Set to "true" to filter by records created in test stories (defaults to false)

parent_ids[]integer[]

Parent record IDs (max 100). Returns only first-degree child records of those parents

story_ids[]integer[]

Deprecated. Internal story IDs to filter the results. Cannot be used with story_container_ids

Deprecated. Use story_container_ids instead.

Response

Successful response

record_typeobject

The record type, with its id and name

Changes

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