Supported user attributes:

Attribute Type Description
id number Unique identifier of the user.
name string Full name of the user.
email string Email address of the user.
status string Status of the user’s account. Usually active. Possible values: active,inactive
role string Role of the user. Possible values:user,admin
confirmed boolean Indicates whether the user’s account has been confirmed or not.
created_at string Date and time that the user was created in UTC (ISO8601 format).

Endpoints

Stream User

Read the stream of user events.

See Introduction article for more details on request and response formats and parameters.

Action

GET /v3/users/stream

Examples

Read the stream of user events

GET /v3/users/stream?position=tailAccept: application/jsonAuthorization: Bearer $ACCESS_TOKENUser-Agent: $CLIENT_NAME
HTTP/1.1 200 OK   Content-Type: application/json
{ "items": [    {      "data": {        "role": "admin",        "name": "Admin",        "created_at": "2017-06-21T08:30:26Z",        "id": 1203172,        "confirmed": true,        "email": "[email protected]",        "status": "active"      },      "meta": {        "event_cause": "interaction",        "sequence": 1,        "event_id": "fbE6okpsRK2X4UJ1nNzs7g",        "event_type": "created",        "type": "user",        "event_time": "2017-06-21T08:30:26Z"      }    }  ],  "meta": {    "links": {      "next": "https://api.getbase.com/v3/users/stream?position=ZmlyZWhvc2UuZmFjdG9pZC5jb250YWN0LnNuYXBzaG90cywxLDMwNTQ5Mg=="    },    "position": "ZmlyZWhvc2UuZmFjdG9pZC5jb250YWN0LnNuYXBzaG90cywxLDMwNTQ5Mg==",    "top": false  }}