List

Description

Retrieve a list of fields of a case input.

Request

HTTP Method: GET

Query Parameter Description
case_input_id ID of the case input to which the fields belong to.
per_page Optional Set the number of results returned per page. Defaults to 20.
page Optional Specify the page of results to return if there are multiple pages. Defaults to page 1. 
curl -X GET \
  https://<<META.tenant.domain>>/api/v1/case_inputs/<<case_input_id>>/fields \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>'

Response

A successful request will return a JSON Array describing the fields for the case input.

Field description

Parameter Description
id The field ID.
value The stored value.

Sample response

{
  "fields": [
    {
      "id": 1,
      "value": "value 1"
    },
    {
      "id": 2,
      "value": "value 2"
    },
    {
      "id": 3,
      "value": "value 3"
    }
  ],
  "meta": {
    "current_page": "https://<<META.tenant.domain>>/api/v1/case_inputs/1/fields?per_page=20&page=1",
    "previous_page": null,
    "next_page": null,
    "next_page_number": null,
    "per_page": 20,
    "pages": 1,
    "count": 3
  }
}
Was this helpful?