Activities

The Activity object is used to represent an activity for a candidate performed by a user.

The Activity object

Properties

idString

Required

remote_idString

Optional

The third-party API ID of the matching object.

userString

Optional

The user the performed the action.

remote_created_atString

Optional

When the third party's activity was created.

activity_typeEnum

Optional

The activity's type. Possible values include: NOTE, EMAIL, OTHER, or - in cases where there is no clear mapping - the original value passed through.

subjectString

Optional

The activity's subject.

bodyString

Optional

The activity's body.

visibilityEnum

Optional

The activity's visibility. Possible values include: ADMIN_ONLY, PUBLIC, PRIVATE, or - in cases where there is no clear mapping - the original value passed through.

remote_dataRemoteData[]

Optional

remote_was_deletedBoolean

Required

Indicates whether or not this object has been deleted by third party webhooks.

field_mappingsObject

Optional

The Activity object

JSON


{
  "id": "ecbe05ac-62a3-46c5-ab31-4b478b37d1b4",
  "remote_id": "198123",
  "user": "9d892439-5fab-4dbb-8bd8-34f7f96c7912",
  "remote_created_at": "2021-10-15T00:00:00Z",
  "activity_type": "NOTE",
  "subject": "Gil Feig's interview",
  "body": "Candidate loves integrations!!.",
  "visibility": "PRIVATE",
  "remote_data": [
    {
      "path": "/actions",
      "data": [
        "Varies by platform"
      ]
    }
  ],
  "remote_was_deleted": true,
  "field_mappings": {
    "organization_defined_targets": {
      "custom_key": "custom_value"
    },
    "linked_account_defined_targets": {
      "custom_key": "custom_value"
    }
  }
}

GET

/activities

Returns a list of Activity objects.

Header Parameters

AuthorizationString

Required

Token-based authentication with required prefix "Bearer"

X-Account-TokenString

Required

Token identifying the end user.

Query & Path Parameters

created_afterString

Optional

If provided, will only return objects created after this datetime.

created_beforeString

Optional

If provided, will only return objects created before this datetime.

cursorString

Optional

The pagination cursor value.

expandString

Optional

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

include_deleted_dataBoolean

Optional

Whether to include data that was marked as deleted by third party webhooks.

include_remote_dataBoolean

Optional

Whether to include the original data Merge fetched from the third-party to produce these models.

modified_afterString

Optional

If provided, will only return objects modified after this datetime.

modified_beforeString

Optional

If provided, will only return objects modified before this datetime.

page_sizeInteger

Optional

Number of results to return per page.

remote_fieldsString

Optional

Deprecated. Use show_enum_origins.

remote_idString

Optional

The API provider's ID for the given object.

show_enum_originsString

Optional

Which fields should be returned in non-normalized form.

user_idString

Optional

If provided, will only return activities done by this user.

Response

JSON


{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "id": "ecbe05ac-62a3-46c5-ab31-4b478b37d1b4",
      "remote_id": "198123",
      "user": "9d892439-5fab-4dbb-8bd8-34f7f96c7912",
      "remote_created_at": "2021-10-15T00:00:00Z",
      "activity_type": "NOTE",
      "subject": "Gil Feig's interview",
      "body": "Candidate loves integrations!!.",
      "visibility": "PRIVATE",
      "remote_data": [
        {
          "path": "/actions",
          "data": [
            "Varies by platform"
          ]
        }
      ],
      "remote_was_deleted": true,
      "field_mappings": {
        "organization_defined_targets": {
          "custom_key": "custom_value"
        },
        "linked_account_defined_targets": {
          "custom_key": "custom_value"
        }
      }
    }
  ]
}

ApplicantStack

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

subjectString

userString

Ashby

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

userString

CATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

subjectString

userString

Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

subjectString

userString

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

subjectString

userString

visibilityEnum

Homerun

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

subjectString

visibilityEnum

JazzHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

subjectString

userString

JobScore

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

visibilityEnum

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

subjectString

userString

visibilityEnum

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

subjectString

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

userString

Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

subjectString

userString

Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

subjectString

userString

Hint: Use the /linked-accounts endpoint to pull platform support information.

GET

/activities/{id}

Returns an Activity object with the given id.

Header Parameters

AuthorizationString

Required

Token-based authentication with required prefix "Bearer"

X-Account-TokenString

Required

Token identifying the end user.

Query & Path Parameters

expandString

Optional

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

idString

Required

include_remote_dataBoolean

Optional

Whether to include the original data Merge fetched from the third-party to produce these models.

remote_fieldsString

Optional

Deprecated. Use show_enum_origins.

show_enum_originsString

Optional

Which fields should be returned in non-normalized form.

Response

JSON


{
  "id": "ecbe05ac-62a3-46c5-ab31-4b478b37d1b4",
  "remote_id": "198123",
  "user": "9d892439-5fab-4dbb-8bd8-34f7f96c7912",
  "remote_created_at": "2021-10-15T00:00:00Z",
  "activity_type": "NOTE",
  "subject": "Gil Feig's interview",
  "body": "Candidate loves integrations!!.",
  "visibility": "PRIVATE",
  "remote_data": [
    {
      "path": "/actions",
      "data": [
        "Varies by platform"
      ]
    }
  ],
  "remote_was_deleted": true,
  "field_mappings": {
    "organization_defined_targets": {
      "custom_key": "custom_value"
    },
    "linked_account_defined_targets": {
      "custom_key": "custom_value"
    }
  }
}

ApplicantStack

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

subjectString

userString

Ashby

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

userString

CATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

subjectString

userString

Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

subjectString

userString

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

subjectString

userString

visibilityEnum

Homerun

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

subjectString

visibilityEnum

JazzHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

subjectString

userString

JobScore

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

visibilityEnum

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

subjectString

userString

visibilityEnum

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

subjectString

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

userString

Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

remote_idString

subjectString

userString

Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

activity_typeEnum

bodyString

remote_created_atString

remote_dataRemoteData[]

pathstring

dataobject

subjectString

userString

Hint: Use the /linked-accounts endpoint to pull platform support information.

Overview

Activities

The Activity object

Properties

/activities

Header Parameters

Query & Path Parameters

ApplicantStack

Ashby

CATS

Fountain

Greenhouse

Homerun

JazzHR

JobScore

Lever

Sage HR

SAP SuccessFactors

Teamtailor

Workable

/activities/{id}

Header Parameters

Query & Path Parameters

ApplicantStack

Ashby

CATS

Fountain

Greenhouse

Homerun

JazzHR

JobScore

Lever

Sage HR

SAP SuccessFactors

Teamtailor

Workable

Previous

Next Up

Get Started

API Reference