Skip to main content
GET
/
v1
/
permission-groups
Get Permission Groups
curl --request GET \
  --url https://sandbox-api.borderless.xyz/v1/permission-groups \
  --header 'Authorization: Bearer <token>'
{
  "hasMore": true,
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "dashboardPermissions": [
        "OrganizationApiKeysGenerate"
      ],
      "description": "<string>",
      "dashboardUsers": [
        {
          "id": "<string>",
          "email": "<string>",
          "firstName": "<string>",
          "lastName": "<string>",
          "businessTitle": "<string>",
          "role": "OWNER",
          "deleted": true,
          "deletedAt": "2023-11-07T05:31:56Z",
          "mfaEnabled": true,
          "dashboardPermissions": [
            "OrganizationApiKeysGenerate"
          ]
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

namePrefix
string

Prefix for filtering permission groups by name

startingAfter
string

Id used to retrieve results that come after the specified item.

limit
number

Response page limit. Min 1, Max 100, Default value is 10.

Response

200 - application/json

List of Permission Groups and hasMore flag.

hasMore
boolean
required
data
object[]
required