Meetings

Get host meetings

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

Use this method to download the organizer's meeting list. Limit 500

Headers

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

Query params

Name	Type	Description
host*	String	If you are a single user, this is your uuid. If you need an appointment list for a team user specify the uuid of the team user.
from*	String	Start date of the meeting e.g. 2025-01-01
to*	String	End date of the meeting e.g. 2025-02-01

200: OK

{
    "meetings": [
        {
            "uuid": "68XX6-dXX4-48bf-a433-eXX",
            "start": "2025-01-07 13:00:00",
            "end": "2025-01-07 14:00:00",
            "status": "confirmed",
            "place": "Google Meet",
            "joinMeetingLink": "https://meet.google.com/gg-gg-gg",
            "topic": {
                "uuid": "85e2526d-70d4-48c2-bada-4d80a322bb9a",
                "name": "Wprowadzenie do Zencal",
                "metadata": {}
            },
            "attendee": {
                "name": "John Doe",
                "email": "[email protected]",
                "phone": null
            },
            "host": {
                "name": "Michael Jorban",
                "email": "[email protected]",
                "phone": null
            }
        },
        {
            "uuid": "4eXXXb4-3c33-4629-XX91-e288XXXXXd6d",
            "start": "2025-01-09 08:00:00",
            "end": "2025-01-09 08:44:00",
            "status": "confirmed",
            "place": "Google Meet",
            "joinMeetingLink": "https://meet.google.com/gg-gg-gg",
            "topic": {
                "uuid": "85e2526d-70d4-48c2-bada-4d80a322bb9a",
                "name": "Wprowadzenie do Zencal",
                "metadata": {}
            },
            "attendee": {
                "name": "John Doe",
                "email": "[email protected]",
                "phone": null
            },
            "host": {
                "name": "Michael Jorban",
                "email": "[email protected]",
                "phone": null
            }
        },
        {
            "uuid": "157XXX5c-1c9X7-4ace-a6XXXd-69426cXXXXX7c",
            "start": "2025-01-09 15:20:00",
            "end": "2025-01-09 16:04:00",
            "status": "confirmed",
            "place": "Google Meet",
            "joinMeetingLink": "https://meet.google.com/gg-gg-gg",
            "topic": {
                "uuid": "85e2526d-70d4-48c2-bada-4d80a322bb9a",
                "name": "Wprowadzenie do Zencal",
                "metadata": {}
            },
            "attendee": {
                "name": "John Doe",
                "email": "[email protected]",
                "phone": null
            },
            "host": {
                "name": "Michael Jorban",
                "email": "[email protected]",
                "phone": null
            }
        },
    ]
}

404: Not found

Generate one-time link to scheduling page

Creating quick meeting

POST https://app.zencal.io/api/v1/meetings/quick

Use this method to generate a link to an online meeting. The generated link will also create a meeting in your Google or Outlook calendar (depending on the selected provider). The created meeting will have its duration set to the value specified in the duration parameter. The start time of the meeting is the time the request is called.

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
duration*	Integer	Duration of the meeting
provider*	String	A calendar in which an online meeting will be created. Available values are: "google" or "outlook"

201: Created

{
    "url": "https://meet.google.com/abc-def-ghi"
}

Generate one-time link to scheduling page

POST https://app.zencal.io/api/v1/meetings/one-time

Use this method to generate a one-time link to schedule an appointment on a specific topic. Once an appointment has been made, this link will no longer be active.

Headers

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

Request Body

Name	Type	Description
username*	String	Username of the user to whom the participant will be scheduled
meetingTopic*	String	Uuid of the meeting topic which the owner is the host or co-host (in team topics)

201: Created

{
    "link": "https://app.zencal.io/meet/{LINK_UUID}"
}

Get meeting details

GET https://app.zencal.io/api/v1/meetings/{meetingUuid}

Use this method to get all information about particular meeting

Headers

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

200

{
    "uuid": "uuid",
    "start": "2024-01-01 00:00:00", // ISO8601, UTC
    "end": "2024-01-01 01:00:00", // ISO8601, UTC
    "status": "confirmed", // [created, confirmed, rejected, canceled, postponed]
    "place": "google-meet", // [offline, google-meet, teamsForBusiness, skypeForBusiness, skypeForConsumer, zoom, phone-call, webex]
    "joinMeetingLink": "http://meet.google.com/join/123",
    "topic": {
        "uuid": "uuid",
        "name": "Consulting 60 min",
        "metadata": {
            "field": "value"
        }
    },
    "attendee": {
        "name": "John Smith",
        "email": "[email protected]",
        "phone": "[phone]"
    },
    "host": {
        "name": "Michale Bond",
        "email": "[email protected]",
        "phone": "[phone]"
    },
    "payment": {
        "amount": 10000, // value in pennies
        "currency": "USD",
        "status": "completed" // [registered, completed, failed]
    }
}

404

Confirm meeting

POST https://app.zencal.io/api/v1/meetings/{meetingUuid}/confirm

Use this method to confirm the meeting

Headers

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

200

{
    "message": "Meeting confirmed",
    "meeting": {
        "uuid": "uuid",
        "start": "2024-01-01 00:00:00", // ISO8601, UTC
        "end": "2024-01-01 01:00:00", // ISO8601, UTC
        "status": "confirmed", // [created, confirmed, rejected, canceled, postponed]
        "place": "google-meet", // [offline, google-meet, teamsForBusiness, skypeForBusiness, skypeForConsumer, zoom, phone-call, webex]
        "joinMeetingLink": "http://meet.google.com/join/123",
        "topic": {
            "uuid": "uuid",
            "name": "Consulting 60 min",
            "metadata": {
                "field": "value"
            }
        },
        "attendee": {
            "name": "John Smith",
            "email": "[email protected]",
            "phone": "[phone]"
        },
        "host": {
            "name": "Michale Bond",
            "email": "[email protected]",
            "phone": "[phone]"
        },
        "payment": {
            "amount": 10000, // value in pennies
            "currency": "USD",
            "status": "completed" // [registered, completed, failed]
        }
    }
}

404