List pipelines, or create one with POST. derived from route
URL
User APIhttps://sales.mattering.io/api/user/v1/sales-pipes/
Service tierhttps://sales.mattering.io/api/internal/sales-pipes/
Query parameters
Name
Default
fields
none
space_id
none
view
none
Body keys (JSON)
Key
Required
Default
description
optional or conditional
none
name
optional or conditional
none
space_id
optional or conditional
none
stages
optional or conditional
none
Keys the view reads. A key not in this list is ignored by the view, silently. Where a key is required only for some actions (for example the action dispatch), the description above says which.
Responses
200data and meta envelope, legacy keys repeated beside data
{
"data": "..."
}
200data and meta envelope, legacy keys repeated beside data
{
"data": {
"sales_pipes": "..."
}
}
201data and meta envelope, legacy keys repeated beside data
{
"data": "..."
}
Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).
Read, update or delete one of the pipelines by id. derived from route
URL
User APIhttps://sales.mattering.io/api/user/v1/sales-pipes/{pipe_id}/
Service tierhttps://sales.mattering.io/api/internal/sales-pipes/{pipe_id}/
Path parameters
Name
Type
pipe_id
str
Body keys (JSON)
Key
Required
Default
description
optional or conditional
none
is_active
optional or conditional
none
name
optional or conditional
none
Keys the view reads. A key not in this list is ignored by the view, silently. Where a key is required only for some actions (for example the action dispatch), the description above says which.
Responses
200data and meta envelope, legacy keys repeated beside data
{
"data": "..."
}
200data and meta envelope, legacy keys repeated beside data
We use strictly necessary cookies to run this site. With your permission we also use analytics cookies
(Google Analytics and our own visit tracking) to see which pages work. Read the
Cookie notice.