Sign in

v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Companies

Get Contact IDs for Companies

Returns a list of contact IDs for the specified companies.

post/v1/companies/contacts/ids

Headers

RequestIdstring uuid

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Request body

IntegerSchema[] required

Response

The list of contacts for the specified companies.

companyIdinteger

The identifier for the Company.

contactIdsinteger[]

List of identifiers for Contacts.

Example response

[
  {
    "companyId": 12345,
    "contactIds": [
      67890,
      54321
    ]
  }
]