com.atproto.server.getAccountInviteCodes

GET 
/xrpc/com.atproto.server.getAccountInviteCodes

This endpoint is part of the atproto PDS server and account management APIs. Requests often require authentication and are made directly to the user's own PDS instance.

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

Get all invite codes for the current account. Requires auth.

Request

Query Parameters

includeUsed boolean

Default value: true

createAvailable boolean

Default value: true

Controls whether any new 'earned' but not 'created' invites should be created.

Responses

200

OK

application/json

Schema

Schema

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)

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

400

Bad Request

application/json

Schema

Schema

error stringrequired

Possible values: [InvalidRequest, ExpiredToken, InvalidToken, DuplicateCreate]

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