Get User Notification Preferences

GET 
/organizations/:organizationId/users/:userId/notification-preferences

Get notification preferences for a user (email and in-app settings for work orders, requests, forms, SLA, system events)

Request

Path Parameters

organizationId stringrequired

Organization ID

userId stringrequired

User ID

Responses

200

application/json

Schema

Schema

data objectrequired
Notification preferences object
workOrders objectrequired
requests objectrequired
forms objectrequired
sla objectrequired
system objectrequired

Example (from schema)

{
  "data": {
    "workOrders": {},
    "requests": {},
    "forms": {},
    "sla": {},
    "system": {}
  }
}

Example

{}

401

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Unauthenticated",
  "message": "Authentication is required and has failed or has not yet been provided."
}

403

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Forbidden",
  "message": "Access to the requested resource is forbidden."
}

404

The resource hasn't found.

application/json

Schema

Schema

error stringrequired

The resource hasn't found.

message stringrequired

The resource hasn't found message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "ResourceNotFound",
  "message": "The requested resource could not be found."
}

Loading...