v1

latestOpenAPI 3.0.12026-07-2474233379.5 KB
Query

Retrieve profiles from your workspace v1

Retrieve workflows user submissions. This is different from events because it contains the whole data submitted by a user.The parameters before and after can be passed to define a time range for your search

get/v1/query/clients

Query parameters

beforestring

Filters for results based on their creation date. Returns clients created before the specified UNIX timestamp.

Filters for results based on their creation date. Returns clients created before the specified UNIX timestamp.

afterstring

Filters for results based on their creation date. Returns clients created after the specified UNIX timestamp.

Filters for results based on their creation date. Returns clients created after the specified UNIX timestamp.

last-modified-beforestring

Filters for results based on their last-modified date. Returns clients last modified before the specified UNIX timestamp.

Filters for results based on their last-modified date. Returns clients last modified before the specified UNIX timestamp.

last-modified-afterstring

Filters for results based on their last-modified date. Returns clients last modified after the specified UNIX timestamp.

Filters for results based on their last-modified date. Returns clients last modified after the specified UNIX timestamp.

limitstring

Maximum number of items to be returned. Must be between 1 - 50 both inclusive. Omitting the limit parameter or using an invalid value will default to 20.

Maximum number of items to be returned. Must be between 1 - 50 both inclusive. Omitting the limit parameter or using an invalid value will default to 20.

pagestring

You can specify further pages with this parameter. Page numbering is 0-based and omitting the page parameter or using an invalid value will return the first page.

You can specify further pages with this parameter. Page numbering is 0-based and omitting the page parameter or using an invalid value will return the first page.

statusesstring

You can specify the desired end client statuses to filter the results with. Omitting the statuses parameter will return end clients for all available statuses

You can specify the desired end client statuses to filter the results with. Omitting the statuses parameter will return end clients for all available statuses

flowIdstring

You can specify the desired flow id to filter the results with. Only end clients that have interacted with that flow will be returned.

You can specify the desired flow id to filter the results with. Only end clients that have interacted with that flow will be returned.

Response

OK

totalElementsinteger
totalPagesinteger
numberinteger
numberOfElementsinteger
lastboolean
firstboolean