Interactive Playground credentials
Enter your Console OAuth credentials to test API requests in the playground below. Select OmaxTelecom Client Credentials as the auth identity before sending.
Tasks
Bulk task tracking — monitor asynchronous bulk operations initiated via POST /links/bulk-* or POST /sims/bulk-provision.
List bulk tasks
Paginated list of bulk tasks in your organisation.
Each row carries the task header (status + counters); the per-item
breakdown is reachable via GET /tasks/{id}/items.
query Parameters
pagePage number (1-based).
Page number (1-based).
page_sizeItems per page.
Items per page.
sort_byField to sort by. Omit for default ordering (most recently updated first).
Field to sort by. Omit for default ordering (most recently updated first).
sort_orderSort direction.
Sort direction.
typeFilter by task type.
Filter by task type.
statusFilter by task lifecycle status.
Filter by task lifecycle status.
List bulk tasks › Responses
Successful Response
Items on the current page.
totalTotal number of items across all pages.
pageCurrent page number (1-based).
page_sizeItems per page used to compute this response.
pagesTotal number of pages at the current page_size.
Get a bulk task
Fetch a single bulk task by id.
Returns the task header only — counters, status, and timestamps.
Per-item details are at GET /tasks/{id}/items.
path Parameters
task_idGet a bulk task › Responses
Successful Response
idInternal bulk-task identifier.
typeWhat bulk operation this task represents.
statusLifecycle status of the task itself: pending (queued), running (worker picked it up), completed (all items processed — some may still have failed; check counters), failed (worker job crashed).
total_itemsTotal number of items the task was created with.
completed_itemsItems processed successfully.
failed_itemsItems that the worker could not process.
pending_itemsItems still waiting to be processed (total - completed - failed).
created_atUTC timestamp when the task was created.
updated_atUTC timestamp of the last update.
List items within a bulk task
Paginated per-item results within a bulk task.
Useful for inspecting failures: filter by status=failed and the
error field on each item explains what went wrong for that
specific target.
path Parameters
task_idquery Parameters
pagePage number (1-based).
Page number (1-based).
page_sizeItems per page.
Items per page.
sort_byField to sort by. Omit for default ordering (most recently created first).
Field to sort by. Omit for default ordering (most recently created first).
sort_orderSort direction.
Sort direction.
statusFilter by item status.
Filter by item status.
List items within a bulk task › Responses
Successful Response
Items on the current page.
totalTotal number of items across all pages.
pageCurrent page number (1-based).
page_sizeItems per page used to compute this response.
pagesTotal number of pages at the current page_size.