Skip to main content
GET
/
users
/
{id}
Get a user
curl --request GET \
  --url https://api.smokeball.com/users/{id} \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "userId": "23d2a4bc-8529-462e-8560-dfbf4fa24e49",
  "email": "user@domain.com",
  "isInternal": true,
  "bypassMfa": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.smokeball.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

ā€‹
x-api-key
string
header
required
ā€‹
Authorization
string
header
required

Path Parameters

ā€‹
id
string<uuid>
required

Response

When request is successful. Returns a 'User' object.

ā€‹
id
string | null
ā€‹
href
string | null
ā€‹
relation
string | null
ā€‹
method
string | null
default:GET
ā€‹
self
object
ā€‹
userId
string | null

Unique identifier of the user.

Example:

"23d2a4bc-8529-462e-8560-dfbf4fa24e49"

ā€‹
email
string | null

Email address of the user.

Example:

"user@domain.com"

ā€‹
isInternal
boolean

Returns true if the user is flagged as an internal user.

Example:

true

ā€‹
bypassMfa
boolean

Returns true if multi-factor authentication is bypassed for the user.

Example:

true