Returns all users associated with your company
[
{
"id": "integer",
"email": "string",
"first_name": "string",
"last_name": "string",
"created_at": "datetime",
"activated_at": "datetime",
"deleted_at": "datetime",
},
...
]
| Param name | Description |
|---|---|
|
token required |
API token for your organization Validations:
|
Returns all of a Users attributes
| Code | Description |
|---|---|
| 404 | User not found |
201 Response
{
"id": "integer",
"email": "string",
"first_name": "string",
"last_name": "string",
"created_at": "datetime",
"updated_at": "datetime",
"activated_at": "datetime",
"reset_code_at": "datetime",
"state": "string",
"deleted_at": "datetime",
"login_count": "integer",
"last_request_at": "datetime",
"current_login_at": "datetime",
"current_login_ip": "string",
"last_login_ip": "string",
}
| Param name | Description |
|---|---|
|
token required |
API token for your organization Validations:
|
|
id required |
ID of the user Validations:
|
Creates a user
| Code | Description |
|---|---|
| 300 | Error creating user |
201 Response
{
"id": "integer",
"email": "string",
"first_name": "string",
"last_name": "string",
"created_at": "datetime",
"updated_at": "datetime",
"activated_at": "datetime",
"reset_code_at": "datetime",
"state": "string",
"deleted_at": "datetime",
"login_count": "integer",
"last_request_at": "datetime",
"current_login_at": "datetime",
"current_login_ip": "string",
"last_login_ip": "string",
}
300 Response
{
"errors":{
"email": ["should look like an email address.","required"],
"password": ["is too short (minimum is 4 characters)"],
"first_name": ["required"],
"last_name": ["required"],
}
}
| Param name | Description |
|---|---|
|
token required |
API token for your organization Validations:
|
|
email required |
email address of the user Validations:
|
|
first_name required |
first name of the user Validations:
|
|
last_name required |
last name of the user Validations:
|
|
password required |
User's password Validations:
|
Updates a user
| Code | Description |
|---|---|
| 300 | Error creating user |
| 404 | User not found |
201 Response
{
"id": "integer",
"email": "string",
"first_name": "string",
"last_name": "string",
"created_at": "datetime",
"updated_at": "datetime",
"activated_at": "datetime",
"reset_code_at": "datetime",
"state": "string",
"deleted_at": "datetime",
"login_count": "integer",
"last_request_at": "datetime",
"current_login_at": "datetime",
"current_login_ip": "string",
"last_login_ip": "string",
}
300 Response
{
"errors":{
"email": ["should look like an email address.","required"],
"password": ["is too short (minimum is 4 characters)"],
"first_name": ["required"],
"last_name": ["required"],
}
}
| Param name | Description |
|---|---|
|
token required |
API token for your organization Validations:
|
|
id required |
ID of the user Validations:
|
|
email optional |
email address of the user Validations:
|
|
first_name optional |
first name of the user Validations:
|
|
last_name optional |
last name of the user Validations:
|
|
password optional |
User's password Validations:
|
Soft deletes a user, login disabled
| Code | Description |
|---|---|
| 404 | User not found |
| 501 | Not Implemented |
{
"id": 18696,
}
| Param name | Description |
|---|---|
|
token required |
API token for your organization Validations:
|
|
id required |
ID of the user Validations:
|