com.atproto.admin.getInviteCodes

Get an admin view of invite codes.

class atproto_client.models.com.atproto.admin.get_invite_codes.Params

Bases: ParamsModelBase

Parameters model for com.atproto.admin.getInviteCodes.

field cursor: str | None = None

Cursor.

field limit: int | None = None

Limit.

Constraints:

• ge = 1

• le = 500

field sort: Literal['recent', 'usage'] | str | None = 'recent'

Sort.

class atproto_client.models.com.atproto.admin.get_invite_codes.ParamsDict

Bases: TypedDict

cursor: NotRequired[str | None]

Cursor.

limit: NotRequired[int | None]

Limit.

sort: NotRequired[Literal['recent', 'usage'] | str | None]

Sort.

class atproto_client.models.com.atproto.admin.get_invite_codes.Response

Bases: ResponseModelBase

Output data model for com.atproto.admin.getInviteCodes.

field codes: List[models.ComAtprotoServerDefs.InviteCode] [Required]

Codes.

field cursor: str | None = None

Cursor.