v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB

Contacts

Get All Contact Activity Types

Returns a list of available activities that can be logged for a contact and their details.

get/v1/contact/activity-types

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 types.

typeIdinteger required

The identifier for the activity type.

namestring

The name of the activity type.

show_ininteger

An indicator of which activity type group the current activity type should be included in. Allowed values: -2 for Archived Activities/Tasks, -1 for All Activities/Tasks, 0 for Custom Tasks/Activities, 1 for Activities, 2 for Tasks. A value of -2 cannot be submitted when creating an activity.

Example response

[
  {
    "typeId": 284,
    "name": "Interview completed",
    "show_in": 1
  }
]