Skip to main content
GET
aid_mgmnt_tasks_get

Authorizations

Authorization
string
header
required

Bearer authentication (token authentication) should be used for accessing the API.

Use Get Token to get an access token for client credentials. Pass the token in the request header:

where the access_token is JSON Web Tokens (JWT).

Path Parameters

oid
string<^[PT]{1}(?=(?:.{3}|.{8})$)[0-9]*$>
required

An id that uniquely identifies the account or owner (partner)

Query Parameters

task_id
string[]
Maximum array length: 100
Pattern: ^[PT]{1}\d{8}\.task\.[A-X1-9]{7,}$
type
string[]
Maximum array length: 10
account_id
string[]
Maximum array length: 100
Required string length: 9
Pattern: ^[PT]{1}\d{8}$
status
enum<string>[]
Maximum array length: 10
Available options:
pending,
processing,
completed,
failed
group_id
string
starting_after
string

cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, end the result contains paging_token=pt1, your subsequent call can include starting_after=pt1 in order to fetch the next page of the list.

limit
integer
default:10

A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.

Required range: 1 <= x <= 100

Response

Collection of administrative tasks

tasks
object[]
required
starting_after
string
Pattern: ^[PT]{1}\d{8}\.task\.[A-X1-9]{7,}$
Example:

"T55500000.task.JR97L9E"

Last modified on August 21, 2026