List CRM status groups

Request

Retrieve the list of CRM status groups defined for the account.

Security

PartnerApiKey and PartnerOAuth

Path

accountIdinteger, (int64)required

Account identifier

Query

activeboolean

Filter by active status (true/false)

sortBystring(?i)NAME|CREATED_DATE

Sort by field

Default:"NAME"

Enum:"NAME""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?active=true&sortBy=NAME&sortDir=ASC&cursor=string&limit=20' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

CRM status groups retrieved successfully

Bodyapplication/json

nextCursorstring

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

statusGroupsArray of objects(CrmStatusGroupDTO)

List of CRM status groups

Response

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