messages

Fetch messages

Search for messages of given candidate. Use jobId parameter to filter results to messages only for specific job application. Accessible only for users with ADMINISTRATOR role.

get/messages

Request

  • Base URL
    https://api.smartrecruiters.com
  • URL
    https://api.smartrecruiters.com/messages
  • Auth
    • API key in header x-smarttoken
    • or OAuth 2
      Authorization code: https://www.smartrecruiters.com/identity/oauth/allow
      Token URL: https://api.smartrecruiters.com/identity/oauth/token scopes: messages_read

Query parameters

candidateIdstring guid required

identifier of a candidate

jobIdstring guid

identifier of a job

pageIdstring

identifier of next page

limitinteger

limit

Response

Messages successfully fetched

contentstring
createdOnstring date-time
visibility'PRIVATE' | 'DIRECT' | 'OPEN' | 'EVERYONE'
authorIdstring

Changes

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