/permissions

GET /permissions

Get all permissions for the current account

Retrieves a list of all available permissions in the system for the current account

Authentication Required

Authorization: Bearer {token} header string

This header is required to access this endpoint

Optional Parameters

Click here to view an exhaustive list of all available parameters

x-account-id header string

The account ID for the request

Try it out

Output:

Responses

Description

Permissions retrieved successfully

[
  {
    "id": 0,
    "permission": "string",
    "description": "string",
    "category": "string"
  }
]

Description

Unauthorized - not authenticated

{
  "error": "string",
  "status": 0
}

Description

Forbidden - user does not have required permissions

{
  "error": "string",
  "status": 0
}

Description

Internal server error

{
  "error": "string",
  "status": 0
}

References

#/components/parameters/xAccountIdHeader #/components/schemas/Permission #/components/schemas/Error

in: header
name: x-account-id
schema:
  type: string
description: The account ID for the request
required: false

|
export type xAccountIdHeader = any; // Schema type not fully supported

#/components/schemas/Permission

OpenAPI
TypeScript

type: object
properties:
  id:
    type: integer
    description: Unique identifier for the permission
  permission:
    type: string
    description: Permission name/code
  description:
    type: string
    description: Human-readable description of what the permission allows
  category:
    type: string
    description: Category or group the permission belongs to

|
export interface Permission {
  /** Unique identifier for the permission */
  id?: number;
  /** Permission name/code */
  permission?: string;
  /** Human-readable description of what the permission allows */
  description?: string;
  /** Category or group the permission belongs to */
  category?: string;
}

#/components/schemas/Error

OpenAPI
TypeScript

type: object
properties:
  error:
    type: string
    description: Error message
  status:
    type: integer
    description: HTTP status code
description: Error response object

|
export interface Error {
  /** Error message */
  error?: string;
  /** HTTP status code */
  status?: number;
}

Route Source Code

Check out the source code for this route entrypoint here: /permissions/route.ts

Or the swagger.yaml spec this documentation was generated from: /permissions/swagger.yaml