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.

JSON format

Retrieve all users

GET /v2/users

Returns all users, according to the parameters provided.

Parameters

Allowed for

• Agents

Using cURL

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"

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8Content-Language: en
{  "items": [    {      "data": {        "id": 2,        "name": "Mark Johnson",        "email": "[email protected]",        "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,          "name": "Closers A Group"        }      },      "meta": {        "type": "user"      }    }  ],  "meta": {    "type": "collection",    "count": 1,    "links": {      "self": "http://api.getbase.com/v2/users.json"    }  }}

---

Retrieve a single user

GET /v2/users/:id

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

Parameters

Allowed for

• Agents

Using cURL

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

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8Content-Language: en
{  "data": {    "id": 2,    "name": "Mark Johnson",    "email": "[email protected]",    "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,      "name": "Closers A Group"    }  },  "meta": {    "type": "user"  }}

---

Retrieve an authenticating user

GET /v2/users/self

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

Allowed for

• Agents

Using cURL

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

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8Content-Language: en
{  "data": {    "id": 2,    "name": "Mark Johnson",    "email": "[email protected]",    "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,      "name": "Closers A Group"    }  },  "meta": {    "type": "user"  }}

---