v1

latestSwagger 2.02026-08-043765135.6 KB
answers

Get answers

Get all existing answers

get/appointments/{appointmentId}/answers

Path parameters

appointmentIdstring uuid required

Parent Appointment UUID for the resource in the path

Query parameters

mockboolean

Return mock data

idstring[]
questionIdstring uuid

Query by question uuid

customerIdstring uuid

Query by customer uuid

questionKeystring

Query by question key

questionTypestring

Query by question type

perPageinteger

Query parameter to set the number of results per page

pageAfterstring

Query parameter to set the token for the next page of results

orderBystring

Field by which to order results

order'asc' | 'desc'

Specify the order of the returned data based on the field specified in "orderBy".

Response

Return an array of data responses

Example response

{
  "data": [
    {
      "attributes": {
        "createdAt": "2018-02-03T10:30:00Z",
        "updatedAt": "2018-02-03T10:30:00Z"
      },
      "relationships": {
        "question": {
          "data": {
            "type": "questions",
            "id": "bdb88373-bf66-4bfc-a4f8-3a35be5c2f9c"
          }
        },
        "appointment": {
          "data": {
            "type": "appointments",
            "id": "00000000-0000-0000-0000-000000000069"
          }
        },
        "customer": {
          "data": {
            "type": "customers",
            "id": "00000000-0000-0000-0000-000000000069"
          }
        }
      }
    }
  ]
}