GET /notifications

Get a list of notifications that user has

Returns all notifications (except emails and links) for the given user

Maintained by the OnePageCRM engineering team

Query parameters

Name	Type	Description
`page`	integer	Page number. Starts from 1. Default is 1.
`per_page`	integer	Number of records to return. Maximum 100 allowed. Default is 10.

Responses

200 OK

statusintegerint32
Response code
messagestring
Response message
timestampintegerunix-timestamp
Response time
dataobject
object fields →
- notificationsarray<object>
  array item 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
- total_countintegerint32
  Total number of items
- pageintegerint32
  Current page number
- per_pageintegerint32
  Number of items returned in each page
- max_pageintegerint32
  The page number of the last page of items

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

Related guides

GET /notifications

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

200 example response

{
  "status": 0,
  "message": "OK",
  "timestamp": 1528373119,
  "data": {
    "notifications": [
      {
        "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"
          }
        }
      }
    ],
    "total_count": 1,
    "page": 1,
    "per_page": 10,
    "max_page": 1
  }
}