List shortlist notes

GET https://api.vamotalent.ai/v2/shortlists/{id}/notes
Access
Authenticated
shortlist:read
Cost
Free
Rate limit
120 / minute per account
Quota
None

The notes on a shortlist, newest first, each with who wrote it and when. These are the notes about the list as a whole: a note about one person is read with GET /v2/contacts/{contactId}/notes. Page with limit, and pass each nextCursor back as cursor until it is null. Notes are append only, so a page you have read does not change: newer notes arrive ahead of it.

Path parameters

  • id string required
    max 16 chars

Query parameters

  • limit integer default: 50

    How many notes to return, 1 to 100.

    min 1, max 100
  • cursor string

    The `nextCursor` from the page before, to read the next, older page. Omit it for the newest notes.

    max 256 chars

Responses

A page of notes, newest first

  • notes array of ShortlistNote required

    This page of notes, newest first.

    • id string required

      The note id.

    • shortlistId string required

      The shortlist the note is on.

    • body string required

      The note text, as written.

    • author NoteAuthor required

      Who wrote a note, or who last edited it.

      • kind string required

        What wrote the note: `member` is a person on the account, `key` is an API key, `tool` is an AI tool a person signed in, and `system` is Vamo.

        memberkeytoolsystem
      • id string | null required

        The id of that member, key or tool connection. Null for `system`.

      • name string | null required

        What to call them: the person’s name for a member, the key’s label for a key, the tool’s name for a tool, and `Vamo` for `system`. Null when no name is held.

    • createdAt string required

      When the note was written, as an ISO 8601 instant.

  • nextCursor string | null required

    Pass it back as `cursor` to read the next, older page. Null on the last page. Do not parse or construct it.