Teams

Get list of your teams

GET https://app.zencal.io/api/v1/teams

This method will return a list of all teams to which your user has administrator privileges.

Headers

{
    "teams": [
        {
            "uuid": "2174ccfc-eb20-11ed-a05b-0242ac120003",
            "name": "Power Rangers"
        }
    ]
}

Get list of users in your team

GET https://app.zencal.io/api/v1/teams/{teamUuid}/users

This method will return list of team members

Path Parameters

Headers

{
    "users": [
        {
            "uuid": "86f2e210-f168-45d2-81a2-7e220cc20dca",
            "username": "joe-smith",
            "firstName": "Joe",
            "lastName": "Smith",
            "email": "joe.smith@hotmail.com",
            "phone": "+31100200300",
            "avatar": "https://cdn.zencal.io/avatar.png"
        },
        {
            "uuid": "12f2exx0-f8168-45d2-81a2-7e220cc20dca",
            "username": "barbra-streisand",
            "firstName": "Barbra",
            "lastName": "Streisand",
            "email": "barbra.streisand@hotmail.com",
            "phone": "+23300500700",
            "avatar": "https://cdn.zencal.io/avatar.png"
        }
    ]
}

Create a new user in your team

POST https://app.zencal.io/api/v1/teams/{teamUuid}/users

Remember to check if your subscription plan allows you to add more users before adding them. You can check this in the "Billing" tab of your Zencal account.

Path Parameters

Headers

Request Body

{
    "success": "User has been created",
    "teamUser": {
        "uuid": "d371bcf0-ca3c-4c7f-a24c-ddb35c8b5c7f"
    }
}

Delete user from your team

DELETE https://app.zencal.io/api/v1/teams/{teamUuid}/users/{userUuid}

Path Parameters

Headers

{
    "success": "User has been deleted from your team"
}

Last updated