User resources

Get users

GET https://app.smartmansys.com/api/v1/users

Query Parameters

Name	Type	Description
name	string	Return the users that exactly match the name
email	string	Return the users that exactly matchs the email
role	string	Return the users that exactly matchs the role
employee_number	string	Return the users that exactly matchs the employee number

Headers

Name	Type	Description
Authorization	string	Authentication token

200

{
    "users": [
        {
            "id": 1,
            "name": "First and last name",
            "email": "[email protected]",
            "employee_number": "2376sa",
            "role": "admin",
            "status": "active",
            "job_title_ids": [1,2],
            "business_unit_ids": []
        },
        {
            ...
        }
    ]
}

Create user

POST https://app.smartmansys.com/api/v1/users/

This endpoint also users to be created. The newly created users will receive automatically a welcome email from SmartManSys.

Headers

Name	Type	Description
Authorization	string	Authentication token

Request Body

Name	Type	Description
user	object	User

200

{
    "status": "OK",
    "user": {
        "id": 1,
        "name": "Name of the user",
        "email": "[email protected]",
        "employee_number": "2376sa",
        "role": "admin",
        "status": "active",
        "job_title_ids": [1,2],
        "business_unit_ids": []
    }
}
{
    "status": "NOT-OK",
    "errors": {
        "name": ["Name is required"],
        "email": ["Email can't be blank", "Email is invalid", "Email has already been taken"],
        "job_title_ids": ["Job title with id [1, 2] where not found"],
        "business_unit_ids": ["Business unit with id [1, 2] where not found"]
    }
}

// user object
{
    "name": "Name of the user", // required
    "email": "Email of the user", // required
    "employee_number": "2376sa",
    "role": "admin", // required. Available opties ["admin", "editor", "author", "writer", "subscriber", "auditor"]
    "status": "active", // required. Available opties ["active", "inactive"]
    "job_title_ids": [1,2,3] // Array of the job title ids. 
    "business_unit_ids": [] // Array of businiess_unit_ids.
}

Update user

PATCH https://app.smartmansys.com/api/v1/users/:id

Path Parameters

Name	Type	Description
id	integer	Id of the use

Headers

Name	Type	Description
Authorization	string	Authentication token

Request Body

Name	Type	Description
user	object	User

200

{
    "status": "OK",
    "user": {
        "id": 1,
        "name": "Name of the user",
        "email": "[email protected]",
        "employee_number": "2376sa",
        "role": "admin",
        "job_title_ids": [1,2],
        "business_unit_ids": []
    }
}
{
    "status": "NOT-OK",
    "errors": {
        "name": ["Name is required"],
        "email": ["Email can't be blank", "Email is invalid", "Email has already been taken"],
        "job_title_ids": ["Job title with id [1, 2] where not found"],
        "business_unit_ids": ["Business unit with id [1, 2] where not found"]
    }
}

404 When the user doesn't exists

// user object
{
    "name": "Name of the user",
    "email": "Email of the user",
    "employee_number": "2376sa",
    "role": "admin", // Available opties ["admin", "editor", "author", "writer", "subscriber", "auditor"]
    "status": "active", // Available opties ["active", "inactive"]
    "job_title_ids": [1,2,3] // Array of the job title ids. 
    "business_unit_ids": [] // Array of businiess_unit_ids.
}

User delete

DELETE https://app.smartmansys.com/api/v1/users/:id

Path Parameters

Name	Type	Description
id	number	Id of the user

Headers

Name	Type	Description
Authorization	string	Authentication token

200

{
    "status": "OK"
}

404 When the user doesn't exists