Skip to main content
GET
List the approval queue

Authorizations

X-API-Key
string
header
required

Query Parameters

channel
enum<string>[] | null

Only these channels; omit for every channel.

Which channel performs the task once it is allowed to run.

Available options:
linkedin,
email,
phone
sender_profile_id
string<uuid>[] | null

Only these senders; omit for everyone.

sequence_id
string<uuid>[] | null

Only these sequences; omit for all of them.

status
enum<string>[]

Only these statuses; repeat the parameter for several. Defaults to pending.

Where one task stands.

PENDING is waiting on a person. SCHEDULED is approved, or never needed approval, and is waiting on the channel to execute it: the browser to claim the LinkedIn action, the engine to send the email. A LinkedIn task on an AUTO account is BORN scheduled, because the browser will run it regardless of what this row says, and a queue showing it as awaiting approval would be lying. A phone task never has approved_at at all: nobody approves a call, somebody makes it, and it goes PENDING to DONE with the outcome recorded. That is why approval is a stamp on the row and not a status of its own.

DONE, REJECTED and CANCELLED are terminal. DONE is the channel executed it, or the call was worked; REJECTED is a person refused it; CANCELLED is the channel gave up on it — failed, skipped, expired, or the contact was stopped underneath it.

Available options:
pending,
scheduled,
done,
rejected,
cancelled
limit
integer
default:10

The number of items to return.

Required range: 1 <= x <= 100
order_by
enum<string>
default:created_at
Available options:
created_at
order_direction
enum<string>
default:desc
Available options:
asc,
desc
cursor
string | null

Set the cursor to the next or previous page. You can get the cursor from the previous page's response.

Response

Successful Response

data
OutreachTaskReadSchema · object[]

The list of ResponseItems.

next_page_cursor
string | null

The cursor to the next page. If there are no more pages, this is None.

previous_page_cursor
string | null

The cursor to the previous page. If there are no previous pages, this is None.