Alfa

Inbox

List inbox conversations, a page at a time

GET/v1/inbox/threads/page

Newest message first, with the same filters as listing conversations but without the lane and job tallies. An unknown `lane` falls back to every lane. Pass `nextCursor` back as `cursor` for the next page.

Requires the session token of a signed-in Alfa user as a bearer token.

Query parameters

  • jobIdinteger | string
  • searchstring
  • lanestring
  • candidateIdinteger | string
  • sourcedCandidateIdinteger | string
  • limitinteger | string
  • cursorstring

    at least 1 characters · at most 512 characters

Response body

  • dataany[]required

    The results on this page.

  • nextCursorstring | nullrequired

    Pass as `cursor` to read the next page; null on the last page.

Responses

  • 200Success.
  • 400The request is malformed: invalid JSON, an unexpected body or an unknown query parameter. Problem details
  • 401The bearer token is missing, expired or invalid. Problem details
  • 403The caller may not perform this operation, or has no active organisation. Problem details
  • 404The resource does not exist or is not visible to the caller. Problem details
  • 422The request failed validation; `errors` lists each invalid field. Problem details
  • 429Too many requests, or the AI service is busy. Retry after a short wait. Problem details
  • 500An unexpected error. Quote the `correlationId` to support. Problem details