STstreakyc
Pipelines

Get pipeline

Changed on

Returns a pipeline by key.

get/v2/pipelines/{pipelineKey}

Request

  • Base URL
    https://api.streak.com/api
  • URL
    https://api.streak.com/api/v2/pipelines/{pipelineKey}
  • Auth
    HTTP bearer

Path parameters

pipelineKeystring required

Response

OK

keystring required

Key for this pipeline.

teamKeystring nullable

Key for the team that owns this pipeline.

creatorKeystring required

Key for the user who created this pipeline.

namestring required

Pipeline name.

iconstring required

Pipeline icon name.

descriptionstring nullable

Pipeline description.

sharingRestrictedToTeamboolean nullable

Whether sharing is restricted to the team.

stagesobject required

Stages in this pipeline, keyed by stage key.

stageOrderstring[] required

The display order of the stages

stageColorTheme'DEFAULT' | 'STREAK' | 'RAINBOW_SATURATED' | 'RAINBOW_FADED' | 'TRAFFIC_LIGHT_SATURATED' | 'TRAFFIC_LIGHT_FADED' | 'LAKESIDE_SATURATED' | 'LAKESIDE_FADED' | 'SUNSET_SATURATED' | 'SUNSET_FADED' | 'SUMMER_SATURATED' | 'SUMMER_FADED' | 'HALLOWEEN_SATURATED' | 'HALLOWEEN_FADED' | 'GREYSCALE' | 'BLUEGREY' | 'RED' | 'YELLOWORANGE' | 'GREEN' | 'TEAL' | 'CYAN' | 'BLUE' | 'INDIGO' | 'DEEPPURPLE' | 'VIOLET' | 'PINK' required
creationTimestampinteger required

Timestamp when the pipeline was created, in epoch milliseconds.

lastUpdatedTimestampinteger required

Timestamp when the pipeline was last updated, in epoch milliseconds.

formulasLastUpdatedTimestampinteger nullable

Latest formula-definition update timestamp, in epoch milliseconds.

customPermissionSetsobject required

Custom permission sets configured for this pipeline.

defaultPermissionSetNamestring required

Default permission set assigned to users without an explicit assignment.

creationSourceType'HUMAN' | 'SYSTEM_ONBOARDING' | 'AI_PIPELINE_CREATOR' required
boxCountinteger

Current number of boxes in the pipeline.

lastSavedTimestampinteger required

Timestamp when the pipeline was last persisted, in epoch milliseconds.

Example response

{
  "fields": [
    {
      "lastDefaultValueUpdatedTimestamp": 1646870400000,
      "lastUpdatedTimestamp": 1646870400000
    }
  ],
  "creationTimestamp": 1646870400000,
  "lastUpdatedTimestamp": 1646870400000,
  "formulasLastUpdatedTimestamp": 1646870400000,
  "lastSavedTimestamp": 1646870400000
}

Changes