Skip to main content

List

Description#

Retrieve a list of users from the Tines tenant.

Request#

HTTP Method: GET

Query ParameterDescription
N/A
Path ParameterDescription
N/A
curl -X GET \  https://<tenant-domain>/api/v1/admin/users \  -H 'content-type: application/json' \  -H 'x-user-email: <email-address>' \  -H 'x-user-token: <api-token>'

Response#

A successful request will return a JSON Array of users in the Tines tenant.

Field description#

ParameterDescription
idUser ID.
emailUser email.
adminBoolean flag indicating whether user is an admin.
created_atTimestamp describing when the user was created.
updated_atTimestamp describing when the user was last updated.
story_countNumber of stories created by the user.
first_nameUser first name.
last_nameUser last name.
last_seenTimestamp describing when the user was last seen in the platform.

Sample response#

{  {      "admin/users": [        {          "id": 2,          "email": "alice@tines.xyz",          "created_at": "2019-07-08T14:16:11.967Z",          "updated_at": "2019-10-31T21:40:52.682Z",          "admin": false,          "story_count": 0,          "first_name": "Alice",          "last_name": "Smith",          "last_seen": "2019-10-31T21:40:42.000Z"        },        {            "id": 3,            "email": "joe@tines.xyz",            "created_at": "2019-09-11T14:46:37.880Z",            "updated_at": "2019-09-27T20:45:46.527Z",            "admin": false,            "story_count": 3,            "first_name": "Joe",            "last_name": "Bloggs",            "last_seen": "2019-09-27T20:45:46.000Z"        },      ],      "meta": {          "current_page": "https://demo.tines.xyz/api/v1/admin/users?page=1&per_page=20",          "previous_page": null,          "next_page": null,          "per_page": 20,          "pages": 1,          "count": 2      }  }}