Get conversation forms

Use this method to get a list of forms with pagination and filtering options. Using a filter is optional. The result can be filtered by one or many optional filters described in the parameters.

get/ccaas/2/conversation-forms/forms

Request

Base URL
https://api.infobip.com (the document declares no server; this is the origin it was published from)
Auth
- OAuth 2
  Client credentials
  Token URL: https://api.infobip.com/auth/1/oauth2/token
- or API key in header Authorization
- or API key in header Authorization
- or HTTP basic

Query parameters

titlestring

Optional filter. Form title.

isEnabledstring

Optional filter. Enabled status.

isDefaultstring

Optional filter. Default status.

limitinteger

Size of the result page.

pageinteger

Number of the current page.

orderBystring

This parameter is used to order your results. If an order is not given, the default order id:asc will be applied. Possible ordering fields are properties. Ordering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one.

Response

Example response

{
  "items": [
    {
      "id": "75f57446-1d65-478a-87ed-22d17dc3d077",
      "title": "Granulation",
      "isEnabled": true,
      "isDefault": false,
      "fields": null,
      "createdAt": "2021-03-29T14:04:48.468346Z",
      "updatedAt": "2021-03-29T14:04:48.468349Z"
    },
    {
      "id": "269757a0-38a6-4226-a8db-cc27930f6a2f",
      "title": "Demo form",
      "isEnabled": false,
      "isDefault": false,
      "fields": null,
      "createdAt": "2021-04-17T07:54:44.401772Z",
      "updatedAt": "2021-04-17T07:54:44.401773Z"
    }
  ],
  "pagination": {
    "totalItems": 2,
    "page": 0,
    "limit": 10,
    "orderBy": {
      "property": "id",
      "direction": "ASC"
    }
  }
}

Changes

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