Get a campaign's queue

GET/v1/campaigns/{campaign_id}/queue

Scope: campaigns:read

Queue depth and runway for a campaign: the not-started backlog, in-progress and completed leads, first-touch daily capacity, the number of active senders, the most recent lead refill, and days_of_runway, the backlog divided by daily capacity.

Headers

AuthorizationstringRequired
Bearer followed by a space and your API key, for example Bearer vk_….

Path parameters

campaign_idstring · uuidRequired
ID of the campaign.

Response

200

campaign_idstringRequired
queueobjectRequired
The queue report. Prefer this over the repeated top-level fields.
Show 16 child attributesHide child attributes
- active_sendersinteger
  Default 0
- backloginteger
  Sequence leads not yet started (is_active=false, completed=false)
  Default 0
- capacity_sourcestring
  Default "none"One of"campaign""org""none"
- completedinteger
  Default 0
- daily_capacityinteger
  Sum of first-touch daily limits (connection_request + email)
  Default 0
- days_of_runwaynumber or null
  backlog / daily_capacity; null when capacity or senders are zero
- enabled_accountsarray of strings
- has_filtersboolean
  Whether lead_database_filters is set (required for auto-refill)
  Default false
- in_progressinteger
  Sequence leads mid-sequence
  Default 0
- is_activeboolean
  Default false
- last_refillobject or null
  The most recent lead-refill job for the campaign (status, counts, timestamps), or null if none has run
- limitsobject
  Per-platform {daily_limit, current_usage, reset_date}
- namestring or null
- refill_policyobject or null
- totalinteger
  Default 0
- warningsarray of strings
active_sendersinteger
Default 0
backloginteger
Sequence leads not yet started (is_active=false, completed=false)
Default 0
capacity_sourcestring
Default "none"One of"campaign""org""none"
completedinteger
Default 0
daily_capacityinteger
Sum of first-touch daily limits (connection_request + email)
Default 0
days_of_runwaynumber or null
backlog / daily_capacity; null when capacity or senders are zero
enabled_accountsarray of strings
has_filtersboolean
Whether lead_database_filters is set (required for auto-refill)
Default false
in_progressinteger
Sequence leads mid-sequence
Default 0
is_activeboolean
Default false
last_refillobject or null
The most recent lead-refill job for the campaign (status, counts, timestamps), or null if none has run
limitsobject
Per-platform {daily_limit, current_usage, reset_date}
namestring or null
refill_policyobject or null
successboolean
Default true
totalinteger
Default 0
warningsarray of strings

Errors

Errors share one JSON body: success, error, message, optional details, and request_id.

Status	Code	Meaning
401	UNAUTHORIZED	The `Authorization` header is missing or malformed, or the API key is unknown or has been deactivated.
401	API_KEY_EXPIRED	The API key is past its expiry date. Create a new key in the Victoria AI app.
403	INSUFFICIENT_SCOPE	The API key doesn't have the scope this endpoint requires, such as `leads:write`.
403	ORGANIZATION_DEACTIVATED	The organization that owns this API key has been deactivated.
404	CAMPAIGN_NOT_FOUND	No campaign with this ID exists in your organization.
404	NOT_FOUND	No endpoint matches the path. A resource ID in the path that isn't a valid UUID also answers `NOT_FOUND`.
429	RATE_LIMITED	Too many requests for this API key: more than 100 a minute to one endpoint, or 600 a minute in total. Retry after the number of seconds in the `Retry-After` header. See Rate limits.
500	INTERNAL_ERROR	Something failed on our side. The response never includes internal details; quote its `request_id` when you contact support.
503	UPSTREAM_TIMEOUT	A service the API depends on timed out. The request is safe to retry.
503	AUTH_UNAVAILABLE	The API key couldn't be checked because the authentication service was unavailable. The request is safe to retry.

Response headers

Header	Description
`X-Request-ID`	Correlation ID for the request, also returned as `request_id` in error bodies. Send your own `X-Request-ID`, up to 128 letters, digits, `.`, `_`, `:` or `-`, and it's used instead.
`RateLimit-Limit`	Requests allowed to this endpoint per minute.
`RateLimit-Remaining`	Requests you can still send to this endpoint right now.
`RateLimit-Reset`	Seconds until the endpoint's full limit is available again.
`Retry-After`	On a `429`: seconds to wait before retrying.