API reference
All operations
LEADS

Retrieves a list of available lead statuses, optionally filtered by a search parameter.

GET/api/v2/leads/statuses

Authentication

Choose one supported method for this request.

OAuth 2.0 client credentials

Parameters

searchParamquerystring

An optional search term used to filter the lead statuses by name or description. If null or empty, all lead statuses are returned.

Responses

OK

Standard response envelopeisSuccessmessageerrorsdata

Read the result from data. When isSuccess is false, errors lists what went wrong. Handling errors

dataLeadStatusLookupDto[]

An array. Each item is a LeadStatusLookupDto:

  • statusIdinteger · int32
  • statusstring
  • internalStatusstring