API reference
DocsAPI referenceLeads
All operations
LEADS

Retrieves a paginated list of leads associated with the specified record and record type.

Requires authentication. Returns HTTP 200 with the paginated list on success, 400 for invalid parameters, or 500 for server errors.

GET/api/v2/leads/by-record/list

Authentication

Choose one supported method for this request.

OAuth 2.0 client credentials

Parameters

recordIdqueryinteger · int32

The unique identifier of the record for which to retrieve associated leads.

recordTypequerystring

The type of the record to filter leads by. This value determines the entity type with which the leads are associated.

pageNumberqueryinteger · int32

The page number of results to retrieve. Must be greater than or equal to 1.

pageSizequeryinteger · int32

The number of leads to include in each page of results. Must be greater than 0.

Responses

OK

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