Skip to main content
GET
/
frontend
/
api
/
v1
/
user
/
{user-id}
Get user by id
curl --request GET \
  --url https://{host}/frontend/api/v1/user/{user-id} \
  --header 'Authorization: Bearer <token>'
{
  "id": 1,
  "additional-emails": [
    "<string>"
  ],
  "avatars": {},
  "created": "2023-11-07T05:31:56Z",
  "email": "<string>",
  "first-name": "<string>",
  "last-name": "<string>",
  "parent": {
    "id": 1,
    "email": "<string>",
    "username": "<string>"
  },
  "parent-user-ids": [
    1
  ],
  "permissions": {},
  "plan": {
    "active": true,
    "amount": {
      "fixed": 123,
      "max": 123,
      "min": 123,
      "preset": 123,
      "tiers": [
        123
      ]
    },
    "created": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "details": {},
    "id": "<string>",
    "name": "<string>",
    "stripe-price": "<unknown>"
  },
  "restrictions": {},
  "root-user-id": 1,
  "stripe_customer_id": "<string>",
  "updated": "2023-11-07T05:31:56Z",
  "username": "<string>"
}

Authorizations

​
Authorization
string
header
required

API Key Security (Header).

Path Parameters

​
user-id
integer
required

User ID.

Required range: x >= 1

Response

OK

​
id
integer
required
Required range: x >= 0
​
additional-emails
string[] | null
​
avatars
object
​
created
string<date-time>
​
email
string
Example:

"theUser@probe.dev"

​
first-name
string
Example:

"J"

​
last-name
string
Example:

"Doe"

​
parent
object
​
parent-user-ids
integer[] | null
Required range: x >= 0
​
permissions
object
​
plan
object
​
restrictions
object
​
role
enum<string>
Available options:
root,
admin,
user,
sub
​
root-user-id
integer
Required range: x >= 0
​
status
enum<string>
Available options:
anonymous,
pending,
active,
suspended
​
stripe_customer_id
string
​
updated
string<date-time>
​
username
string
Example:

"theUser"