get

Retrieves all messages for a specific application. Returns both messages sent to the candidate (outbound) and responses from the candidate (inbound). Messages are ordered by sent date, newest first.

Authentication: Requires valid x-api-key header.

Response Example:

{
  "data": [
    {
      "external_id": "uuid123456",
      "message_id": "msg001",
      "message_body": "Thank you for applying! We'd like to schedule an interview.",
      "message_direction": "to_candidate",
      "message_type": "text",
      "sent_at": "Thu, 23 Oct 2025 13:12:47 GMT",
      "status": "SENT",
      "subject": null
    },
    {
      "external_id": "response789012",
      "message_id": "msg002",
      "message_body": "I am available for an interview next week.",
      "message_direction": "from_candidate",
      "message_type": "text",
      "sent_at": "Thu, 23 Oct 2025 13:12:47 GMT",
      "status": "DELIVERED",
      "subject": null
    },
    {
      "external_id": "response789015",
      "message_id": "msg005",
      "message_body": "Hey your interview is scheduled for next week.",
      "message_direction": "to_candidate",
      "message_type": "email",
      "sent_at": "Thu, 23 Oct 2025 13:12:47 GMT",
      "status": "DELIVERED",
      "subject": "Interview Scheduled"
    },
  ]
}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The application form ID corresponding to a job application in the Apploi platform. The application form ID is a unique identifier for the job application in the Apploi platform. The application form ID can be found in the 'id' field of the each of the items in the response body of a call to the /applicants endpoint in the Apploi Partner API.

Examples: 265733753, 265733754, etc.

Headers
string
required
string
Responses

403

403 response

404

404 response

405

405 response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json