Skip to main content
GET
/
notifications
cURL
curl "https://api.phrase.com/v2/notifications" \
  -u USERNAME_OR_ACCESS_TOKEN
[
  {
    "id": "abcd1234",
    "event_name": "keys:create",
    "data": "object notification data",
    "resource": "object of notification resource",
    "locale": {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "name": "de",
      "code": "de-DE",
      "default": true,
      "main": false,
      "rtl": false,
      "plural_forms": [
        "zero",
        "one",
        "other"
      ],
      "source_locale": {
        "id": "abcd1234cdef1234abcd1234cdef1234",
        "name": "en",
        "code": "en-GB"
      },
      "created_at": "2015-01-28T09:52:53Z",
      "updated_at": "2015-01-28T09:52:53Z"
    },
    "user": {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "username": "joe.doe",
      "name": "Joe Doe"
    },
    "project": {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "name": "My Android Project",
      "main_format": "xml",
      "project_image_url": "http://assets.example.com/project.png",
      "account": {
        "id": "abcd1234",
        "name": "Company Account",
        "slug": "company_account",
        "company": "My Awesome Company",
        "created_at": "2015-01-28T09:52:53Z",
        "updated_at": "2015-01-28T09:52:53Z",
        "company_logo_url": "http://assets.example.com/company_logo.png"
      },
      "created_at": "2015-01-28T09:52:53Z",
      "updated_at": "2015-01-28T09:52:53Z"
    },
    "account": {
      "id": "abcd1234",
      "name": "Company Account",
      "slug": "company_account",
      "company": "My Awesome Company",
      "created_at": "2015-01-28T09:52:53Z",
      "updated_at": "2015-01-28T09:52:53Z",
      "company_logo_url": "http://assets.example.com/company_logo.png"
    },
    "group": {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "event_name": "keys:create",
      "created_at": "2015-01-28T09:52:53Z",
      "updated_at": "2015-01-28T09:52:53Z"
    }
  }
]

Authorizations

​
Authorization
string
header
required

Enter your token in the format token TOKEN

Headers

​
X-PhraseApp-OTP
string

Two-Factor-Authentication token (optional)

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

​
unseen
boolean

Include only unseen notifications

Response

OK

​
id
string
​
event_name
string
​
created_at
string<date-time>
​
updated_at
string<date-time>
​
delivered_at
string<date-time>
​
seen_at
string<date-time>
​
data
object
​
resource
object
​
locale
locale · object
Example:
{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "name": "de",
  "code": "de-DE",
  "default": true,
  "main": false,
  "rtl": false,
  "plural_forms": ["zero", "one", "other"],
  "ordinal_plural_forms": ["zero", "other"],
  "source_locale": {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "name": "en",
    "code": "en-GB"
  },
  "fallback_locale": {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "name": "en",
    "code": "en-GB"
  },
  "created_at": "2015-01-28T09:52:53Z",
  "updated_at": "2015-01-28T09:52:53Z"
}
​
user
user_preview · object
Example:

null

​
project
project · object
Example:
{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "name": "My Android Project",
  "slug": "android_project",
  "main_format": "xml",
  "project_image_url": "http://assets.example.com/project.png",
  "account": "account",
  "space": "space",
  "created_at": "2015-01-28T09:52:53Z",
  "updated_at": "2015-01-28T09:52:53Z"
}
​
account
account · object
Example:
{
  "id": "abcd1234",
  "name": "Company Account",
  "slug": "company_account",
  "company": "My Awesome Company",
  "created_at": "2015-01-28T09:52:53Z",
  "updated_at": "2015-01-28T09:52:53Z",
  "company_logo_url": "http://assets.example.com/company_logo.png"
}
​
group
notification_group · object
Example:
{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "event_name": "keys:create",
  "created_at": "2015-01-28T09:52:53Z",
  "updated_at": "2015-01-28T09:52:53Z"
}