Address GroupsFolder participants

Folder participants

A list of PEOPLE with access to the folder, not grants: user groups are expanded, and the creator (manager) is returned separately.

The via field explains the source of access: direct is a personal grant that can be revoked individually; user_group is a grant issued to a group that can only be removed by leaving it. removable indicates whether the "remove" button is active.

curl -X GET "https://policy-engine-rest.ezig.workers.dev/api/v1/vaults/demo_vault/address-groups/example_string/participants" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "owner": {
    "id": "example_string",
    "name": "John Doe",
    "email": "user@example.com",
    "username": "John Doe",
    "image": "example_string",
    "color": "#000",
    "emoji": "🦊"
  },
  "participants": [
    {
      "userId": "example_string",
      "user": {
        "id": "example_string",
        "name": "John Doe",
        "email": "user@example.com",
        "username": "John Doe",
        "image": "example_string",
        "color": "#000",
        "emoji": "🦊"
      },
      "role": "viewer",
      "via": [
        {}
      ],
      "removable": true
    }
  ],
  "summary": {
    "total": 42
  }
}
GET
/api/v1/vaults/{code}/address-groups/{id}/participants
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Session token. Mobile/services. The web uses a cookie.

Session token. Mobile/services. The web uses a cookie.
API Key (cookie: session_token)
session_tokenstring
Required

API key (sent in cookie)

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Session token. Mobile/services. The web uses a cookie.

path
parameterstring
Required

API Key for authentication. Provide your API key in the cookie.

Path Parameters

codestring
Required

Unique Vault code (slug)

Example:
demo_vault

Responses

ownerstring
Required

The object's owner: for an address, its creator; for a folder, its manager. Not a participant

participantsarray
Required
summaryobject
Required