---
title: "API Scopes API Reference"
description: "The permissions an API token or OAuth grant can hold. Every authenticated endpoint requires exactly one scope, declared on the operation."
canonical: "https://linkbreakers.com/help/api/api-scopes"
---

# API Scopes

The permissions an API token or OAuth grant can hold. Every authenticated endpoint requires exactly one scope, declared on the operation.

## API Scopes

GET

`/v1/api-scopes`

## [#](#list-api-scopes)List API scopes

List every scope an API token or OAuth grant can hold, with the resource it covers and what it allows. Needs no authentication.

### [#](#list-api-scopes-parameters)Parameters

This endpoint does not accept any parameters.

### [#](#list-api-scopes-response)Response

200

Everything worked as expected.

scopes

array<object>

Every scope, ordered by resource then read before write.

### [#](#list-api-scopes-error)Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

object

Required

Wrapped error response.

Example request (cURL)

```bash
curl -X GET "https://api.linkbreakers.com/v1/api-scopes"
```

Typical response

```json
{
  "scopes": [
    {
      "access": "API_SCOPE_ACCESS_UNSPECIFIED",
      "description": "string",
      "name": "links:read",
      "resource": "links",
      "scope": "API_SCOPE_UNSPECIFIED"
    }
  ]
}
```

Base URL: `https://api.linkbreakers.com`

---

Source: https://linkbreakers.com/help/api/api-scopes