Skip to main content
GET
/
users
List filtered User entities
curl --request GET \
  --url https://app.ledger.ai/api/users \
  --header 'Authorization: Bearer <token>'
{}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
filters
string

Authorization: Bearer <token> header is required for authorization, requests without a valid and active authorization header will be denied access with a 401 Not Authorized HTTP status code.

Query param filters, URL encoded JSON object with fields: about, archived_at, auth0_user_id, contact_preference, contact_times, created_at, data, email, email_verified, family_name, given_name, id, invite_code_expires_at, invite_code, nickname, picture, social_auth_provider, timezone, updated_at, admin_id, customer_id, provider_id

Example:

/api/users?filters={"about": ..., "auth0_user_id": ..., "contact_preference": ..., "contact_times": ..., "data": ..., "email": ..., "family_name": ..., "given_name": ..., "invite_code_expires_at": ..., "invite_code": ..., "nickname": ..., "picture": ..., "social_auth_provider": ..., "timezone": ..., "admin_id": ..., "customer_id": ..., "provider_id": ...}

Response

Successful response

The response is of type object.