VictoriaAI
View as Markdown

List sender accounts

GET/v1/accounts
Scope: accounts:read

Every LinkedIn and email account connected to your organization for outreach, with its status. An account with is_active: false has been disconnected, usually by an authentication error, and needs to be reconnected: in the Victoria AI app, or with a reconnect link.

Headers

  • AuthorizationstringRequired

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

Query parameters

  • limitinteger

    Maximum rows to return

    ≥ 1≤ 500Default 500
  • offsetinteger

    Rows to skip before returning results

    ≥ 0Default 0

Response

200

  • totalintegerRequired

    Total rows matching the query, across all pages

  • limitintegerRequired

    Page size that was applied

  • offsetintegerRequired

    Rows skipped before this page

  • has_morebooleanRequired

    Whether a further page exists

  • accountsarray of objects
    Show 10 child attributes
    • account_idstring or null

      The account's ID at the messaging provider that sends on its behalf.

    • created_atstring · date-time or null
    • emailstring or null
    • idstring or null
    • is_activeboolean or null

      false = disconnected, needs reconnect

    • organization_idstring or null
    • platformstring or null

      linkedin | email

    • platform_usernamestring or null
    • system_idstring or null
    • user_idstring or null
  • countinteger

    Accounts in this page. Deprecated: use total

    Default 0
  • successboolean
    Default true

Errors

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

StatusCodeMeaning
400VALIDATION_ERROR

The request didn't match the endpoint's schema: a missing or malformed field, a bad query parameter, or a value out of range. details.errors lists each failing field with its field, message and type.

401UNAUTHORIZED

The Authorization header is missing or malformed, or the API key is unknown or has been deactivated.

401API_KEY_EXPIRED

The API key is past its expiry date. Create a new key in the Victoria AI app.

403INSUFFICIENT_SCOPE

The API key doesn't have the scope this endpoint requires, such as leads:write.

403ORGANIZATION_DEACTIVATED

The organization that owns this API key has been deactivated.

429RATE_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.

500INTERNAL_ERROR

Something failed on our side. The response never includes internal details; quote its request_id when you contact support.

503UPSTREAM_TIMEOUT

A service the API depends on timed out. The request is safe to retry.

503AUTH_UNAVAILABLE

The API key couldn't be checked because the authentication service was unavailable. The request is safe to retry.

Response headers

HeaderDescription
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.