v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get Tasks 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.

get/task/metadata

Query parameters

format'xml' | 'json'

asocboolean

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

action_type'sms' | 'email' | 'call' | 'none'

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

created_byinteger

Unique associate ID to get tasks of a specific associate.

created_by_type'manager' | 'cashier'

Get tasks created either by manager or cashier.

execute_by_allboolean

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

customer_taskboolean

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

start_idinteger

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

end_idinteger

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

start_datestring 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_datestring 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_sizestring

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

allboolean

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_idinteger

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

customer_idinteger

Returns the tasks created for a specific customer

status'OPEN' | 'IN_PROGRESS' | 'CLOSED'

Get tasks of a specific status.

Response

200

Example response

{
  "response": {
    "status": {
      "success": "true",
      "code": "200",
      "message": "SUCCESS"
    },
    "tasks": {
      "task": {
        "id": "15",
        "title": "Title",
        "body": "Body",
        "start_date": "2016-08-20",
        "end_date": "2016-08-21",
        "expiry_date": "2016-10-10 12:12:12",
        "action": {
          "type": "Call",
          "template": "Hi {name}, Your points = {points}"
        },
        "task_type": "MEMO/TASK",
        "cashier_task": "false",
        "customer_task": "false",
        "execute_by_all": "false",
        "possible_statuses": {
          "status": [
            {
              "label": "open",
              "value": "open"
            }
          ]
        },
        "tags": "[“label” : “birthday task”, “priority” : “1” ]"
      }
    }
  }
}