Get

Description

Retrieve an individual record artifact (large text field).

Please note that the Artifacts (large text) field types return only the ID of the Artifacts, not the data itself when using the GET Records API or List Records API. To access the actual contents, you need to make a separate request to this endpoint using that ID as the artifact_id parameter.

Request

HTTP Method: GET

Path Parameter Description
record_id ID of the record.
artifact_id ID of the record artifact.
curl -X GET \
  https://<<META.tenant.domain>>/api/v1/records/<<record_id>>/artifacts/<<artifact_id>> \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>'

Response

A successful request will return a record artifact.

Field description

Parameter Description
id The record artifact ID.
value The record artifact's value.
record_field JSON containing the id and name of the record field.
created_at ISO 8601 Timestamp representing the creation date and time of the record artifact.
updated_at ISO 8601 Timestamp representing the last updated date and time of record artifact.

Sample response

{
  "id": 1,
  "value": "artifact value",
  "record_field": {
    "id": 1,
    "name": "record field name"
  },
  "created_at": "2024-02-16T15:37:39Z",
  "updated_at": "2024-02-16T15:37:39Z"
}
Was this helpful?