Notes

Get note

Returns a single note with author and visibility metadata. Use include=user to load author details, include=candidate to embed the full candidate payload (with url_backoffice).

get/notes/{id}

Request

Base URL: https://api.100hires.com/v2
URL: https://api.100hires.com/v2/notes/{id}
Auth: HTTP bearer

Path parameters

idinteger required

Resource ID (numeric).

Query parameters

includestring

Comma-separated list of related resources to include. Supported: user — author details, candidate — full candidate payload with url_backoffice for UI deep-linking.

Response

Note

idinteger required

Unique identifier

candidate_idinteger required

ID of the candidate this note belongs to

user_idinteger required

Author user ID (always present)

url_backofficestring uri

Absolute backoffice URL to the candidate's discussion tab where this note appears in the 100Hires recruiter app. Use to render deep-links in agent UIs.

bodystring

Note content (may contain HTML). Mentioned users are wrapped in <span class="mention-area"> markup. Present only when view=full (default); replaced with body_preview when view=summary.

body_previewstring

First 200 UTF-8 characters of the note content with a ... suffix when truncated. Present only when view=summary; replaces body to keep list responses inside the agent context budget.

visibilitystring required

Visibility: 'all' (visible to team) or 'private' (author only)

created_atinteger required

Unix timestamp (seconds)

updated_atinteger required

Unix timestamp (seconds)

Example response

{
  "url_backoffice": "https://app.100hires.com/candidate/dtGeby2#/profile/discussion",
  "candidate": {
    "alias": "dtGeby2",
    "url_backoffice": "https://app.100hires.com/candidate/dtGeby2"
  }
}

Changes

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