Docs
API ReferenceReferencePortals

List admitted groups

GET
/portals/{portalId}/admissions

The groups admitted at this portal, oldest first. Admissions matter only while no storefront is attached: with one, any signed-in identity is admitted. Requires the end_users:read scope.

AuthorizationBearer <token>

An organization API key, created from a Portal's Webhooks page (Provisioning API card). The secret is shown once at creation and stored only as a hash. Keys are organization-wide and carry scopes (end_users:read, end_users:write). Rate limit: 120 requests per minute per key (sliding 60-second window).

In: header

Path Parameters

portalId*string
Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/portals/497f6eca-6276-4993-bfeb-53cbbbba6f08/admissions"
{  "admissions": [    {      "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",      "name": "string",      "type": "assigned",      "admittedAt": "2019-08-24T14:15:22Z"    }  ]}