GET
/
v1.0
/
{company_id}
/
candidates
/
{candidate_id}
/
notes
curl --request GET \
  --url https://api.hirehive.com/v1.0/{company_id}/candidates/{candidate_id}/notes \
  --header 'Authorization: Bearer <token>'
{
  "meta": {
    "page_size": 123,
    "page": 123,
    "total_items": 123,
    "total_pages": 123,
    "has_next_page": true,
    "has_previous_page": true
  },
  "links": {
    "first": "<string>",
    "last": "<string>",
    "next": "<string>",
    "previous": "<string>"
  },
  "items": [
    {
      "id": "<string>",
      "date_created": "2023-11-07T05:31:56Z",
      "text": "<string>",
      "creator": {
        "name": "<string>",
        "user_id": "<string>",
        "guest_id": "<string>",
        "recruiter": "<string>"
      },
      "files": [
        {
          "name": "<string>",
          "original_name": "<string>",
          "content_type": "<string>",
          "file_extension": "<string>",
          "id": "<string>",
          "type": "inbound_email_attachment",
          "size_in_kb": 123,
          "download_link": "<string>"
        }
      ],
      "mentioned_users": [
        "<string>"
      ],
      "restricted": true,
      "share": {
        "id": "<string>",
        "application_id": "<string>",
        "message": "<string>",
        "metadata": {
          "expires_at": "2023-11-07T05:31:56Z",
          "visits": 123,
          "expired": true,
          "revoked": true
        },
        "guest": {
          "id": "<string>",
          "email": "<string>"
        },
        "sender": {
          "id": "<string>",
          "first_name": "<string>",
          "last_name": "<string>"
        }
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
company_id
string
required
​
candidate_id
string
required

Query Parameters

​
page
integer

Defaults to 1

​
page_size
integer

Defaults to 30. Min = 1. Max = 100

Required range: 1 <= x <= 100

Response

200
application/json
​
meta
object
​
links
object
​
items
object[]

Was this page helpful?

Suggest editsRaise issue