Skip to main content

Get Tasks

This request returns a list of batch tasks.

get /batch/tasks

Sample

A sample GET request to get a list of batch tasks:

curl -X GET \
'https://api.carrierx.com/core/v2/batch/tasks' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'

Response

200 status code with a list of Task objects associated with the credentials:

{
"count": 1,
"has_more": false,
"items": [
{
"data": {
"trunk_group_sid": "b30a3dbb-3708-41f0-a9ca-5cf365dcc4d4"
},
"date_created": "2024-10-30T20:47:32.000Z",
"date_modified": "2024-10-30T20:47:38.000Z",
"entries": [
"18053355112",
"18053355280"
],
"error_details": [],
"failure": 0,
"field": "phonenumber",
"method": "PATCH",
"partner_sid": "923840ce-0b63-44a9-b4ce-09dc4181fb9d",
"processed": 0,
"review": true,
"status": "pending_review",
"success": 0,
"task_sid": "2d9e546e-634b-4f6b-97ca-c2158163540c",
"total": 1,
"type": "phonenumber"
}
],
"limit": 10,
"offset": 0,
"pagination": {},
"total": 1
}

This request is enabled for Pagination, Result Filtering, and Field Filtering.

Required Scopes

To get information about a Task object, the partner must have one of the following scopes enabled:

  • batch.manage
  • batch.read