Retrieve comments

You can retrieve comments created on a candidate using the API.

Request

This method allows you to retrieve comments created on a candidate:

GET /company/{companyID}/applicant/{applicantID}/comments

Parameters

Parameter	In	Type	Required	Description	Example
companyID	path	string	✔️	Company identifier	0GjqBwprWAdArDl4
applicantID	path	string	✔️	Candidate id	ADYjo9mGxZdkR0ry
fields	query	string		Fields to display, separated by a comma	author, attachments

Request example

cURL request

curl -X GET 'https://api.flatchr.io/company/0GjqNwprWAdArDl4/applicant/ADYjo9mGxZdkR0ry/comments?fields=author'
    -H "Authorization: Bearer {token}"
    -H 'Content-Type: application/json'

Response

Name	Type	Description
id	integer	Comment identifier
text	string	Comment content
private	boolean	Whether the comment is private
favorite	boolean	Whether the comment is favorited
created_by	integer	Comment author identifier
created_at	timestamp	Comment creation date
type	string	Comment type
reply_to	integer	Parent comment identifier if this comment is a reply to an existing comment
author	author	Comment author
attachments	attachments	Comment attachments

Response example

[
    {
        "id": 3499,
        "text": "<p>- Can you introduce yourself?<br>- What do you know about our company?<br>- Why do you want to leave your current position?</p>",
        "private": false,
        "favorite": false,
        "created_by": 391,
        "created_at": "2022-02-04T10:39:28.178Z",
        "reply_to": null,
        "author": {
            "id": "lVq5r8pYXkNAmMvP",
            "firstname": "XXXX",
            "lastname": "XXXX"
        }
    },
    {
        "id": 3615,
        "text": "<p>Excellent answers to the questions</p>",
        "private": false,
        "favorite": false,
        "created_by": 391,
        "created_at": "2022-02-15T16:18:14.322Z",
        "reply_to": 3499,
        "author": {
            "id": "lVq5r8pYXk9AmMvP",
            "firstname": "XXXX",
            "lastname": "XXXX"
        }
    }
]