com.atproto.admin.searchAccounts

GET 
/xrpc/com.atproto.admin.searchAccounts

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 list of accounts that matches your search query.

Request

Query Parameters

email string
cursor string
limit integer

Possible values: >= 1 and <= 100

Default value: 50

Responses

200

OK

application/json

Schema

Schema

cursor string

accounts

object[]

required

Array [

did didrequired

handle handlerequired

email string

relatedRecords undefined[]

indexedAt date-timerequired

invitedBy

object

code stringrequired

available integerrequired

disabled booleanrequired

forAccount stringrequired

createdBy stringrequired

createdAt date-timerequired

uses

object[]

required

Array [

usedBy didrequired

usedAt date-timerequired

]

invites

object[]

Array [

code stringrequired

available integerrequired

disabled booleanrequired

forAccount stringrequired

createdBy stringrequired

createdAt date-timerequired

uses

object[]

required

Array [

usedBy didrequired

usedAt date-timerequired

]

]

invitesDisabled boolean

emailConfirmedAt date-time

inviteNote string

deactivatedAt date-time

threatSignatures

object[]

Array [

property stringrequired

value stringrequired

]

]

Example (from schema)

{
  "cursor": "string",
  "accounts": [
    {
      "did": "string",
      "handle": "string",
      "email": "string",
      "relatedRecords": [
        null
      ],
      "indexedAt": "2024-11-07T00:27:32.060Z",
      "invitedBy": {
        "code": "string",
        "available": 0,
        "disabled": true,
        "forAccount": "string",
        "createdBy": "string",
        "createdAt": "2024-11-07T00:27:32.060Z",
        "uses": [
          {
            "usedBy": "string",
            "usedAt": "2024-11-07T00:27:32.060Z"
          }
        ]
      },
      "invites": [
        {
          "code": "string",
          "available": 0,
          "disabled": true,
          "forAccount": "string",
          "createdBy": "string",
          "createdAt": "2024-11-07T00:27:32.060Z",
          "uses": [
            {
              "usedBy": "string",
              "usedAt": "2024-11-07T00:27:32.061Z"
            }
          ]
        }
      ],
      "invitesDisabled": true,
      "emailConfirmedAt": "2024-11-07T00:27:32.061Z",
      "inviteNote": "string",
      "deactivatedAt": "2024-11-07T00:27:32.061Z",
      "threatSignatures": [
        {
          "property": "string",
          "value": "string"
        }
      ]
    }
  ]
}

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