Accounts

List Quotas

Changed on
get/accounts/{name}/quotas

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • API key in header x-pollination-token

Path parameters

namestring required

Query parameters

typeQuotaType[]

The types of quotas to get

exhaustedboolean

Whether to return only quotas which are exhausted

enforcedboolean

Whether to return only quotas which are enforced

pageinteger

Page number starting from 1

per-pageinteger

Number of items per page

Response

Retrieved

typestring

A base class to use when there is no baseclass available to fall on.

pageinteger required

The current page the pagination request is on

per_pageinteger required

The number of pages per pagination request

page_countinteger required

The total number of pages

total_countinteger required

The total number of resources matching the list request

next_pageinteger

The next page, if this on is not the last

Example response

{
  "resources": [
    {
      "owner": {
        "id": "0ad77f99-8043-46e4-8220-7221487c3ee5",
        "account_type": "user",
        "name": "ladybugbot",
        "display_name": "Ladybug Bot",
        "description": "Beep Boop!"
      }
    }
  ]
}

Changes

  • e25504ef9dccRevision changes
    • breaking

      response property detail/items/loc/items/ list-of-types was widened by adding types integer to media type application/json of response 422

    • warning

      added the new runs_per_study enum value to the ///// response property for the response status

    • info

      added the enum value runs_per_study to the property items/ of the query request parameter type

  • be42c3cf5190Revision changes
    • info

      endpoint added