GET https://api.vidyard.com/dashboard/v1/organizations/:organization_id/allotments
Fetches allotment usage and limits for an account

Fetches allotment usage and limits for an account

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Examples

REQUEST
Accept: application/json

RESPONSE
200 (OK)
{
  "govideo_users": {
    "current_usage": 0,
    "limit": 0,
    "grace_limit": 0,
    "enforced": false
  },
  "teams": {
    "current_usage": 2,
    "limit": 2,
    "grace_limit": 1,
    "enforced": false
  }
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String
types
optional

The type of allotment to retrieve. If left blank, returns allotment information for all allotment types.

Validations:

  • Must be an array of any type