Skip to main content
GET
cURL

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:
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:
created_at
string<date-time>
updated_at
string<date-time>
mentioned_users
user_preview · object[]
locales
locale_preview · object[]