Log in Get API key

View as Markdown

Retrieve a pipeline

GET/v1/crm/pipelines/{pipeline_id}

Scope: crm:read

A pipeline with its active stages, in display order.

Headers

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

Path parameters

pipeline_idstring · uuidRequired
ID of the pipeline.

Response

200

messagestringRequired
pipelineobjectRequired
Pipeline data
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"
stagesarray of objects
Stages in this pipeline
Show 7 child attributesHide child attributes
- pipeline_idstringRequired
  ID of the parent pipeline
  Example "c1d2e3f4-a5b6-7890-cdef-123456789012"
- namestringRequired
  Stage name
  Example "Qualified"
- display_orderintegerRequired
  Order in which the stage appears (lower = earlier)
  Example 2
- created_atstring · date-time or null
  When the stage was created
  Example "2024-01-15T10:30:00+00:00"
- idstring or null
  Stage ID
  Example "d2e3f4a5-b6c7-8901-def0-234567890123"
- is_activeboolean
  Whether this stage is active
  Default true
- updated_atstring · date-time or null
  When the stage was last updated
  Example "2024-01-20T14:45:00+00:00"
successboolean
Default true

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	PIPELINE_NOT_FOUND	No pipeline 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.

Request

curl "https://api.versionseven.ai/v1/crm/pipelines/a5ad8316-bbdf-4e40-9e27-da8c81593927" \
  -H "Authorization: Bearer $VICTORIA_API_KEY"

const response = await fetch("https://api.versionseven.ai/v1/crm/pipelines/a5ad8316-bbdf-4e40-9e27-da8c81593927", {
  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/a5ad8316-bbdf-4e40-9e27-da8c81593927",
    headers={
        "Authorization": f"Bearer {os.environ['VICTORIA_API_KEY']}",
    },
)
data = response.json()

Response

{
  "message": "string",
  "pipeline": {
    "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"
  },
  "stages": [
    {
      "pipeline_id": "c1d2e3f4-a5b6-7890-cdef-123456789012",
      "name": "Qualified",
      "display_order": 2,
      "created_at": "2024-01-15T10:30:00+00:00",
      "id": "d2e3f4a5-b6c7-8901-def0-234567890123",
      "is_active": true,
      "updated_at": "2024-01-20T14:45:00+00:00"
    }
  ],
  "success": true
}