AVavionte
Contacts

Get a Contact Activity

Returns the specified activity for the specified contact.

get/v1/contact/{contactId}/activity/{activityId}

Request

  • Base URL
    https://api.avionte.com/front-office
  • URL
    https://api.avionte.com/front-office/v1/contact/{contactId}/activity/{activityId}
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

contactIdstring required

The identifier for the contact whose activity is being retrieved.

activityIdstring required

The identifier for the contact activity.

Headers

RequestIdstring uuid

Unique request identifier in UUID format used to correlate request data to log entries and events.

Example:63680b86-c7e0-4a36-ae4a-d0d481089aff

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

The contact activity.

idinteger

The identifier for the contact activity.

contactIdinteger

The identifier for the contact the activity was logged against.

companyIDinteger nullable

The identifier for the contact's company. Null when the contact has no company.

typeIdinteger

The identifier for the activity type.

namestring

The name of the activity type.

show_ininteger

An indicator of the activity type group that includes the current activity type. Possible values are -2 for Archived Activities/Tasks, -1 for All Activities/Tasks, 0 for Custom Tasks/Activities, 1 for Activities, and 2 for Tasks.

activityDatestring date-time

The date of the activity, in UTC.

enteredDatestring date-time

The date the activity record was created, in UTC.

notesstring

Notes on the contact activity.

userIdinteger

The identifier for the user who logged the activity.

Example response

{
  "id": 53892,
  "contactId": 137914,
  "companyID": 4821,
  "typeId": 284,
  "name": "Interview completed",
  "show_in": 1,
  "activityDate": "2024-12-01T14:30:00Z",
  "enteredDate": "2024-12-01T14:35:12Z",
  "notes": "Called to discuss the open requisition.",
  "userId": 42948,
  "contactActivityDetailsDefinitionIds": [
    {
      "id": 311,
      "detailsName": "Left voicemail"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.