Pipeline

Pipelines.get

Returns the Pipeline record with the given id.

get/entities/Pipelines/{id}

Request

Path parameters

idstring uuid required

Id of the Pipeline record to retrieve.

Query parameters

expandstring

Related records to return inline instead of their URIs, comma-separated; dots reach nested relations. The only parameter this call accepts.

Response

The Pipeline record.

successboolean

True when the request succeeded; false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "color": 1,
    "name": "string",
    "revision": 1,
    "steps": [
      {
        "description": "string",
        "lead_process_id": "01234567-abcd-dcba-ffff-000000000000",
        "name": "string",
        "percent": 1,
        "quote_process_id": "01234567-abcd-dcba-ffff-000000000000",
        "sort_order": 1,
        "timeframe": 1,
        "revision": 1
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.