API Reference/Notifications

Notifications

For authentication instructions, see API overview.

Endpoints

get/api/v2/notifications

get/api/v2/notifications/find

put/api/v2/app-notifications

get/api/v2/app-notifications/:id

put/api/v2/app-notifications/:id

get

List all notifications

Returns a list of notifications. The notifications are returned in sorted order, with the most recent appearing first.

Request

cURL

export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/notifications

Response

No response schema

get

Retrieve notifications

Returns a single notification, which you can request by passing through an id in the url.

Query parameters

modelstring
Model of the notification

Request

cURL

export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/notifications/find

Response

No response schema

put

Update read app

Request

cURL

export ICLOUDREADY_API_KEY=[your api key]
curl -X PUT \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/app-notifications

Response

No response schema

get

Retrieve app notifications

Returns a single app notification, which you can request by passing through an id in the url.

Path parameters

idstring
ID of the notification

Request

cURL

export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/app-notifications/:id

Response

No response schema

put

Update app notifications

Path parameters

idstring
ID of the notification

Request

cURL

export ICLOUDREADY_API_KEY=[your api key]
curl -X PUT \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/app-notifications/:id

Response

No response schema