CentralCSP
APIUsage

List workspace usage-alert recipients

Returns the members emailed when the workspace passes 80% of its plan limit and again when it reaches 100%. Each threshold sends at most one email per period.

Requires the admin role on the workspace.

GET
/v1/workspaces/{workspaceId}/usage-alerts/recipients

Authorization

headerAuthorizationBearer <JWT>

An OpenID Connect access token from signing in to CentralCSP, acting as the signed-in user.

Path Parameters

workspaceId*string

The workspace's id.

Response Body

Who is emailed as usage approaches the limit.

application/json
  1. response
recipients*array<>

Members on the list. An empty array means nobody is emailed.

Example Request
curl -X GET 'https://api.centralcsp.com/v1/workspaces/01936b7a-6f2e-7c31-9a4d-2f8e1c5b7d90/usage-alerts/recipients'
Example Response
{  "recipients": [    {      "memberId": "string",      "hasAccess": true,      "email": "string",      "firstName": "string",      "lastName": "string"    }  ]}

Set a website usage limit PUT

Caps how many reports this website may accept per period. Send null to remove the cap. The limit cannot be higher than the workspace plan limit.

Set workspace usage-alert recipients PUT

Replaces the recipient list. Send an empty array to turn workspace usage emails off. Every id must belong to a member of this workspace.