Clerk · Example Payload

Clerk Platform Api Platformlistinstanceusers 200

AuthenticationAuthorizationB2B SaaSCIAMIdentity ManagementMFAOAuthOpenID ConnectOrganizationsPasskeysSAMLSecuritySessionsSSOUser Management

Clerk Platform Api Platformlistinstanceusers 200 is an example object payload from Clerk, with 7 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

apioperationmethodpathsummaryresponse_statusresponse

Example Payload

Raw ↑ 
{
  "api": "clerk-platform-api",
  "operation": "PlatformListInstanceUsers",
  "method": "GET",
  "path": "/platform/applications/{applicationID}/instances/{envOrInsID}/users",
  "summary": "List Instance Users",
  "response_status": "200",
  "response": {
    "data": [
      {
        "id": "id_2abc4xyz567Q9zZ",
        "object": "user",
        "external_id": "external_2abc4xyz567Q9zZ",
        "primary_email_address_id": "primary-email-address_2abc4xyz567Q9zZ",
        "primary_phone_number_id": "primary-phone-number_2abc4xyz567Q9zZ",
        "primary_web3_wallet_id": "primary-web3-wallet_2abc4xyz567Q9zZ",
        "username": "example_string",
        "first_name": "example_string",
        "last_name": "example_string",
        "locale": "example_string",
        "profile_image_url": "example_string",
        "image_url": "example_string",
        "has_image": false,
        "public_metadata": {},
        "private_metadata": {},
        "unsafe_metadata": {},
        "email_addresses": [],
        "phone_numbers": [],
        "web3_wallets": [],
        "passkeys": [],
        "password_enabled": false,
        "two_factor_enabled": false,
        "totp_enabled": false,
        "backup_code_enabled": false,
        "mfa_enabled_at": 0,
        "mfa_disabled_at": 0,
        "password_last_updated_at": 0,
        "external_accounts": [],
        "saml_accounts": [],
        "enterprise_accounts": [],
        "organization_memberships": [],
        "last_sign_in_at": 0,
        "banned": false,
        "locked": false,
        "deprovisioned": false,
        "lockout_expires_in_seconds": 0,
        "verification_attempts_remaining": 0,
        "updated_at": 0,
        "created_at": 0,
        "delete_self_enabled": false,
        "create_organization_enabled": false,
        "create_organizations_limit": 0,
        "last_active_at": 1700690400000,
        "legal_accepted_at": 1700690400000,
        "bypass_client_trust": false,
        "scim": {}
      }
    ],
    "total_count": 100
  }
}