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.

Please log in to see full path URL. Learn why.

get

/ccaas/2/conversation-forms/forms

Authorizations:

Scopes:

conversations:manage

query Parameters

title	string Optional filter. Form title.
isEnabled	string Optional filter. Enabled status.
isDefault	string Optional filter. Default status.
limit	integer <int64> <= 999 Default: 10 Size of the result page.
page	integer <int64> Default: 0 Number of the current page.
orderBy	string 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.

Responses

200

400

Bad request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Request samples

Example

cURL

Copy

curl -L -g 'https://{baseUrl}/ccaas/2/conversation-forms/forms' \
-H 'Authorization: {authorization}' \
-H 'Accept: application/json'

Response samples

Content type

application/json

Copy

Collapse all


{"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"
}
}
}

Need assistance

Explore Infobip Tutorials

Encountering issues

Contact our support

What's new? Check out

Release Notes

Unsure about a term? See

Glossary

Research panel

Help shape the future of our products

Learn more

Service status

Privacy documents Terms of use