API Reference

Branch Memberships

4 endpoints· Auth: JWT or API Key
get/api/v1/console/users/{userId}/memberships JWT API Key

Get memberships

Path parameters

userIdrequired
string (uuid)
—

Query parameters

include_revoked
boolean
—
Sort
string
—
Dir
string
—

Responses

200Success
cURL
curl -X GET "https://staging-api.panoptesos.com/api/v1/console/users/{userId}/memberships" \
  -H "X-Api-Key: <YOUR_API_KEY>"
Try itagainst staging · https://staging-api.panoptesos.com

Path parameters

Query parameters

Set credentials in the “Authorize” menu
post/api/v1/console/users/{userId}/memberships JWT API Key

Create memberships

Path parameters

userIdrequired
string (uuid)
—

Request body

application/json
{
  "branchId": "00000000-0000-0000-0000-000000000000",
  "roleId": "00000000-0000-0000-0000-000000000000"
}
branchId
string (uuid)
—
roleId
string (uuid)
—

Responses

200Success
cURL
curl -X POST "https://staging-api.panoptesos.com/api/v1/console/users/{userId}/memberships" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: <YOUR_API_KEY>" \
  -d '{
  "branchId": "00000000-0000-0000-0000-000000000000",
  "roleId": "00000000-0000-0000-0000-000000000000"
}'
Try itagainst staging · https://staging-api.panoptesos.com

Path parameters

Request body (JSON)

Set credentials in the “Authorize” menu
delete/api/v1/console/users/{userId}/memberships/{branchId} JWT API Key

Delete branchId

Path parameters

userIdrequired
string (uuid)
—
branchIdrequired
string (uuid)
—

Request body

application/json
{
  "reason": "string"
}
reason
string
—

Responses

200Success
cURL
curl -X DELETE "https://staging-api.panoptesos.com/api/v1/console/users/{userId}/memberships/{branchId}" \
  -H "X-Api-Key: <YOUR_API_KEY>"
Try itagainst staging · https://staging-api.panoptesos.com

Path parameters

Set credentials in the “Authorize” menu
patch/api/v1/console/users/{userId}/org-admin JWT API Key

Update org-admin

Path parameters

userIdrequired
string (uuid)
—

Request body

application/json
{
  "isOrgAdmin": false,
  "reason": "string"
}
isOrgAdmin
boolean
—
reason
string
—

Responses

200Success
cURL
curl -X PATCH "https://staging-api.panoptesos.com/api/v1/console/users/{userId}/org-admin" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: <YOUR_API_KEY>" \
  -d '{
  "isOrgAdmin": false,
  "reason": "string"
}'
Try itagainst staging · https://staging-api.panoptesos.com

Path parameters

Request body (JSON)

Set credentials in the “Authorize” menu