Skip to main content
GET
/
v1
/
users
/
{id}
Get user
curl --request GET \
  --url https://api.oneofnone.io/v1/users/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "[email protected]",
  "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"
}

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.

Path Parameters

​
id
string
required

The ID or email address of the user to fetch.

Query Parameters

​
type
enum<string>
default:ID

Specify whether to query by ID or EMAIL. Defaults to ID if not provided.

Available options:
ID,
EMAIL

Response

Successfully retrieved user.

A user account within the application system, containing profile information and activity tracking.

​
id
string<uuid>

The unique identifier for the user.

​
email
string<email> | null

The user's email address.

​
phone
string | null

The user's phone number.

​
metadata
object

Additional user metadata and custom fields collected during registration or profile updates.

​
avatar
object

The user's profile avatar image. Note that only the url field is populated in user responses.

​
app_id
integer | null

The unique identifier of the app the user is associated with.

​
team_id
string<uuid> | null

The unique identifier of the team the user belongs to.

​
last_login_at
string<date-time> | null

The timestamp of the user's last login.

​
login_count
integer | null

The total number of times the user has logged in.

​
created_at
string<date-time>

The timestamp when the user account was created.

​
updated_at
string<date-time> | null

The timestamp when the user account was last updated.