Log in Get API key

View as Markdown

List pipelines

GET/v1/crm/pipelines

Scope: crm:read

Active pipelines in your organization, oldest first. Stages aren't included; retrieve a pipeline to get them.

Headers

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

Query parameters

limitinteger
Maximum rows to return
≥ 1≤ 500Default 100
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
messagestringRequired
pipelinesarray of objectsRequired
List of pipelines
Show 6 child attributesHide child attributes
- namestringRequired
  Pipeline name
  Example "Enterprise Sales"
- created_atstring · date-time or null
  When the pipeline was created
  Example "2024-01-15T10:30:00+00:00"
- idstring or null
  Pipeline ID
  Example "c1d2e3f4-a5b6-7890-cdef-123456789012"
- is_activeboolean
  Whether this pipeline is active
  Default true
- is_defaultboolean
  Whether this is the default pipeline
  Default false
- updated_atstring · date-time or null
  When the pipeline was last updated
  Example "2024-01-20T14:45:00+00:00"
countintegerRequired
Pipelines in this page
successboolean
Default true

Errors

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

Status	Code	Meaning
400	VALIDATION_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`.
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.
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.

Request

curl "https://api.versionseven.ai/v1/crm/pipelines" \
  -H "Authorization: Bearer $VICTORIA_API_KEY"

const response = await fetch("https://api.versionseven.ai/v1/crm/pipelines", {
  headers: {
    Authorization: `Bearer ${process.env.VICTORIA_API_KEY}`,
  },
});

const data = await response.json();

import os

import requests

response = requests.get(
    "https://api.versionseven.ai/v1/crm/pipelines",
    headers={
        "Authorization": f"Bearer {os.environ['VICTORIA_API_KEY']}",
    },
)
data = response.json()

Response

{
  "total": 1,
  "limit": 1,
  "offset": 1,
  "has_more": true,
  "message": "string",
  "pipelines": [
    {
      "name": "Enterprise Sales",
      "created_at": "2024-01-15T10:30:00+00:00",
      "id": "c1d2e3f4-a5b6-7890-cdef-123456789012",
      "is_active": true,
      "is_default": false,
      "updated_at": "2024-01-20T14:45:00+00:00"
    }
  ],
  "count": 1,
  "success": true
}