Users

The Users API provides a simple interface to your account’s users. The API provides read-only access, where you can retrieve a single user as well as list of all users associated with your account.

When you sign up with Base, we create a single master account and a single user with account management privileges. By logging in as the account manager, you can create as many additional users as you need.

Properties

Attribute Description
id number readonly

Unique identifier of the user.

name string

Full name of the user.

email string

Email address of the user.

status string readonly

Status of the user’s account. Usually active.

Possible values:

  • active
  • inactive
role string readonly

Role of the user.

Possible values:

  • user
  • admin
confirmed boolean readonly

Indicates whether the user’s account has been confirmed or not.

created_at string readonly

Date and time of creation in UTC (ISO8601 format).

updated_at string readonly

Date and time of the last update in UTC (ISO8601 format).

deleted_at string readonly

Date and time of deletion in UTC (ISO8601 format) in case the user has been deleted.


Endpoints


Retrieve all users

Returns all users, according to the parameters provided.

Parameters

Attribute Description
page number optional

Page number to start from. Page numbering starts at 1, and omitting the page parameter will return the first page.

e.g. ?page=2
per_page number optional

Number of records to return per page. The default limit is 25, and the maximum number that can be returned is 100.

e.g. ?per_page=20
sort_by string optional

A field to sort by. The default order is ascending. If you want to change the sort order to descending, append :desc to the field e.g. sort_by=name:desc.

Possible values:

  • id
  • name
  • created_at
  • updated_at
e.g. ?sort_by=created_at
ids string optional

Comma-separated list of user IDs to be returned in a request.

e.g. ?ids=1,2,3
name string optional

Name of the user. This parameter is used in a strict sense.

e.g. ?name=Mark%20Johnson
email string optional

Email of the user. This parameter is used in a strict sense.

e.g. ?email=mark@salesteam.com
role string optional

Role of user to search for.

e.g. ?role=admin
status string optional

Status of user accounts to search for.

Possible values:

  • active
  • inactive
e.g. ?status=active
confirmed boolean optional

Indicator whether to return only confirmed user accounts or not.

e.g. ?confirmed=true

Retrieve a single user

Returns a single user according to the unique user ID provided. If the specified user does not exist, this query returns an error.

Parameters

Attribute Description
id number required

Unique identifier of the user.


Retrieve an authenticating user

Returns a single authenticating user, according to the authentication credentials provided.