GET
/
v1
/
users
curl --request GET \
  --url https://api.oneofnone.io/v1/users \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "jsmith@example.com",
      "phone": "<string>",
      "metadata": {},
      "avatar": {
        "alt": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "file_type": "<string>",
        "id": 123,
        "poster_url": "<string>",
        "size": 123,
        "tags": [
          "<string>"
        ],
        "thumbnail_url": "<string>",
        "updated_at": "2023-11-07T05:31:56Z",
        "url": "<string>"
      },
      "app_id": 123,
      "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "last_login_at": "2023-11-07T05:31:56Z",
      "login_count": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "next": "https://api.example.com/users?limit=20&offset=20",
    "prev": "https://api.example.com/users?limit=20&offset=0",
    "limit": 20,
    "offset": 0,
    "total_count": 150,
    "total_pages": 8,
    "current_page": 1
  }
}

Authorizations

​
x-api-key
string
header
required

The API key required for accessing protected routes. It should be included in the request headers as x-api-key.

Query Parameters

​
email
string

Filter users by email address.

​
phone
string

Filter users by phone number.

​
app_id
string

Filter users by app ID.

​
min_login_count
integer

Filter users with login count greater than or equal to this value.

Required range: x >= 1
​
max_login_count
integer

Filter users with login count less than or equal to this value.

Required range: x >= 1
​
min_created_at
string

Filter users created after this date.

​
max_created_at
string

Filter users created before this date.

​
min_last_login_at
string

Filter users who last logged in after this date.

​
max_last_login_at
string

Filter users who last logged in before this date.

​
limit
integer
default:1000

The maximum number of items to return (1-1000).

Required range: 1 <= x <= 1000
​
offset
integer
default:0

The number of items to skip before starting to collect the result set.

Required range: x >= 0
​
order
enum<string>
default:asc

The sort order of the results.

Available options:
asc,
desc
​
order_by
string

The field by which to order the results.

​
include_count
boolean
default:false

If true, returns additional pagination metadata including total count and total pages.

Response

200
application/json

Successfully retrieved users.

The response is of type object.