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

Name	Type	Description
X-Zencal-Api-Key*	String	Zencal Api key
Accept*	String	application/json
Content-Type*	String	application/json

200: OK

{
    "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

Name	Type	Description
teamUuid*	String	Team's uuid

Headers

Name	Type	Description
X-Zencal-Api-Key*	String	application/json
Accept*	String	application/json
Content-Type*	String	application/json

200: OK

{
    "users": [
        {
            "uuid": "86f2e210-f168-45d2-81a2-7e220cc20dca",
            "username": "joe-smith",
            "firstName": "Joe",
            "lastName": "Smith",
            "email": "[email protected]",
            "phone": "[phone]",
            "avatar": "https://cdn.zencal.io/avatar.png",
            "tags": [
                {
                    "uuid": "dd3107a3-0a48-4c31-a48e-2fc500e416da",
                    "name": "Kraków",
                    "color": "#3b82f6"
                }
            ]
        },
        {
            "uuid": "12f2exx0-f8168-45d2-81a2-7e220cc20dca",
            "username": "barbra-streisand",
            "firstName": "Barbra",
            "lastName": "Streisand",
            "email": "[email protected]",
            "phone": "[phone]",
            "avatar": "https://cdn.zencal.io/avatar.png",
            "tags": []
        }
    ]
}

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

Name	Type	Description
teamUuid*	String	Team's uuid

Headers

Name	Type	Description
X-Zencal-Api-Key*	String	Zencal Api key
Content-Type*	String	application/json
Accept*	String	application/json

Request Body

Name	Type	Description
firstName*	String	Team member's first name
lastName*	String	Team member's last name
email*	String	Team member's email
admin	Boolean	Set to true if this user should have admin privileges

200: OK

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

402: Payment Required

Delete user from your team

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

Path Parameters

Name	Type	Description
teamUuid*	String	Team's uuid
userUuid*	String	User's uuid

Headers

Name	Type	Description
X-Zencal-Api-Key*	String	Zencal Api key
Accept*	String	application/json
Content-Type*	String	application/json

200: OK

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