List CRM statuses in group

Request

Retrieve all CRM statuses within the specified status group.

Security

PartnerApiKey and PartnerOAuth

Path

groupIdinteger, (int64)required

CRM status group ID

accountIdinteger, (int64)required

Account identifier

Query

activeboolean

Filter by active status (true/false)

sortBystring(?i)SORT_ORDER|CREATED_DATE

Sort by field

Default:"SORT_ORDER"

Enum:"SORT_ORDER""CREATED_DATE"

sortDirstring(?i)ASC|DESC

Sort direction

Default:"ASC"

Enum:"ASC""DESC"

cursorstring, [ 0 .. 2048 ] characters

Pagination cursor from previous response

limitinteger, (int32), [ 1 .. 1000 ]

Number of results per page (max 1000)

Default:20

Example:limit=20

curl -i -X GET \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/account/{accountId}/crm-status-group/{groupId}/status?active=true&sortBy=SORT_ORDER&sortDir=ASC&cursor=string&limit=20' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

CRM statuses retrieved successfully

Bodyapplication/json

nextCursorstring

Opaque cursor for fetching the next page. Null if no more results.

statusesArray of objects(CrmStatusDTO)

List of CRM statuses

Response

{
  "nextCursor": "string",
  "statuses": [
    { … }
  ]
}