TradlyTRADLY-API.

Parameters

page
number
Required
Description
Page number for pagination. Must be an integer greater than 0.
per_page
number
Description
Number of records to return per page (between 1 and 100). Default is 30.
search_key
string
Description
Search keyword matching against user's first name, last name, email, or mobile number.
type
string
Description
Filter by user role types. Supports a comma-separated list of types (e.g. `buyer,seller`, `customer`).
user_type
string
Description
Filter by user classification: `customer` (users without an account) or `account` (users who own an account).
created_from
string
Description
Filter users created on or after this ISO-8601 UTC timestamp (e.g. `2024-01-01T00:00:00Z`).
created_to
string
Description
Filter users created on or before this ISO-8601 UTC timestamp (e.g. `2024-12-31T23:59:59Z`).
sort
string
Description
Sort order by user creation date: `newest_first` (default) or `oldest_first`.
ids
string
Description
Comma-separated list of user unique IDs (UUIDs) to retrieve specific users (e.g. `usr_1,usr_2`).
status
string
Description
Filter by account status: `1` for active, `2` for inactive, or `1,2` for both. Defaults to `1` (active only).
include_attributes
string
Description
Set to `true` or `1` to populate custom user profile attributes in the response.
GET/v1/users
curl https://api.tradly.app/v1/users \
  -H "Authorization: Bearer YOUR_PUBLISHABLE_OR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
RESPONSE
{
  "status": true,
  "data": {
    "total_records": 42,
    "page": 1,
    "users": [
      {
        "id": "692ee113-310b-4e66-b5b5-33796f9616e3",
        "first_name": "Charles",
        "last_name": "Pearson",
        "email": "charles.pearson@example.com",
        "profile_pic": "https://media.tradly.app/images/marketplace/1000/avatar.png",
        "email_verified": true,
        "email_bounced": false,
        "email_complained": false,
        "mobile": "5551234567",
        "dial_code": "1",
        "type": [
          "buyer",
          "customer"
        ],
        "metadata": {
          "tier": "gold"
        },
        "locale": "en",
        "status": 1,
        "otp_enabled": false,
        "following_count": 5,
        "is_following_user": false,
        "created_at": 1723068000,
        "updated_at": 1723068000,
        "lastlogin_at": 1723068000
      }
    ]
  }
}