curl --request POST \
  --url https://api.turnkey.com/public/v1/query/list_users \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <YOUR_API_KEY.YOUR_API_SECRET>" \
  --data '{
    "organizationId": "<string>"
}'
{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_UNKNOWN_V1",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g., 1745474677464)",
    "result": {
      "users": [
        {
          "userId": "<string>",
          "userName": "<string>",
          "userEmail": "<string>",
          "userPhoneNumber": "<string>",
          "authenticators": [
            {
              "transports": [
                "<AUTHENTICATOR_TRANSPORT_BLE>"
              ],
              "attestationType": "<string>",
              "aaguid": "<string>",
              "credentialId": "<string>",
              "model": "<string>",
              "credential": {
                "publicKey": "<string>",
                "type": "<CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR>"
              },
              "authenticatorId": "<string>",
              "authenticatorName": "<string>",
              "createdAt": {
                "seconds": "<string>",
                "nanos": "<string>"
              },
              "updatedAt": {
                "seconds": "<string>",
                "nanos": "<string>"
              }
            }
          ],
          "apiKeys": [
            {
              "credential": {
                "publicKey": "<string>",
                "type": "<CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR>"
              },
              "apiKeyId": "<string>",
              "apiKeyName": "<string>",
              "createdAt": {
                "seconds": "<string>",
                "nanos": "<string>"
              },
              "updatedAt": {
                "seconds": "<string>",
                "nanos": "<string>"
              },
              "expirationSeconds": "<string>"
            }
          ],
          "userTags": [
            "<string_element>"
          ],
          "oauthProviders": [
            {
              "providerId": "<string>",
              "providerName": "<string>",
              "issuer": "<string>",
              "audience": "<string>",
              "subject": "<string>",
              "createdAt": {
                "seconds": "<string>",
                "nanos": "<string>"
              },
              "updatedAt": {
                "seconds": "<string>",
                "nanos": "<string>"
              }
            }
          ],
          "createdAt": {
            "seconds": "<string>",
            "nanos": "<string>"
          },
          "updatedAt": {
            "seconds": "<string>",
            "nanos": "<string>"
          }
        }
      ]
    }
  }
}
POST
/
public
/
v1
/
query
/
list_users

Authorizations

X-Stamp
string
header
required

Body

organizationId
string
required

Unique identifier for a given Organization.

Response

A successful response returns the following fields:

users
array
required

A list of Users.

curl --request POST \
  --url https://api.turnkey.com/public/v1/query/list_users \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <YOUR_API_KEY.YOUR_API_SECRET>" \
  --data '{
    "organizationId": "<string>"
}'
{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_UNKNOWN_V1",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g., 1745474677464)",
    "result": {
      "users": [
        {
          "userId": "<string>",
          "userName": "<string>",
          "userEmail": "<string>",
          "userPhoneNumber": "<string>",
          "authenticators": [
            {
              "transports": [
                "<AUTHENTICATOR_TRANSPORT_BLE>"
              ],
              "attestationType": "<string>",
              "aaguid": "<string>",
              "credentialId": "<string>",
              "model": "<string>",
              "credential": {
                "publicKey": "<string>",
                "type": "<CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR>"
              },
              "authenticatorId": "<string>",
              "authenticatorName": "<string>",
              "createdAt": {
                "seconds": "<string>",
                "nanos": "<string>"
              },
              "updatedAt": {
                "seconds": "<string>",
                "nanos": "<string>"
              }
            }
          ],
          "apiKeys": [
            {
              "credential": {
                "publicKey": "<string>",
                "type": "<CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR>"
              },
              "apiKeyId": "<string>",
              "apiKeyName": "<string>",
              "createdAt": {
                "seconds": "<string>",
                "nanos": "<string>"
              },
              "updatedAt": {
                "seconds": "<string>",
                "nanos": "<string>"
              },
              "expirationSeconds": "<string>"
            }
          ],
          "userTags": [
            "<string_element>"
          ],
          "oauthProviders": [
            {
              "providerId": "<string>",
              "providerName": "<string>",
              "issuer": "<string>",
              "audience": "<string>",
              "subject": "<string>",
              "createdAt": {
                "seconds": "<string>",
                "nanos": "<string>"
              },
              "updatedAt": {
                "seconds": "<string>",
                "nanos": "<string>"
              }
            }
          ],
          "createdAt": {
            "seconds": "<string>",
            "nanos": "<string>"
          },
          "updatedAt": {
            "seconds": "<string>",
            "nanos": "<string>"
          }
        }
      ]
    }
  }
}