Skip to main content
GET
/
note
List all notes
curl --request GET \
  --url https://jobaffinity.fr/restapi/v1/note \
  --header 'Authorization: Basic <encoded-value>'
{
  "_self": "<string>",
  "_schema": "<string>",
  "_status": "OK",
  "_next": "<string>",
  "items": [
    {
      "_self": "<string>",
      "_schema": "<string>",
      "_status": "OK",
      "id": 123,
      "datetime": "2023-11-07T05:31:56Z",
      "text": "<string>",
      "organisation": {
        "id": 123,
        "name": "<string>"
      },
      "candidate": {
        "id": 123,
        "_self": "<string>",
        "title": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "email": "jsmith@example.com",
        "applications": {
          "_self": "<string>"
        }
      },
      "user": {
        "id": 123,
        "first_name": "<string>",
        "last_name": "<string>",
        "email": "jsmith@example.com"
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

HTTP Basic Authentication with API credentials

Query Parameters

​
limit
integer
default:20

Maximum number of items to return per page

Required range: 1 <= x <= 100
​
since
integer

Return items created or modified since this ID

Required range: x >= 0
​
candidate_id
integer

Filter notes for a specific candidate. This ID is provided by the .id field of the candidate detail resource.

​
organisation_id
integer

Filter notes for a specific organisation.

Response

Paginated list of notes

​
_self
string<uri>
​
_schema
string<uri>
​
_status
enum<string>
Available options:
OK,
INVALID
​
_next
string<uri> | null
​
items
object[]