Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB
Comments

List comments

List all comments for a key.

get/projects/{project_id}/keys/{key_id}/comments

Path parameters

project_idstring required

Project ID

key_idstring required

Translation Key ID

Query parameters

pageinteger

Page number

per_pageinteger

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

branchstring

specify the branch to use

querystring

Search query for comment messages

locale_idsstring[]

Search comments by their assigned locales

filtersstring[]

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

[
  "read",
  "unread"
]
order'asc' | 'desc'

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

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Response

OK

idstring
messagestring
has_repliesboolean
created_atstring date-time
updated_atstring date-time

Example response

[
  {
    "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"
      }
    ]
  }
]