API ReferenceReferencePortals
Get a portal
One portal with the groups admitted to it. A portal in another organization is the same 404 as an unknown id. Requires the end_users:read scope.
Authorization
apiKey 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
Format
uuidResponse 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"{ "portal": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "entryKey": "703e8089-3013-4960-b567-726174aed282", "loginRequired": true, "storefrontId": "d65e0431-31e2-4a81-af3f-3878f4cb36fb", "door": "open", "admittedGroupCount": 0, "mcpEnabled": true, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "admissions": [ { "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55", "name": "string", "type": "assigned", "admittedAt": "2019-08-24T14:15:22Z" } ] }}