API Reference

/v1/whoami

Retrieves the authenticated user's details including first name, last name, whether they are a partner, and the companies they are associated with

Log in to see full request history
Query Params
integer
Defaults to 1

The page number to retrieve.

integer
Defaults to 10

The number of records to retrieve per page.

Responses

Response body
object
boolean

Indicates if the user is a partner.

string

The user's first name.

string

The user's last name.

companies
array of objects

A paginated list of companies the user is associated with.

companies
object
string

The company ID.

string

The company name.

pagination
object

Pagination details.

integer

Total number of companies.

integer

The current page number.

integer

Total number of pages.

integer

Number of records per page.

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json