com.atproto.admin.get Invite Codes
GET {{baseUrl}}/xrpc/com.atproto.admin.getInviteCodes?sort=recent&limit=100&cursor=<string>
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 Params
| Key | Datatype | Required | Description |
|---|---|---|---|
sort | string | ||
limit | number | ||
cursor | string |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"codes":[{"code":"\u003cstring\u003e","available":"\u003cinteger\u003e","disabled":"\u003cboolean\u003e","forAccount":"\u003cstring\u003e","createdBy":"\u003cstring\u003e","createdAt":"\u003cdateTime\u003e","uses":[{"usedBy":"\u003cdid\u003e","usedAt":"\u003cdateTime\u003e"},{"usedBy":"\u003cdid\u003e","usedAt":"\u003cdateTime\u003e"}]},{"code":"\u003cstring\u003e","available":"\u003cinteger\u003e","disabled":"\u003cboolean\u003e","forAccount":"\u003cstring\u003e","createdBy":"\u003cstring\u003e","createdAt":"\u003cdateTime\u003e","uses":[{"usedBy":"\u003cdid\u003e","usedAt":"\u003cdateTime\u003e"},{"usedBy":"\u003cdid\u003e","usedAt":"\u003cdateTime\u003e"}]}],"cursor":"\u003cstring\u003e"}