> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.caresquareapi.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.caresquareapi.com/_mcp/server.

# List permissions

GET https://api.caresquareapi.com/api/public/v1/permissions

Catalogue of team-member permissions that can be granted. Use the `name` slugs (e.g. view_budget) when adding or updating team members. Requires X-Plan-Manager-Id header.

Reference: https://docs.caresquareapi.com/api-reference/lookups/permissions/list-permissions

## Authentication

- `Authorization` header (bearer token, required) — API key issued for your account. Send as Bearer token in the Authorization header.
- `X-Plan-Manager-Id` header (required) — Plan manager UUID. Required on all public API requests to scope data access.

## Request

### Query parameters

- `limit` (integer, optional, default: 20) — Items per page (max 1000)
- `offset` (integer, optional, default: 0) — Number of items to skip. Cannot be combined with after.
- `after` (string, optional) — Keyset cursor. Returns records after this id (or error_code for the error catalogue), ordered by that field ascending. Pass pagination.next_cursor from the previous page. Start a cursor walk with after=0. Cannot be combined with a non-zero offset.

## Response

### 200

List of permissions

- `data` (list of PermissionResponse, required)
- `pagination` (PaginationMeta, required)

## Errors

### 400 Bad Request Error

Invalid request parameters

- `success` (boolean, optional)
- `error` (string, optional) — Error type or code
- `detail` (string, optional) — Human-readable error message

### 403 Forbidden Error

Access denied for plan manager

- `success` (boolean, optional)
- `error` (string, optional) — Error type or code
- `detail` (string, optional) — Human-readable error message

### 500 Internal Server Error

Internal server error

- `success` (boolean, optional)
- `error` (string, optional) — Error type or code
- `detail` (string, optional) — Human-readable error message

## Types

### PermissionResponse

A grantable team-member permission.

- `id` (string, optional) — Permission UUID
- `name` (string, optional) — Stable slug used in create/update payloads (e.g. view_budget, view_invoices, approve_invoices, email_statements, view_documents, no_access)
- `label` (string, optional) — Friendly display name
- `order` (integer, optional) — Display order

### PaginationMeta

- `limit` (integer, required) — Maximum number of items per page
- `offset` (integer, required) — Number of items skipped
- `has_more` (boolean, required) — Whether there are more items after this page
- `total` (integer, optional, nullable) — Total matching items. Null for cursor pagination, which skips a full-table count.
- `next_cursor` (string, optional, nullable) — Pass as `after` to fetch the next page. Set when using cursor pagination and has_more is true.

## Examples

**Response**

```json
{
  "data": [
    {
      "id": "string",
      "name": "string",
      "label": "string",
      "order": 1
    }
  ],
  "pagination": {
    "limit": 1,
    "offset": 1,
    "has_more": true,
    "total": 1,
    "next_cursor": "string"
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.caresquareapi.com/api/public/v1/permissions"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.caresquareapi.com/api/public/v1/permissions';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.caresquareapi.com/api/public/v1/permissions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.caresquareapi.com/api/public/v1/permissions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.caresquareapi.com/api/public/v1/permissions")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.caresquareapi.com/api/public/v1/permissions', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.caresquareapi.com/api/public/v1/permissions");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.caresquareapi.com/api/public/v1/permissions")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```