API reference
All operations
COMPANY

Fetches leads for a specific company with pagination.

GET/api/v2/companies/{companyId}/leads

Authentication

Choose one supported method for this request.

OAuth 2.0 client credentials

Parameters

companyIdpathinteger · int32required

The ID of the company to retrieve leads for.

pagequeryinteger · int32

Page number.

pageSizequeryinteger · int32

Number of items per page.

Responses

Company leads retrieved successfully.

Standard response envelopeisSuccessmessageerrorsdata

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

Paginated
dataPaginatedResponse<RecordAssignedLeads_Result[]>
  • totalCountinteger · int32
    • leadIDinteger · int32nullable
    • descriptionstring
    • sourcestring
    • statusNamestring
    • companyNamestring
    • contactNamestring
    • ownerNamestring
    • dateAssignedstring · date-timenullable
    • dateAcknowledgedstring · date-timenullable
    • dateConvertedstring · date-timenullable
    • ownerIDinteger · int32nullable
    • dateEnteredstring · date-timenullable
    • taskStatusstring
    • canAcknowledgebooleannullable
  • pageCountinteger · int32
  • currentPageCountinteger · int32
  • nextPageNumberinteger · int32nullable
  • hasNextPageboolean