Menu

Pipelines

2 endpoints in the Mattering Sales API.

GETPOST sales-pipes/ User APIService tier

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

NameDefault
fieldsnone
space_idnone
viewnone

Body keys (JSON)

KeyRequiredDefault
descriptionoptional or conditionalnone
nameoptional or conditionalnone
space_idoptional or conditionalnone
stagesoptional or conditionalnone

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

200 data and meta envelope, legacy keys repeated beside data

{
  "data": "..."
}

200 data and meta envelope, legacy keys repeated beside data

{
  "data": {
    "sales_pipes": "..."
  }
}

201 data 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).

Errors

StatusCode
400name_required
401unauthorized
404space_not_found_or_forbidden

Example

curl -X POST "https://sales.mattering.io/api/user/v1/sales-pipes/" \
  -H "Authorization: Bearer $MATTERING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "...",
  "name": "...",
  "space_id": "...",
  "stages": "..."
}'

Source: CRMCore/internal_api.py (internal_api.list_sales_pipes)

GETPATCHDELETE sales-pipes/{pipe_id}/ User APIService tier

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

NameType
pipe_idstr

Body keys (JSON)

KeyRequiredDefault
descriptionoptional or conditionalnone
is_activeoptional or conditionalnone
nameoptional or conditionalnone

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

200 data and meta envelope, legacy keys repeated beside data

{
  "data": "..."
}

200 data and meta envelope, legacy keys repeated beside data

{
  "data": {
    "pipe": {
      "name": "...",
      "key": "...",
      "description": "...",
      "created_at": "2026-01-01T00:00:00Z",
      "updated_at": "2026-01-01T00:00:00Z",
      "id": "...",
      "stages": [
        {
          "id": "...",
          "name": "...",
          "key": "...",
          "order": 0,
          "is_won": true,
          "is_lost": true,
          "is_closed": true
        }
      ],
      "statuses": [
        {
          "id": "...",
          "name": "...",
          "key": "...",
          "order": 0
        }
      ]
    },
    "deleted": true
  }
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Errors

StatusCode
400name_required
400no_writable_fields
401unauthorized
404not_found

Example

curl -X PATCH "https://sales.mattering.io/api/user/v1/sales-pipes/PIPE_ID/" \
  -H "Authorization: Bearer $MATTERING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "...",
  "is_active": "...",
  "name": "..."
}'

Source: CRMCore/internal_api.py (internal_api.sales_pipe_detail)

All Sales resources
Start Free Explore our Products