Tags

The Tag object is used to represent a tag for a candidate.

The Tag object

Properties

remote_idString
Optional
The third-party API ID of the matching object.
nameString
Optional
The tag's name.
remote_dataArray
Optional
remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted by third party webhooks.
field_mappingsObject
Optional
The Tag object
JSON
{
  "remote_id": "4567",
  "name": "High-Priority",
  "remote_data": [
    {
      "path": "/tags",
      "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

/tags

Returns a list of Tag 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.
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_idString
Optional
The API provider's ID for the given object.
Response
JSON
{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "remote_id": "4567",
      "name": "High-Priority",
      "remote_data": [
        {
          "path": "/tags",
          "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"
        }
      }
    }
  ]
}
Field support by platform

Ashby

Ashby

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataArray
remote_idString

Breezy

Breezy

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataArray

CATS

CATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataArray
remote_idString

Clockwork

Clockwork

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataArray
remote_idString

Cornerstone TalentLink

Cornerstone TalentLink

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataArray

Fountain

Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataArray

Greenhouse

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataArray
remote_idString

iCIMS

iCIMS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataArray
remote_idString

JazzHR

JazzHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataArray
remote_idString

JobScore

JobScore

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataArray

Lever

Lever

Recruitee

Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataArray

Recruiterflow

Recruiterflow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataArray

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataArray
remote_idString

SmartRecruiters

SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataArray

TalentLyft

TalentLyft

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataArray

Teamtailor

Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataArray

Workable

Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataArray

Workday

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.

Previous

Scorecards

Next Up

Users