Get Tasks Metadata

get

https://{host}/v1.1/task/metadata

Returns the list of tasks created which contains information such as the title of the task, notes, created date, expiry date, type (customer/associate).

You can also use filters to limit or customize the results. You can also use store/task to retrieve task details.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

format

string

enum

Allowed:

asoc

boolean

Returns tasks of all associates of the current store if assoc=true.

action_type

string

enum

Get tasks of a particular type. If action_type=none, then the tasks other than SMS, email, or call will be returned.

Allowed:

created_by

int64

Unique associate ID to get tasks of a specific associate.

created_by_type

string

enum

Get tasks created either by manager or cashier.

Allowed:

execute_by_all

boolean

Returns the list of generic tasks - not to a specific associate or created for all associates

customer_task

boolean

Pass true to return the list of all customer tasks assigned to associates.

start_id

int64

Returns the list of tasks having task ids greater than or equal to the value passed.

end_id

int64

Returns the list of tasks having task ids less than or equal to the value passed.

start_date

date

Returns the list of tasks created between the dates set on start_date and end_date. If only start_date is mentioned then the list of tasks created on or after that specified date is returned.

end_date

date

Returns the list of tasks created between the dates set on start_date and end_date. If only end_date is passed, the list of tasks created on or before the specified date is returned.

batch_size

string

Limits the number of tasks to be displayed. For example, if batch_size=10 then the details of only 10 tasks are returned

all

boolean

Returns all the tasks of the current organization if all=true. If all=false, only the current store tasks are returned. Default value: true

assoc_id

int64

Unique ID of the associate to get the tasks assigned to a specific associate.

customer_id

int64

Returns the tasks created for a specific customer

status

string

enum

Get tasks of a specific status.

Allowed:

Responses

200200

400400