GET /notifications/{notification_id}

Get serialised notification by ID

Returns one of your notifications by ID. The type field identifies what it is about — for example an assigned action, a note, call, meeting, email or contact assignment — and read shows whether it has been seen. Notifications are removed once 100 newer ones have been generated for you.

Maintained by the OnePageCRM engineering team

Path parameters

Name	Type	Description
`notification_id` req	string	Notification ID

Responses

200 OK

statusintegerint32
Response code
messagestring
Response message
timestampintegerunix-timestamp
Response time
dataobject
object fields →
- notificationobject
  A serialised notification. There are different types of notifications, each can have its own properties
  object fields →
  idstringbson-id
  ID of the notification
  typestring
  Type of the notification
  enum: assigned_action · action_with_time · contact_assigned · call · meeting · email · link · note
  bystring
  User name that caused the notification
  readboolean
  Tells if notification was marked as read
  user_idstringbson-id
  The ID of affected user, ID of assignee user
  contact_idstringbson-id
  The ID of a contact related to which the notification has been created
  created_atstring
  Date which tells when the notification was created
  modified_atstring
  Date which tells when the notification was last updated
  mobile_dataobject
  Data created for the purpose of push notifications for mobile apps
  object fields →
  titlestring
  Title of push notification
  bodystring
  Body of push notification
  action_typestring
  Type of action

Standard error responses: 400 · 401 · 403 · 404 · 409 · 500 — shared across the API. See Errors.

Related guides

GET /notifications/{notification_id}

curl "https://app.onepagecrm.com/api/v3/notifications/{notification_id}" \
  -u $user_id:$api_key

200 example response

{
  "status": 0,
  "message": "OK",
  "timestamp": 1528373119,
  "data": {
    "notification": {
      "id": "5aead4809007ba56ffca942e",
      "type": "assigned_action",
      "by": "Vlad K.",
      "read": true,
      "user_id": "5aead4809007ba56ffca942e",
      "contact_id": "5aead4809007ba56ffca942e",
      "created_at": "2019-06-21T16:53:12Z",
      "modified_at": "2019-06-21T16:53:12Z",
      "mobile_data": {
        "title": "Action assigned to you (by User N.)",
        "body": "17:13: in bulk",
        "action_type": "action_with_time"
      }
    }
  }
}