Get forms

GET /forms

OAuth2

Get forms with filtering

Headers

Authorization string

Bearer token used for authorization

Minimum length is 1.
X-Correlation-Id string

Unique identifier to allow referencing a particular transaction or event chain

Minimum length is 1.
Accept-Language string

Returns the requested resources translated according to the passed languages (see translatable resources)

Minimum length is 1.

Query parameters

id array[string]

ID(s) to be considered for filtering

At least 1 element. Minimum length of each is 1.
type array[string]

Type(s) to be considered for filtering

At least 1 element. Values are APPOINTMENT_CANCELLATION, APPOINTMENT_COMPLETION, CALLBACK_REQUEST, QUALIFICATION, or SUBJECT_QUESTIONNAIRE.
offset string(positive-integer)

Offset for the results to be returned

Default value is 0.
limit string(positive-integer)

Limitation for the number of results to be returned

Default value is 25.
with-deleted boolean

Includes deleted resources in the results

Responses

200 application/json

Successful operation
Hide response attributes Show response attributes object
- data array[object] Required
  
  Hide data attributes Show data attributes object
  
  id string Required
  
  Minimum length is 1.
  
  name string Required
  
  Minimum length is 1.
  
  type string Required
  
  Values are APPOINTMENT_CANCELLATION, APPOINTMENT_COMPLETION, CALLBACK_REQUEST, QUALIFICATION, or SUBJECT_QUESTIONNAIRE.
  
  createdAt string(date-time) Required
  
  Minimum length is 1.
  
  updatedAt string(date-time) Required
  
  Minimum length is 1.
  
  deletedAt string(date-time) | null Required
  
  Minimum length is 1.
- meta object Required
  
  Additional properties are NOT allowed.
  
  Hide meta attributes Show meta attributes object
  
  offset integer Required
  
  Minimum value is 0. Default value is 0.
  
  limit integer Required
  
  Minimum value is 0. Default value is 25.
  
  totalCount integer Required
  
  Minimum value is 0.

GET /forms

curl \
 -X GET https://api.development.pexipengage.com/enterprises/acme/forms \
 -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
 -H "X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002" \
 -H "Accept-Language: en *"

Response examples (200)

{
  "data": [
    {
      "id": "123",
      "name": "string",
      "type": "SUBJECT_QUESTIONNAIRE",
      "createdAt": "2022-08-17T19:05:21.362Z",
      "updatedAt": "2022-08-17T19:05:21.362Z",
      "deletedAt": "2022-08-17T19:05:21.362Z"
    }
  ],
  "meta": {
    "offset": 0,
    "limit": 25,
    "totalCount": 42
  }
}