com.atproto.admin.getInviteCodes

GET 
/com.atproto.admin.getInviteCodes

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-09-11T00:26:20.063Z",
      "uses": [
        {
          "usedBy": "string",
          "usedAt": "2024-09-11T00:26:20.063Z"
        }
      ]
    }
  ]
}

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...