Records

Get a record

get/api/v1/records/{id}

Request

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

Path parameters

idinteger required

The ID of the record to retrieve

Query parameters

record_type_idinteger

Scope the lookup to this record type for a faster query

record_field_ids[]integer[]

Only include the specified fields. id, updated_at, and case_ids are always returned

resolve_artifactsstring

Set to "true" to return full Artifacts (large text) contents instead of the artifact ID (defaults to false)

include_childrenstring

Set to "true" for full child record data, "false" to omit children. Defaults to child record IDs only

Response

Successful response

idinteger

Record result set ID

record_typeobject

Record type with id and name

recordsobject[]

Record results with id, name, and value

created_atstring

When the record was created

Changes

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