com.atproto.admin.getInviteCodes

GET 
/xrpc/com.atproto.admin.getInviteCodes

This endpoint is part of the atproto PDS management APIs. Requests usually require admin authentication and are made directly to the PDS instance.

To learn more about calling atproto API endpoints like this one, see the API Hosts and Auth guide.

Get an admin view of invite codes.

Request

Query Parameters

sort string

Possible values: [recent, usage]

Default value: recent

limit integer

Possible values: >= 1 and <= 500

Default value: 100

cursor string

Responses

200

OK

application/json

Schema

Schema

cursor string

codes

object[]

required

Array [

code stringrequired

available integerrequired

disabled booleanrequired

forAccount stringrequired

createdBy stringrequired

createdAt date-timerequired

uses

object[]

required

Array [

usedBy didrequired

usedAt date-timerequired

]

]

Example (from schema)

{
  "cursor": "string",
  "codes": [
    {
      "code": "string",
      "available": 0,
      "disabled": true,
      "forAccount": "string",
      "createdBy": "string",
      "createdAt": "2024-11-04T00:29:30.204Z",
      "uses": [
        {
          "usedBy": "string",
          "usedAt": "2024-11-04T00:29:30.204Z"
        }
      ]
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

error stringrequired

Possible values: [InvalidRequest, ExpiredToken, InvalidToken]

message stringrequired

Example (from schema)

{
  "error": "InvalidRequest",
  "message": "string"
}

401

Unauthorized

application/json

Schema

Schema

error required
message stringrequired

Example (from schema)

{
  "message": "string"
}

Loading...