Pipeline States

List your CRM pipeline states and retrieve a state by ID.

GET /api/pipeline_states

Retrieves the collection of PipelineState resources.

Example request

curl -X GET "https://www.letsligo.com/api/pipeline_states" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"

Request parameters

Name	Type	Description	Required
page	integer	The collection page number	No

Response example

{
    "@context": "/api/contexts/PipelineState",
    "@id": "/api/pipeline_states",
    "@type": "hydra:Collection",
    "hydra:member": [
        {
            "@id": "/api/pipeline_states/223e4567-e89b-12d3-a456-426614174000",
            "@type": "PipelineState",
            "name": "Nouveau contact",
            "color": "#3B82F6",
            "position": 0
        }
    ],
    "hydra:totalItems": 1
}

Response attributes

Name	Type	Description
member[].name	string	Display name of the pipeline stage (e.g. New contact, Qualified, Client).
member[].color	string	Hex color code for display (e.g. #3B82F6).
member[].position	integer	Order/position of the stage in the pipeline (0-based).

GET /api/pipeline_states/{id}

Retrieves a PipelineState resource.

Example request

curl -X GET "https://www.letsligo.com/api/pipeline_states/223e4567-e89b-12d3-a456-426614174000" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"

Request parameters

Name	Type	Description	Required
id	string	PipelineState identifier	Yes

Response example

{
    "@context": "/api/contexts/PipelineState",
    "@id": "/api/pipeline_states/223e4567-e89b-12d3-a456-426614174000",
    "@type": "PipelineState",
    "name": "Nouveau contact",
    "color": "#3B82F6",
    "position": 0
}

Response attributes

Name	Type	Description
name	string	Display name of the pipeline stage (e.g. New contact, Qualified, Client).
color	string	Hex color code for display (e.g. #3B82F6).
position	integer	Order/position of the stage in the pipeline (0-based).