Skip to main content
POST

Authorizations

Authorization
string
header
required

Authenticate with a Bearer token: API key, OAuth token, or session token.

Body

application/json
offset
integer | null
default:0

Records to skip for pagination, up to 1,000,000. Defaults to 0.

Required range: 0 <= x <= 1000000
limit
integer
default:100

Max records per page (1–100). Defaults to 100.

Required range: 1 <= x <= 100
view
enum<string>
default:upcoming

upcoming lists each running person's next step across your campaigns, soonest first. sent lists steps that went out, newest first. Defaults to upcoming.

Available options:
upcoming,
sent
campaign_ids
string<uuid>[]

Only steps of these campaigns, up to 100.

Required array length: 1 - 100 elements
campaign_owner_ids
string<uuid>[]

Only steps of campaigns owned by these team members, up to 100.

Required array length: 1 - 100 elements
sender_team_member_ids
string<uuid>[]

Only steps sent (or to be sent) by these team members, up to 100.

Required array length: 1 - 100 elements
step_types
enum<string>[]

Only steps of these types. meta.step_type_counts still counts every type, so you can show how many of each there are.

Minimum array length: 1
Available options:
email,
manual,
text,
linkedin_message,
linkedin_connection,
call
next_send_before
string<date-time>

upcoming only: steps due to go out before this time, for example the end of today.

sent_after
string<date-time>

sent only: steps sent at or after this time. Defaults to 30 days before sent_before (or now). The period can be at most 90 days.

sent_before
string<date-time>

sent only: steps sent before this time. Defaults to now.

Response

Queue steps found

success
enum<boolean>
required
Available options:
true
data
object[]
required
meta
object
required