API reference
All operations
COMPANY

Fetches contacts for a specific company with pagination and optional search.

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

Authentication

Choose one supported method for this request.

OAuth 2.0 client credentials

Parameters

companyIdpathinteger · int32required

The ID of the company to retrieve contacts for.

pagequeryinteger · int32

Page number.

pageSizequeryinteger · int32

Number of items per page.

excludeInvalidEmailsqueryboolean

Optional boolean param to exclude contacts with invalid emails

includeInactivequeryboolean

Optional boolean param to include inactive contacts

searchquerystring

Optional search term to filter contacts by first name, last name or email.

Responses

Company contacts retrieved successfully.

Standard response envelopeisSuccessmessageerrorsdata

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

Paginated
dataPaginatedResponse<ContactDto[]>
  • totalCountinteger · int32
    • contactIdinteger · int32
    • companyIdinteger · int32
    • companyDisplaystring
    • firstNamestring
    • middleNamestring
    • lastNamestring
    • fullNamestring
    • nickNamestring
    • phonestring
    • cellstring
    • faxstring
    • emailstring
    • titlestring
    • positionstring
    • departmentstring
    • deletedboolean
    • activeboolean
    • enteredstring · date-time
    • lastModifiedstring · date-time
    • completeboolean
    • externalIdstring
    • globalUnsubscribeboolean
    • linkedboolean
    • lastTouchUserstring
    • lastTouchDatestring · datenullable
  • pageCountinteger · int32
  • currentPageCountinteger · int32
  • nextPageNumberinteger · int32nullable
  • hasNextPageboolean