Actions

Overview

TBD

Get All Actions

Get information about all of you team's actions.

GET /tasks

Pagination

The maximum number of actions that will be returned in a single request is 100. If there are more than 100 actions you can specify a page parameter great than 1 to get more data. The response will contain information about how many pages of data are available.

Query Parameters

Parameter	Default	Description
page	1	Specifies which page of results to return
per_page	100	Specifies maximum number of actions to return in a given request. The maximum you can specify is 100.

Success Response

A successful response will have an HTTP status of 200

Response Properties

Property	Description
page	Current page number of data returned
per_page	Maximum number of actions returned per page
total_pages	Number of pages of data available
response_count	The number of actions that were returned from the given request
total_count	Total number of actions that are available
tasks	Collection of actions

Example response

The sample response below indicates that you have received the second page of results. There are 2 pages available. The current page contains 21 of the total 121 actions.

{
    "page": 2,
    "per_page": 100,
    "total_pages": 2,
    "response_count": 21,
    "total_count": 121,
    "actions": [
      {...},
      {...}
    ]
}

Get Specified Action

Get information about a specific action

GET /tasks/{task_id}

Path Parameters

Parameter	Description
task_id	Id of the action you are requesting information about

Success Response

A successful get response will have an HTTP status of 200

Example Response Body

{
    "task": {
        "id": 1391,
        "message_id": "22c34e6d-38b9-4502-addf-28e83825c073",
        "message_type": null,
        "owner_id": "1b46ac8b-7fb3-4edf-911b-e310a62205a2",
        "team_id": "08697d4a-dd01-457f-a4f7-823f0ab35814",
        "created_at": "2023-04-19T19:13:02.148Z",
        "updated_at": 1705684642,
        "sequential_id": 1049,
        "message_html": "Body Camera Video",
        "root_message_id": "22c34e6d-38b9-4502-addf-28e83825c073",
        "channel_id": "989a2aa1-8900-4fec-917b-ba3c06c7201f",
        "customer_id": null,
        "customer_phone_number": null,
        "channel_phone_number": null,
        "hashtags": [],
        "original_message_type": "TEAM_CHAT",
        "rank": "9980.0",
        "message_report": null,
        "message_response_count": 0,
        "manually_routed_actions": null,
        "message_ir_form_statuses": [],
        "message_channel_ids": [
            "989a2aa1-8900-4fec-917b-ba3c06c7201f"
        ],
        "unread": true,
        "task_links": [],
        "mobility_form_id": null,
        "root_message_is_mobility_message": null,
        "current_assigned_status": "todo",
        "current_assigned_user": null,
        "current_assigned_type": "Video",
        "message_latest_channel_id": null,
        "client_sync_reason": null,
        "owner_handles_user": null,
        "hidden_from_period_report": false,
        "highlighted_in_period_report": false,
        "backdate_at": null,
        "task_assigned_statuses": [
            {
                "id": 2313,
                "task_id": 1391,
                "status": "todo",
                "assigned_by_id": "1b46ac8b-7fb3-4edf-911b-e310a62205a2",
                "created_at": "2023-04-19T19:13:03.489Z",
                "assigned_by_handles_user": null,
                "backdate_at": null
            }
        ],
        "task_assigned_types": [
            {
                "id": 858,
                "task_id": 1391,
                "task_type_id": 1001834014,
                "assigned_by_id": "1b46ac8b-7fb3-4edf-911b-e310a62205a2",
                "created_at": "2023-04-19T19:13:02.751Z",
                "assigned_by_handles_user": null,
                "backdate_at": null
            }
        ],
        "task_assigned_users": []
    }

Get Specified Action By App Visible Id

Get information about a specific action using the id that appears in the app.

GET /tasks/{sequential_id}?use_sequential_id=true

Path Parameters

Parameter	Description
sequential_id	Sequential id of the action you are requesting information about. This is the id that is visible on actions in the application

Success Response

A successful get response will have an HTTP status of 200