For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Docs API Reference Learn Community Changelog

Docs API Reference Learn Community Changelog

- About Our APIs
REST
GraphQL
MCP

GraphQL B2B Queries

companyPermissions

Example Query

1 query ExampleQuery {
2   companyPermissions {
3     id
4     name
5     description
6     isCustom
7     code
8     moduleName
9   }
10 }

Example response

1 {
2   "data": {
3     "companyPermissions": [
4       {
5         "id": "example",
6         "name": "example",
7         "description": "example",
8         "isCustom": true,
9         "code": "example",
10         "moduleName": "example"
11       }
12     ]
13   }
14 }

Get all company permissions. Requires a B2B Token.

Was this page helpful?

companyRole

accountSettings

Returns

an optional list of optional CompanyPermissionsType

idString

ID of the permission

nameString

Permissions name

descriptionString

Permissions description

isCustomBoolean

Whether the permission is custom

codeString

Permissions code

moduleNameString

The name of the module to which the permission belongs