---
title: "List the permission catalogue"
description: "Every permission a custom role or an API key permission map can name."
canonical_url: "https://twominutebilling.com/help/developers/api-reference/organization/list-the-permission-catalogue"
---
# List the permission catalogue

> Every permission a custom role or an API key permission map can name.

<api-operation method="GET" path="/v1/permissions">
<template v-slot:docs="">

`members_only` permissions are for signed-in team members; an API key never holds them. `key_resources` lists the resources an API key map may name.

## Response

<table>
<thead>
  <tr>
    <th>
      Field
    </th>
    
    <th>
      Type
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        object
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The object type.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data
      </code>
    </td>
    
    <td>
      <code>
        array of object
      </code>
    </td>
    
    <td>
      The rows on this page.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.object
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The object type.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.key
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The permission's key.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.resource
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The permission's resource.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.mode
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The permission's mode. One of <code>
        read
      </code>
      
      , <code>
        write
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.area
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The permission's area.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.label
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The permission's label.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.members_only
      </code>
    </td>
    
    <td>
      <code>
        boolean
      </code>
    </td>
    
    <td>
      The permission's members only.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        key_resources
      </code>
    </td>
    
    <td>
      <code>
        array of string
      </code>
    </td>
    
    <td>
      The permission's key resources.
    </td>
  </tr>
</tbody>
</table>

## Status codes

<table>
<thead>
  <tr>
    <th>
      Status
    </th>
    
    <th>
      Meaning
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        200
      </code>
    </td>
    
    <td>
      Success
    </td>
  </tr>
</tbody>
</table>
</template>

<template v-slot:request="">

```bash [Request]
curl "$TMBILLING_URL/v1/permissions" \
  -H "Authorization: Bearer $TMBILLING_API_KEY"
```

</template>

<template v-slot:response="">

```json [200 OK]
{
  "object": "list",
  "data": [
    {
      "object": "permission",
      "key": "invoices:void",
      "resource": "invoices",
      "mode": "read",
      "area": "Area",
      "label": "Example"
    }
  ],
  "key_resources": [
    "Key resource"
  ]
}
```

</template>
</api-operation>


## Sitemap

See the full [sitemap](https://twominutebilling.com/sitemap.md) for all pages.