GET
/api/admin/invite-codesAdminList invite codes
Lists every registration invite code with its usage limit and creator.
operationId
get_api_admin_invite_codesAdministrationAuthentication & permissionsAdmin
Platform administrators only
- Accepted credentials
- Auth server session (refresh token cookie)
cookie "refresh_token_<auth_server_app_id>" - Access token (cookie)
cookie "access_token_<auth_server_app_id>" - Access token (Bearer)
Authorization: Bearer <JWT>
- Auth server session (refresh token cookie)
- Who may call
- Platform administrators only
Responses
application/json
| Property | Type | Description |
|---|---|---|
| success* | true | |
| message* | string | |
| data* | object | |
| invite_codes* | InviteCodeDefinition[] | |
| invite_code* | string | minLength: 8maxLength: 64pattern: ^[A-Za-z0-9_-]+$ |
| created_at* | number | minimum: 0 |
| max_uses* | integer | exclusiveMinimum: 0 |
| description | string | maxLength: 128 |
| created_by | string (uuid) |
JSONExample
"success"true
"message""string"
"data"
"invite_codes"
Example request
bashcurl
curl -X GET 'https://auth.schemavaults.com/api/admin/invite-codes' \
-b 'refresh_token_<auth_server_app_id>=<value>'