SLslant
Pipelines

Get a pipeline

Changed on

Retrieve a pipeline by ID. Pipeline stages are returned in order and include stage_order, visible, and default_probability.

get/v1/pipelines/{id}

Request

  • Base URL
    https://api.slant.app
  • URL
    https://api.slant.app/v1/pipelines/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

The pipeline ID

Response

successful

idstring required

The pipeline ID

namestring required

The name of the pipeline

pipeline_type'prospect' | 'client' nullable

Deprecated legacy pipeline type for client/prospect-only pipelines

audience_typesstring[] required

Record audiences supported by this pipeline

default_pipeline_typesstring[]

Legacy default client/prospect types served by this pipeline

book_idstring nullable

The sole shared book ID when accessible; null for pipelines shared with multiple books

book_idsstring[]

Shared book IDs accessible to the authenticated user

Example response

{
  "id": "pipeline123xyz",
  "name": "Sales Pipeline",
  "pipeline_type": "prospect",
  "book_id": "book123xyz",
  "pipeline_stages": [
    {
      "id": "stage123xyz",
      "name": "Qualified",
      "stage_order": 1,
      "visible": true,
      "default_probability": 50
    }
  ]
}

Changes

  • 173c41bf6be9Revision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      removed the invalid_json enum value from the response property for the response status

    • info

      response property detail list-of-types was narrowed by removing types array from media type application/json of response 400