API referencePipeline

List pipeline columns

Lists the organization's fixed pipeline columns with their ids, names, stage keys, positions, hidden flag and bound settings.

GET
/v1/brands/{brandId}/pipeline/columns
bearerAuth
headerAuthorizationBearer <token>

An organization API key (koast_sk_…) with the API surface enabled, or an OAuth access token issued by Koast (koast_at_…) whose audience covers this API. REST access requires an active Agency plan.

brandId*integer

The brand the request acts on. Every brand-scoped resource lives under its brand.

cursor?string

Opaque cursor from the previous page's nextCursor. Omit for the first page.

limit?integer

Page size.

Range1 <= value <= 100
Default50

Response Body

List pipeline columns

application/json
  1. response
columns*array<>
nextCursor*|

Pass as cursor to read the next page. Null when there is no next page.

[key: string]?unknown
curl -X GET "https://example.com/v1/brands/0/pipeline/columns" \  -H "Authorization: Bearer koast_sk_..."
{  "columns": [    {      "id": 0,      "organizationId": 0,      "name": "string",      "stageKey": "string",      "position": 0,      "isHidden": true,      "isSystemDefault": true,      "updatedAt": "string",      "settings": [        {          "id": 0,          "columnId": 0,          "kind": "string",          "enabled": true,          "config": {            "property1": null,            "property2": null          },          "updatedAt": "string",          "property1": null,          "property2": null        }      ],      "property1": null,      "property2": null    }  ],  "nextCursor": "string",  "property1": null,  "property2": null}

Required scope: read. CLI: koast list-pipeline-columns, see Pipeline commands. Authentication, headers, errors and pagination work the same on every operation. See Conventions.