Users
User object holds information about a user of an organization.
Attribute | Type | Description |
id | string | Unique user identifier |
name | string | Full name of the user |
string | Email address associated with the user | |
is_active | bool | Indicator whether the user is active or not. Inactive users cannot sign into Simple OKR. |
created_at | string | Time when the user was created. RFC 3339 format. |
Example:
{"id": "16682617-f25d-4df2-9f51-3c38298996b8","name": "John Doe","email": "[email protected]","is_active": true,"created_at": "2018-02-20T12:32:56Z"}
getList users
get
https://api.simpleokr.com/v1/users
Returns a list of your users.
Request
Response
Request
Query Parameters
page_token
optional
string
Page identifier
Response
200: OK
{"next_page_token": null,"users": [{"id": "16682617-f25d-4df2-9f51-3c38298996b8","name": "John Doe","email": "[email protected]","is_active": true,"created_at": "2018-02-20T12:32:56Z"},{...},{...}]}
getRetrieve user
get
https://api.simpleokr.com/v1/users/:id
Retrieve details about the existing user. Supply a unique user ID from a user list response.
Request
Response
Request
Path Parameters
id
required
string
User ID
Response
200: OK
{"id": "16682617-f25d-4df2-9f51-3c38298996b8","name": "John Doe","email": "[email protected]","is_active": true,"created_at": "2018-02-20T12:32:56Z"}
Last updated 2 years ago