/api/permissions

GET /api/permissions/invite-group-ids

Changed on

IDs of the permission groups holding a stored read (or read-write) grant on the collection of a shareable item (a dashboard or a question). The "invite someone to view" group picker lists all groups and uses these ids to mark the ones whose members can already see the item; the Administrators group has implicit access to everything and is never included. The Data Analysts group is omitted unless advanced-permissions is enabled. The ids are otherwise unfiltered. Superuser-only, like the invite action itself.

get/api/permissions/invite-group-ids

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header X-API-Key

Query parameters

type'dashboard' | 'question' required
idinteger required

value must be an integer greater than zero.

Response

Successful response

integer[] required

Changes