Skip to content
em sa em sa

List Invite Codes

GET
/api/superadmin/invite-codes
 
curl --request GET \
  --url 'https://example.com/api/superadmin/invite-codes?include_inactive=false&offset=0&limit=50' \
  --header 'Authorization: Bearer <token>'

List invite codes (active only by default).

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
include_inactive
Include Inactive
boolean
offset
Offset
integer
0
limit
Limit
integer
default: 50 >= 1 <= 200

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
InviteCodeListResponse
object
codes
required
Codes
Array<object>
InviteCodeResponse
object
id
required
Id
string
code
required
Code
string
description
Any of:
string
created_by
required
Created By
string
max_uses
Any of:
integer
uses_count
required
Uses Count
integer
expires_at
Any of:
string
org_id
Any of:
string
role
required
Role
string
is_active
required
Is Active
boolean
created_at
Any of:
string
total
required
Total
integer
Example generated
{
  "codes": [
    {
      "id": "example",
      "code": "example",
      "description": "example",
      "created_by": "example",
      "max_uses": 1,
      "uses_count": 1,
      "expires_at": "example",
      "org_id": "example",
      "role": "example",
      "is_active": true,
      "created_at": "example"
    }
  ],
  "total": 1
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}