Sign in

v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Contacts

Get Contact Activity Details Definitions

Returns a list of configuration definitions that describe the available contact activity detail types, optionally including archived definitions.

get/v1/contact-activity-definitions/details

Query parameters

includeArchivedboolean

An indication of whether archived definitions are included in the results.

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.

Response

A list of contact activity detail definitions.

idinteger required

The identifier for the contact activity detail definition.

namestring required

The name of the contact activity detail definition.

isArchivedboolean required

An indication of whether the contact activity detail definition is archived or not.

Example response

[
  {
    "id": 1,
    "name": "Left Voicemail"
  }
]