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 Sell, 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
invited boolean readonly	Indicates whether an invitation has been sent to the user or not. Usually `true`.
confirmed boolean readonly	Indicates whether the user’s account has been confirmed or not.
phone_number string	Contact phone number of the user.
role string readonly	Role of the user. Notice that this attribute has no connection with role based access control and permissions. It indicates whether the user is an admin or a regular user. Possible values: user admin
roles array	An array of roles assigned to the user. Each entry in the array includes a unique identifier of the role and it’s name. You can expect unique values in the array. RBAC API is not yet public.
team_name string readonly	Name of the team the user belongs to.
group object readonly	Group the user belongs to. The group entry includes a unique identifier and a name.
reports_to number readonly	Unique identifier of the manager of the user.
timezone string	Timezone of the user as the offset from Coordinated Universal Time (UTC) in the format `UTC(+\|-)[hh]:[mm]`. Fallbacks to the account’s timezone if not set per user.
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.

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`
role_id number optional	The unique identifier of the role. e.g. `?role_id=2`
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`

Action

GET /v2/users

Examples

Retrieve all confirmed and common user accounts

GET /v2/users?role=user&status=active&confirmed=true HTTP/1.1

Accept: application/json
Authorization: Bearer $ACCESS_TOKEN

curl -v -X GET https://api.getbase.com/v2/users?role=user&status=active&confirmed=true \
-H "Accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

require 'restclient'
headers = {
    "Accept" => "application/json",
    "Authorization" => "Bearer $ACCESS_TOKEN"
}
response = RestClient.execute method: :get, url: "https://api.getbase.com/v2/users?role=user&status=active&confirmed=true", headers: headers

puts response

import requests
import json

response = requests.get(
    url='https://api.getbase.com/v2/users?role=user&status=active&confirmed=true',
    headers={
      'Accept': 'application/json',
      'Authorization': 'Bearer $ACCESS_TOKEN'
    },
    verify=True
  )

print(response.text)

HTTP/1.1 200 OK

Content-Type: application/json; charset=utf-8
Content-Language: en

{
  "items": [
    {
      "data": {
        "id": 2,
        "name": "Mark Johnson",
        "email": "mark@salesteam.com",
        "status": "active",
        "invited": true,
        "confirmed": true,
        "role": "user",
        "created_at": "2014-08-27T16:32:56Z",
        "updated_at": "2014-08-27T17:32:56Z",
        "deleted_at": null,
        "roles": [
          {
            "id": 1,
            "name": "Closer"
          }
        ],
        "phone_number": "508-778-6516",
        "timezone": "UTC-05:00",
        "reports_to": 1,
        "team_name": "Mark Johnson's Team",
        "group": {
          "id": 1,
          "group": "Closers A Group"
        }
      },
      "meta": {
        "type": "user"
      }
    }
  ],
  "meta": {
    "type": "collection",
    "count": 1,
    "links": {
      "self": "http://api.getbase.com/v2/users.json"
    }
  }
}

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.

Action

GET /v2/users/:id

Examples

Retrieve a user with id 2

GET /v2/users/2 HTTP/1.1

Accept: application/json
Authorization: Bearer $ACCESS_TOKEN

curl -v -X GET https://api.getbase.com/v2/users/2 \
-H "Accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

require 'restclient'
headers = {
    "Accept" => "application/json",
    "Authorization" => "Bearer $ACCESS_TOKEN"
}
response = RestClient.execute method: :get, url: "https://api.getbase.com/v2/users/2", headers: headers

puts response

import requests
import json

response = requests.get(
    url='https://api.getbase.com/v2/users/2',
    headers={
      'Accept': 'application/json',
      'Authorization': 'Bearer $ACCESS_TOKEN'
    },
    verify=True
  )

print(response.text)

HTTP/1.1 200 OK

Content-Type: application/json; charset=utf-8
Content-Language: en

{
  "data": {
    "id": 2,
    "name": "Mark Johnson",
    "email": "mark@salesteam.com",
    "status": "active",
    "invited": true,
    "confirmed": true,
    "role": "user",
    "created_at": "2014-08-27T16:32:56Z",
    "updated_at": "2014-08-27T17:32:56Z",
    "deleted_at": null,
    "roles": [
      {
        "id": 1,
        "name": "Closer"
      }
    ],
    "phone_number": "508-778-6516",
    "timezone": "UTC-05:00",
    "reports_to": 1,
    "team_name": "Mark Johnson's Team",
    "group": {
      "id": 1,
      "group": "Closers A Group"
    }
  },
  "meta": {
    "type": "user"
  }
}

Retrieve an authenticating user

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

Action

GET /v2/users/self

Examples

Retrieve an authenticating user

GET /v2/users/self HTTP/1.1

Accept: application/json
Authorization: Bearer $ACCESS_TOKEN

curl -v -X GET https://api.getbase.com/v2/users/self \
-H "Accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

require 'restclient'
headers = {
    "Accept" => "application/json",
    "Authorization" => "Bearer $ACCESS_TOKEN"
}
response = RestClient.execute method: :get, url: "https://api.getbase.com/v2/users/self", headers: headers

puts response

import requests
import json

response = requests.get(
    url='https://api.getbase.com/v2/users/self',
    headers={
      'Accept': 'application/json',
      'Authorization': 'Bearer $ACCESS_TOKEN'
    },
    verify=True
  )

print(response.text)

HTTP/1.1 200 OK

Content-Type: application/json; charset=utf-8
Content-Language: en

{
  "data": {
    "id": 2,
    "name": "Mark Johnson",
    "email": "mark@salesteam.com",
    "status": "active",
    "invited": true,
    "confirmed": true,
    "role": "user",
    "created_at": "2014-08-27T16:32:56Z",
    "updated_at": "2014-08-27T17:32:56Z",
    "deleted_at": null,
    "roles": [
      {
        "id": 1,
        "name": "Closer"
      }
    ],
    "phone_number": "508-778-6516",
    "timezone": "UTC-05:00",
    "reports_to": 1,
    "team_name": "Mark Johnson's Team",
    "group": {
      "id": 1,
      "group": "Closers A Group"
    }
  },
  "meta": {
    "type": "user"
  }
}

Users

Properties

Possible values:

Possible values:

Endpoints

Retrieve all users

Parameters

Possible values:

Possible values:

Retrieve a single user

Parameters

Retrieve an authenticating user