Users

Search

Search for users.

Endpoint

Method URI Description
GET /users Search users
GET /teams/{team_id}/users Search team users

Example Response

{
    "data": [
        {
            "id": 1,
            "first_name": "Happy",
            "last_name": "Grasshopper",
            "full_name": "Happy Grasshopper",
            "email": "[email protected]",
            "company_name": "Happy Grasshopper",
            "phone": "7272329117",
            "dob": null,
            "gender": "Not Specified",
            "time_zone": "America/New_York",
            "status": "Active",
            "site_id": 1,
            "contacts_count": 2,
            "tags_count": 0,
            "roles": [
                "Administrator",
                "Team Administrator",
                "User"
            ],
            "created_at": "2013-09-27T11:46:44Z",
            "updated_at": "2020-02-14T22:21:48Z",
            "deleted_at": null
        }
    ],
    "links": {
        "first": "https://api.happygrasshopper.com/v3/users/77179/users?page=1",
        "last": "https://api.happygrasshopper.com/v3/users/77179/users?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "https://api.happygrasshopper.com/v3/users/77179/users",
        "per_page": 15,
        "to": 1,
        "total": 1
    }
}

Read

Retrieve an user.

Endpoint

Method URI Description
GET /users/{user_id} Retrieve an user by it's id

Example Response

{
    "id": 1,
    "first_name": "Happy",
    "last_name": "Grasshopper",
    "full_name": "Happy Grasshopper",
    "email": "[email protected]",
    "company_name": "Happy Grasshopper",
    "phone": "7272329117",
    "dob": null,
    "gender": "Not Specified",
    "time_zone": "America/New_York",
    "status": "Active",
    "site_id": 1,
    "contacts_count": 2,
    "tags_count": 0,
    "roles": [
        "Administrator",
        "Team Administrator",
        "User"
    ],
    "created_at": "2013-09-27T11:46:44Z",
    "updated_at": "2020-02-14T22:21:48Z",
    "deleted_at": null
}

Update

Update an user.

Endpoint

Method URI Description
PUT /users/{user_id} Update an user

Body Params

{
    "first_name": "Happy",
    "last_name": "Grasshopper",
    "email": "[email protected]",
    "company_name": "Happy Grasshopper",
    "phone": "7272329117",
    "dob": "1990-01-01",
    "gender": "Not Specified",
    "time_zone": "America/New_York"
}

Example Response

{
    "id": 1,
    "first_name": "Happy",
    "last_name": "Grasshopper",
    "full_name": "Happy Grasshopper",
    "email": "[email protected]",
    "company_name": "Happy Grasshopper",
    "phone": "7272329117",
    "dob": null,
    "gender": "Not Specified",
    "time_zone": "America/New_York",
    "status": "Active",
    "site_id": 1,
    "contacts_count": 2,
    "tags_count": 0,
    "roles": [
        "Administrator",
        "Team Administrator",
        "User"
    ],
    "created_at": "2013-09-27T11:46:44Z",
    "updated_at": "2020-02-14T22:21:48Z",
    "deleted_at": null
}

Delete

Delete an user.

Endpoint

Method URI Description
DELETE /users/{user_id} Delete an user by it's id

Example Response

{
    "success": true
}