Get Candidate Note

curl --request GET \
  --url https://api.stackone.com/unified/ats/candidates/{id}/notes/{subResourceId} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'

{
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "unified_custom_fields": {
      "my_project_custom_field_1": "REF-1236",
      "my_project_custom_field_2": "some other value"
    },
    "content": [
      {
        "body": "This candidate seems like a good fit for the role"
      }
    ],
    "author_id": "1234567890",
    "remote_author_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
    "visibility": "public",
    "created_at": "2021-01-01T01:01:01.000Z",
    "updated_at": "2021-01-01T01:01:01.000Z",
    "deleted_at": "2021-01-01T01:01:01.000Z"
  },
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": {},
      "response": {}
    }
  ]
}

GET

unified

ats

candidates

{id}

notes

{subResourceId}

Get Candidate Note

curl --request GET \
  --url https://api.stackone.com/unified/ats/candidates/{id}/notes/{subResourceId} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'

{
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "unified_custom_fields": {
      "my_project_custom_field_1": "REF-1236",
      "my_project_custom_field_2": "some other value"
    },
    "content": [
      {
        "body": "This candidate seems like a good fit for the role"
      }
    ],
    "author_id": "1234567890",
    "remote_author_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
    "visibility": "public",
    "created_at": "2021-01-01T01:01:01.000Z",
    "updated_at": "2021-01-01T01:01:01.000Z",
    "deleted_at": "2021-01-01T01:01:01.000Z"
  },
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": {},
      "response": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

x-account-id

string

required

The account identifier

Path Parameters

string

required

subResourceId

string

required

Query Parameters

raw

boolean | null

Indicates that the raw request result should be returned in addition to the mapped result (default value is false)

proxy

object

Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key

fields

string | null

The comma separated list of fields that will be returned in the response (if empty, all fields are returned)

Example:

"id,remote_id,content,author_id,remote_author_id,visibility,created_at,updated_at,deleted_at,unified_custom_fields"

Response

The note with the given identifier related to the candidate with the given identifier was retrieved.

data

object

required

Show child attributes

data.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.unified_custom_fields

object

Custom Unified Fields configured in your StackOne project

Example:

{
  "my_project_custom_field_1": "REF-1236",
  "my_project_custom_field_2": "some other value"
}

data.content

object[] | null

Show child attributes

data.content.body

string | null

Body of the note

Example:

"This candidate seems like a good fit for the role"

data.author_id

string | null

Unique identifier of the author

Example:

"1234567890"

data.remote_author_id

string | null

Provider's unique identifier of the author

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

data.visibility

object

Visibility of the note

Show child attributes

data.visibility.value

enum<string> | null

The visibility of the notes.

Available options:

private,

public,

unmapped_value,

Example:

"public"

data.visibility.source_value

The source value of the notes visibility.

Example:

"Public"

Example:

"public"

data.created_at

string<date-time> | null

Date of creation

Example:

"2021-01-01T01:01:01.000Z"

data.updated_at

string<date-time> | null

Date of last update

Example:

"2021-01-01T01:01:01.000Z"

data.deleted_at

string<date-time> | null

Date of Deletion

Example:

"2021-01-01T01:01:01.000Z"

raw

object[] | null

Show child attributes

raw.method

string

required

raw.url

string

required

raw.body

object

raw.response

Create Candidate Note List Application Custom Field Definitions

⌘I

Getting Started

Use Cases

API Reference

Get Candidate Note

Authorizations

Headers

Path Parameters

Query Parameters

Response