Get a single notification

cURL

curl "https://api.phrase.com/v2/notification/:id" \
  -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"
  }
}

GET

notifications

{id}

cURL

curl "https://api.phrase.com/v2/notification/:id" \
  -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)

Path Parameters

string

required

Response

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

Show child attributes

locale.id

string

locale.name

string

locale.code

string

locale.default

boolean

locale.main

boolean

locale.rtl

boolean

locale.plural_forms

string[]

locale.ordinal_plural_forms

string[]

locale.source_locale

locale_preview · object

Show child attributes

locale.source_locale.id

string

locale.source_locale.name

string

locale.source_locale.code

string

Example:

{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "name": "English",
  "code": "en-GB"
}

locale.fallback_locale

locale_preview · object

Show child attributes

locale.fallback_locale.id

string

locale.fallback_locale.name

string

locale.fallback_locale.code

string

Example:

{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "name": "English",
  "code": "en-GB"
}

locale.created_at

string<date-time>

locale.updated_at

string<date-time>

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

Show child attributes

user.id

string

user.username

string

user.name

string

user.gravatar_uid

string

Example:

null

project

project · object

Show child attributes

project.id

string

project.name

string

project.slug

string

project.main_format

string

project.project_image_url

string

project.media

string

project.account

account · object

Show child attributes

project.account.id

string

project.account.name

string

project.account.slug

string

project.account.company

string

project.account.created_at

string<date-time>

project.account.updated_at

string<date-time>

project.account.company_logo_url

string

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"
}

project.space

space · object

Show child attributes

project.space.id

string

project.space.name

string

project.space.created_at

string<date-time>

project.space.updated_at

string<date-time>

project.space.projects_count

integer

Example:

{
  "id": "2e7574e8f2372906a03110c2a7cfe671",
  "name": "My first space",
  "created_at": "2020-02-25T12:17:25Z",
  "updated_at": "2020-03-13T14:46:57Z",
  "projects_count": 2
}

project.point_of_contact

user_preview · object

Show child attributes

project.point_of_contact.id

string

project.point_of_contact.username

string

project.point_of_contact.name

string

project.point_of_contact.gravatar_uid

string

Example:

null

project.created_at

string<date-time>

project.updated_at

string<date-time>

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

Show child attributes

account.id

string

account.name

string

account.slug

string

account.company

string

account.created_at

string<date-time>

account.updated_at

string<date-time>

account.company_logo_url

string

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

Show child attributes

group.id

string

group.event_name

string

group.created_at

string<date-time>

group.updated_at

string<date-time>

Example:

{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "event_name": "keys:create",
  "created_at": "2015-01-28T09:52:53Z",
  "updated_at": "2015-01-28T09:52:53Z"
}

Mark all notifications as read List orders

⌘I

Guides

API Documentation

Authorizations

Headers

Path Parameters

Response