Scopes

List scopes

Changed on

Returns the catalogue of scopes available to API keys. The list is filtered by the Api-Version request header and defaults to the latest version when the header is omitted. Public: no authentication required.

get/v1/scopes

Request

  • Base URL
    https://api.augustus.com
  • URL
    https://api.augustus.com/v1/scopes
  • Auth
    HTTP bearer

Response

Scope catalogue

has_moreboolean required
next_cursorstring nullable required
has_previousboolean required
previous_cursorstring nullable required

Example response

{
  "data": [
    {
      "description": "Grants read access to payouts.",
      "resource": "payouts",
      "available_from": "2026-05-01"
    }
  ],
  "next_cursor": "eyJsYXN0X2lkIjoiNTUwZTg0MDAtZTI5Yi00MWQ0LWE3MTYtNDQ2NjU1NDQwMDA2In0",
  "previous_cursor": "eyJsYXN0X2lkIjoiNTUwZTg0MDAtZTI5Yi00MWQ0LWE3MTYtNDQ2NjU1NDQwMDA2In0"
}

Changes

  • f7ded6c181abRevision changes
    • info

      endpoint added

  • 79d607871de9Revision changes
    • warning

      added the new counterparties:read enum value to the // response property for the response status

    • warning

      added the new counterparties:write enum value to the // response property for the response status

    • warning

      added the new simulations:write enum value to the // response property for the response status