Skip to main content
GET
/
v1
/
user
Get user
curl --request GET \
  --url https://api.example.com/v1/user \
  --header 'authorization: <authorization>'
{
  "id": "<string>",
  "email": "<string>",
  "email_verified": true,
  "create_date": "2023-11-07T05:31:56Z",
  "last_update_date": "2023-11-07T05:31:56Z",
  "subscription_type": "FREE",
  "submitter_tags": [
    "<string>"
  ],
  "monitored_brand_ids": [
    "<string>"
  ]
}

Headers

​
authorization
string
required

Response

Successful Response

​
id
string
required

User ID.

​
email
string
required

Primary email address associated with the account.

​
email_verified
boolean
required

Indicates if the user has confirmed their email address.

​
create_date
string<date-time>
required

ISO 8601 timestamp of when the account was created.

​
last_update_date
string<date-time>
required

ISO 8601 timestamp of the last profile modification.

​
subscription_type
enum<string>
required

The current billing tier of the user (FREE or PREMIUM).

Available options:
FREE,
PREMIUM
​
submitter_tags
string[]

Global tags automatically appended to all scans by this user.

​
monitored_brand_ids
string[]

List of internal brand IDs the user is currently monitoring for phishing.