Skip to content

Latest commit

 

History

History
68 lines (58 loc) · 1.81 KB

get-task-list.md

File metadata and controls

68 lines (58 loc) · 1.81 KB

Get Task List

{% swagger baseUrl="[PlatformAddress]/api/1.0/" path="crm?action=getTaskList" method="post" summary="Get Task List" %} {% swagger-description %} Get a list of tasks. {% endswagger-description %}

{% swagger-parameter name="venueId" type="integer" in="path" %} The unique id of the venue to which the task belongs {% endswagger-parameter %}

{% swagger-response status="200" description="" %}

{
    "meta": {
        "totalResults": 1,
        "start": 0,
        "perPage": 100,
        "count": 1
    },
    "results": [
        {
            "id": 1,
            "venueId": 76,
            "bookingId": null,
            "leadId": null,
            "name": "test name",
            "description": "<p>this is description</p> ",
            "status": 4,
            "contactId": null,
            "companyId": null,
            "companyContactId": null,
            "assignedUserId": 1,
            "assignedUserFullName": "Test  First",
            "assignedUserEmail": "[email protected]",
            "priority": "low",
            "endDatetime": "2018-03-27 09:00:00 UTC",
            "progress": 0,
            "createdDate": "2018-03-01 10:13:17 UTC",
            "modifiedDate": "2018-03-26 11:17:05 UTC"
        }
    ]
}

{% endswagger-response %} {% endswagger %}

The result from this call will be a collection of all the tasks the user has access to. This call also accepts the pagination and filter properties.

Example Request

Get a specific venue’s task List

{
  "venueId": "1",
}

status:

One of the following values:

  • 0 = Not Started
  • 1 = In Progress
  • 2 = On Hold
  • 3 = Cancelled
  • 4 = Completed