Get a notification

GEThttps://api-staging.pixwel.com/api/notifications/{id}

Path parameters

idstringrequired

Response

_idstring

fromstring

tostring

eventobject

curl -X GET 'https://api-staging.pixwel.com/api/notifications/{id}' \
  -H 'Authorization: Basic <credentials>' \
  -H 'Accept: application/json'

{
  "_id": "507f1f77bcf86cd799439011",
  "from": "507f1f77bcf86cd799439011",
  "to": "507f1f77bcf86cd799439011",
  "event": {
    "_id": "507f1f77bcf86cd799439011",
    "processed": true,
    "pushed": true,
    "digested": true,
    "created": 0,
    "body": "string",
    "graphicsFile": {
      "id": "string",
      "url": "https://example.com/path/to/object",
      "name": "string",
      "rootId": "string",
      "version": 0
    },
    "graphicsComment": {
      "id": "string",
      "replyTo": "string",
      "body": "string",
      "user": {
        "_id": "507f1f77bcf86cd799439011",
        "name": "string",
        "email": "user@example.com"
      },
      "created": 0,
      "fileId": "string"
    },
    "notify": {
      "users": [
        "507f1f77bcf86cd799439011"
      ],
      "groups": [
        "507f1f77bcf86cd799439011"
      ]
    },
    "from": {
      "_id": "507f1f77bcf86cd799439011",
      "status": {
        "invited": true,
        "approved": true,
        "registered": true,
        "confirmed": true
      },
      "invite": "https://example.com/path/to/object",
      "name": "string",
      "username": "user@example.com",
      "emailNormal": "user@example.com"
    },
    "type": "string",
    "workRequest": {
      "_id": "507f1f77bcf86cd799439011",
      "auto": true,
      "autosubs": true,
      "dualLanguages": true,
      "aspectRatio": "string",
      "status": "string",
      "from": "507f1f77bcf86cd799439011",
      "asset": "507f1f77bcf86cd799439011",
      "assetType": "string",
      "assetCategory": "string",
      "due": {
        "date": 0,
        "tz": "string"
      },
      "deliveryDeadline": {
        "date": 0,
        "tz": "string"
      },
      "autoMode": true,
      "language": "string",
      "territory": "string",
      "dng": {
        "dialogue": [
          "string"
        ],
        "graphics": [
          "string"
        ],
        "narration": [
          "string"
        ]
      },
      "audioFile": null,
      "instructions": "string",
      "urls": {
        "view": "https://example.com/path/to/object",
        "manage": "https://example.com/path/to/object",
        "invite": "https://example.com/path/to/object",
        "translate": "https://example.com/path/to/object"
      },
      "files": [
        {
          "name": "string",
          "files": null
        }
      ],
      "uses": {
        "items": [
          "string"
        ],
        "details": null
      },
      "dcp": {
        "items": [
          "string"
        ],
        "details": null
      },
      "recipients": null,
      "shippingAddresses": null,
      "project": "507f1f77bcf86cd799439011",
      "studio": "507f1f77bcf86cd799439011",
      "estimate": {
        "base": {
          "graphics": 0,
          "narration": 0,
          "scripts": 0,
          "dubbing": 0,
          "subtitling": 0,
          "hybrid": 0,
          "encoding": 0,
          "autosubs": 0,
          "autogfx": 0
        },
        "applied": {
          "graphics": 0,
          "narration": 0,
          "scripts": 0,
          "dubbing": 0,
          "subtitling": 0,
          "hybrid": 0,
          "encoding": 0,
          "autosubs": 0,
          "autogfx": 0,
          "files": 0,
          "total": 0
        }
      },
      "materials": [
        {
          "name": "string",
          "complete": true,
          "approved": true,
          "files": [
            null
          ],
          "changeRequests": [
            {
              "id": null,
              "_id": null,
              "_optimistic": null,
              "fileId": null,
              "body": null,
              "status": null,
              "user": null,
              "requestedBy": null,
              "requestedAt": null,
              "created": null,
              "replies": null,
              "editedAt": null
            }
          ]
        }
      ],
      "rejections": null,
      "history": [
        {
          "date": 0,
          "user": {
            "_id": "507f1f77bcf86cd799439011",
            "emailNormal": "user@example.com",
            "name": "string",
            "groups": [
              null
            ]
          },
          "status": "string",
          "reason": "string"
        }
      ],
      "reason": "string",
      "graphicsTranslation": "507f1f77bcf86cd799439011",
      "translation": "507f1f77bcf86cd799439011",
      "tags": null
    },
    "projects": [
      {
        "_id": "507f1f77bcf86cd799439011",
        "name": "string",
        "slug": "string"
      }
    ],
    "assets": [
      {
        "_id": "507f1f77bcf86cd799439011",
        "name": "string",
        "project": "507f1f77bcf86cd799439011",
        "type": "string",
        "notifyUrl": "https://example.com/path/to/object"
      }
    ],
    "urls": {
      "view": "https://example.com/path/to/object",
      "manage": "https://example.com/path/to/object",
      "invite": "https://example.com/path/to/object",
      "translate": "https://example.com/path/to/object"
    },
    "assetTypes": [
      "string"
    ]
  },
  "type": "string",
  "title": "string",
  "emailSubject": "string",
  "read": true,
  "viewed": true,
  "sent": true,
  "added": 0,
  "created": 0,
  "$links": {
    "self": "//example.com/path/to/object"
  }
}