Skip to main content
POST
/
core.v1.PermissionsService
/
ListPermissions
cURL
curl -X POST "https://api.joinformal.com/core.v1.PermissionsService/ListPermissions" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "example": "value"
  }'
{
  "permissions": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "code": "<string>",
      "status": "draft",
      "terminationProtection": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "listMetadata": {
    "after": "<string>",
    "before": "<string>",
    "count": 123,
    "nextCursor": "<string>"
  }
}

Authorizations

X-API-KEY
string
header
required

API key authentication. Get your API key from the Formal console.

Headers

Connect-Protocol-Version
enum<number>
required

Define the version of the Connect protocol

Available options:
1
Connect-Timeout-Ms
number

Define the timeout, in ms

Body

application/json
limit
integer<int32>
Required range: x <= 500
cursor
string
order
string
searchFields
enum<string>[]
Available options:
id,
name,
description,
status
filter
filter · object

Response

Success

permissions
Permission · object[]
listMetadata
list_metadata · object