Skip to main content
GET
/
projects
/
{project_id}
/
keys
/
{key_id}
/
comments
cURL
curl "https://api.phrase.com/v2/projects/:project_id/keys/:key_id/comments?branch=my-feature-branch&filters=unread&query=something&locale_ids=someId&order=desc" \
  -u USERNAME_OR_ACCESS_TOKEN \
  -X GET \
  -H 'Content-Type: application/json'
[
  {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "message": "Some message...",
    "has_replies": true,
    "user": {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "username": "joe.doe",
      "name": "Joe Doe"
    },
    "created_at": "2015-01-28T09:52:53Z",
    "updated_at": "2015-01-28T09:52:53Z",
    "locales": [
      {
        "id": "abcd1234cdef1234abcd1234cdef1234",
        "name": "English",
        "code": "en-GB"
      }
    ]
  }
]

Authorizations

​
Authorization
string
header
required

Enter your token in the format token TOKEN

Headers

​
X-PhraseApp-OTP
string

Two-Factor-Authentication token (optional)

Path Parameters

​
project_id
string
required

Project ID

​
key_id
string
required

Translation Key ID

Query Parameters

​
page
integer

Page number

​
per_page
integer

Limit on the number of objects to be returned, between 1 and 100. 25 by default

​
branch
string

specify the branch to use

​
query
string

Search query for comment messages

​
locale_ids
string[]

Search comments by their assigned locales

​
filters
enum<string>[]

Specify the filter for the comments. Supported values are read and unread. Combine both to return all comments (read + unread) without filtering.

Available options:
read,
unread
Example:
["read", "unread"]
​
order
enum<string>

Order direction. Defaults to desc. Values other than asc and desc fall back to desc.

Available options:
asc,
desc

Response

OK

​
id
string
​
message
string
​
has_replies
boolean
​
user
user_preview · object
Example:
{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "username": "johndoe",
  "name": "John Doe",
  "gravatar_uid": "205e460b479e2e5b48aec07710c08d50"
}
​
created_at
string<date-time>
​
updated_at
string<date-time>
​
mentioned_users
user_preview · object[]
​
locales
locale_preview · object[]