---
title: "Appointments API Documentation"
description: "APIs for scheduling and managing appointments linked to contacts, and partners. Use these endpoints to list existing appointments or create new ones with timezone support, invitees, and automatic calendar notifications."
url: https://support.agentcis.com/en/articles/447-appointments-api-documentation
collection: "API Documentation"
updated: 2026-07-21
language: en
---

# Appointments API Documentation

APIs for scheduling and managing appointments linked to contacts, and partners. Use these endpoints to list existing appointments or create new ones with timezone support, invitees, and automatic calendar notifications.

### List of Appointment 🔒

-   Endpoint: **{{Base URL}}**/appointments/{appointable}/{appointable\_id}
    
-   Method: GET
    
-   Description: Fetch the list of users
    

Retrieves a paginated list of appointments for a specific appointable entity (e.g. a client, application, etc.).

  

Path Parameters

  

<table data-id="0bbbd6a4-b3c1-4d54-a8c7-6fbf3a7e6999" style="min-width: 75px;"><colgroup><col style="min-width: 25px;"><col style="min-width: 25px;"><col style="min-width: 25px;"></colgroup><tbody><tr><td colspan="1" rowspan="1" style="vertical-align: top; padding: 5pt; overflow: hidden; overflow-wrap: break-word; border-width: 1pt 1pt 0.833333pt; border-style: solid; border-color: #000000 #000000 #454545;"><p data-id="39e445d5-4e54-4c38-872d-9343041f1f2d"><span style="color: #000000;">Parameter</span></p></td><td colspan="1" rowspan="1" style="vertical-align: top; padding: 5pt; overflow: hidden; overflow-wrap: break-word; border-width: 1pt 1pt 0.833333pt; border-style: solid; border-color: #000000 #000000 #454545;"><p data-id="a219c6fc-0960-4c7b-bc8e-fdb8788e1588"><span style="color: #000000;">Type</span></p></td><td colspan="1" rowspan="1" style="vertical-align: top; padding: 5pt; overflow: hidden; overflow-wrap: break-word; border-width: 1pt 1pt 0.833333pt; border-style: solid; border-color: #000000 #000000 #454545;"><p data-id="d6e9dbda-8946-4b9b-b2b8-1582cf3135a9"><span style="color: #000000;">Description</span></p></td></tr><tr><td colspan="1" rowspan="1" style="vertical-align: top; padding: 2pt; overflow: hidden; overflow-wrap: break-word; border-width: 0.833333pt; border-style: solid; border-color: #454545;"><p data-id="23161c41-49c2-418a-8d6e-bbbfbc8ee05f"><span style="color: #000000;">appointable</span></p></td><td colspan="1" rowspan="1" style="vertical-align: top; padding: 2pt; overflow: hidden; overflow-wrap: break-word; border-width: 0.833333pt; border-style: solid; border-color: #454545;"><p data-id="8f2c1a30-1faf-4bdf-aa63-2413c070d39a"><span style="color: #000000;">string</span></p></td><td colspan="1" rowspan="1" style="vertical-align: top; padding: 2pt; overflow: hidden; overflow-wrap: break-word; border-width: 0.833333pt; border-style: solid; border-color: #454545;"><p data-id="e4c659cc-998d-42fc-92d9-f689265c7f69"><span style="color: #000000;">Morph alias of the entity type (e.g. client, application)</span></p></td></tr><tr><td colspan="1" rowspan="1" style="vertical-align: top; padding: 2pt; overflow: hidden; overflow-wrap: break-word; border-width: 0.833333pt; border-style: solid; border-color: #454545;"><p data-id="52ddf235-3acf-48ce-be28-afcb0d591289"><span style="color: #000000;">appointable_id</span></p></td><td colspan="1" rowspan="1" style="vertical-align: top; padding: 2pt; overflow: hidden; overflow-wrap: break-word; border-width: 0.833333pt; border-style: solid; border-color: #454545;"><p data-id="270998cc-c2f7-4dca-83af-eedecd4af19a"><span style="color: #000000;">integer</span></p></td><td colspan="1" rowspan="1" style="vertical-align: top; padding: 2pt; overflow: hidden; overflow-wrap: break-word; border-width: 0.833333pt; border-style: solid; border-color: #454545;"><p data-id="67efcf12-61fe-45f1-987a-abe8fd35020c"><span style="color: #000000;">ID of the entity</span></p></td></tr></tbody></table>

  

Query String Parameters

  

<table data-id="7239ac2c-ef41-4a60-8b16-12035396993c" style="min-width: 25px;"><colgroup><col style="min-width: 25px;"></colgroup><tbody><tr><td colspan="1" rowspan="1" style="vertical-align: top; padding: 5pt; overflow: hidden; overflow-wrap: break-word; border-width: 1pt; border-style: solid; border-color: #000000;"><p data-id="ca5a82a0-684e-4cef-bf6c-6fbe27eab460" style="text-align: justify;"><span style="color: #000000;">page=1&amp;per_page=10</span></p></td></tr></tbody></table>

  
  

Response

<table data-id="1459ca6b-34f9-469c-a682-64dc6d2c6c63" style="min-width: 25px;"><colgroup><col style="min-width: 25px;"></colgroup><tbody><tr><td colspan="1" rowspan="1" style="vertical-align: top; padding: 5pt; overflow: hidden; overflow-wrap: break-word; border-width: 1pt; border-style: solid; border-color: #000000;"><p data-id="eca56bb5-1fb9-4cf1-aaa1-7813c5c392ae" style="text-align: justify;"><span style="color: #000000;">{</span></p><p data-id="0fd9a6f2-17be-401d-b58e-c05ecf8e05f8" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;"data": [</span></p><p data-id="4e6b2f46-f692-494d-9034-d87268299703" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;&nbsp;{</span></p><p data-id="8d3f6670-2a69-4de0-a9e6-ddb6144f5065" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id": 123,</span></p><p data-id="e56b6d96-4488-49b5-99f8-859531756d94" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"title": "Meeting Title",</span></p><p data-id="0797c0bf-3242-47c4-9e89-646f9cee01cf" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"description": "Meeting details",</span></p><p data-id="b08a6760-f909-4887-b3c3-41d7b56a87d8" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"appointment_date": {</span></p><p data-id="87aff769-6482-4487-982f-eb027728b951" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"formatted": "27 Mar 2026",</span></p><p data-id="32246e99-41e2-4ad3-87f8-3b64230e7ed4" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"actual": "2026-03-27T10:30:00+05:30",</span></p><p data-id="6bb20ab3-4990-4015-82cc-a38a36837f2b" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"day_date": "27 Thu",</span></p><p data-id="8d35486b-c8d0-4c94-81c4-4bddcffb1c58" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"day_name": "Thu",</span></p><p data-id="8d3a90ee-9039-4f6e-bbbc-866d509dbb02" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"date": "27",</span></p><p data-id="1310c593-094b-4ccf-8158-fc405115a7ba" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"month": "Mar",</span></p><p data-id="b9977bf3-0238-4918-9e25-0f0f35eb10da" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"month_name": "March",</span></p><p data-id="ef4ba721-e389-4cf3-a7a7-f8ccb515923c" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"year": "2026",</span></p><p data-id="e5029d82-7277-4166-8ffc-ae1912488760" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"time": "10:30",</span></p><p data-id="b26de71e-9a3a-4938-9843-10c4d63cf0dc" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"full_date": "27 Thu, Mar 2026",</span></p><p data-id="42352021-08b5-4df8-bbae-a0a821c688ea" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"referential_date": "3 days from now"</span></p><p data-id="24b05df5-7c41-46b3-afa5-7ee81768e719" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},</span></p><p data-id="25de4780-5f43-44ba-a532-8bc94e59e22e" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"appointable": { },</span></p><p data-id="d10908d1-81ad-4ec8-9218-266c483e1be1" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"invitees": [</span></p><p data-id="5b267e14-f06a-4de0-91e0-5107817e74c0" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{</span></p><p data-id="db777cbc-505c-41f6-9d72-8252b25bfa19" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id": 456,</span></p><p data-id="d84390ad-2cfa-46d1-855b-1a120a00ecee" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name": "John Doe",</span></p><p data-id="38acc74a-38de-4f37-9a63-b2e526c1fec2" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"email": "</span><a target="_blank" rel="noopener noreferrer nofollow" class="linktype-link link" data-linktype="link" href="mailto:john@example.com"><span style="color: #000000;">john@example.com</span></a><span style="color: #000000;">",</span></p><p data-id="c4956576-ec64-452a-b0a5-cb52721d3564" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"avatar": "https://..."</span></p><p data-id="e436b26b-9aa1-47eb-bf7c-30ba25e61a86" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}</span></p><p data-id="1cfc3492-fe1f-4d4c-a06b-e1ce986ecbdb" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],</span></p><p data-id="e933b8fc-e5fa-4d28-b0c5-e67ddd7a13e8" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"creator": {</span></p><p data-id="003bb4d7-6ad6-4f20-a181-b31f27dc5687" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id": 789,</span></p><p data-id="eb42106b-de89-4e87-a3a6-bc5fdf6a596c" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"email": "</span><a target="_blank" rel="noopener noreferrer nofollow" class="linktype-link link" data-linktype="link" href="mailto:creator@example.com"><span style="color: #000000;">creator@example.com</span></a><span style="color: #000000;">",</span></p><p data-id="0df8524f-8491-44a6-96b8-f89e79fa0416" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name": "Jane Smith",</span></p><p data-id="bd79334b-df55-4bb5-8b93-b5ef5221a9e7" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"avatar": "https://..."</span></p><p data-id="8e906805-d4c7-4a6f-8b37-745d12b8bf4b" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},</span></p><p data-id="f627dc4a-d825-4092-8b6f-8fefe65fe4e1" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"permissions": {</span></p><p data-id="763fd1dd-df5d-4954-b6f9-e036a065eed5" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"edit": true,</span></p><p data-id="f418035b-8b12-4db0-88e8-6856861aef1d" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"delete": true</span></p><p data-id="2419f3e9-c177-4333-814e-8f5b449cce17" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}</span></p><p data-id="fc9e8590-a7b1-43fc-a0e4-99f9b277a9fd" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;&nbsp;&nbsp;}</span></p><p data-id="ac7fd8ca-e195-4b04-adf3-e45679a979c4" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;],</span></p><p data-id="3c0e4e98-27e4-4786-b302-98033910add3" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;"links": { },</span></p><p data-id="1d4d762a-ead7-41e5-8a99-2db5e8aede9d" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;"meta": { }</span></p><p data-id="157f3a5f-2e32-4b8f-acc3-c75b08ef5531" style="text-align: justify;"><span style="color: #000000;">}</span></p></td></tr></tbody></table>

### Create Appointment 🔒

-   Endpoint: **{{Base URL}}**/appointments/{appointable}/{appointable\_id}
    
-   Method: POST
    
-   Description: Created Appointment
    

Path Parameters

  

<table data-id="d6bb1279-6d67-4a0c-9245-e1d6818a5ab4" style="min-width: 75px;"><colgroup><col style="min-width: 25px;"><col style="min-width: 25px;"><col style="min-width: 25px;"></colgroup><tbody><tr><td colspan="1" rowspan="1" style="vertical-align: top; padding: 5pt; overflow: hidden; overflow-wrap: break-word; border-width: 1pt 1pt 0.833333pt; border-style: solid; border-color: #000000 #000000 #454545;"><p data-id="f5332a1a-6d8d-4201-bf9e-01624db250ba"><span style="color: #000000;">Parameter</span></p></td><td colspan="1" rowspan="1" style="vertical-align: top; padding: 5pt; overflow: hidden; overflow-wrap: break-word; border-width: 1pt 1pt 0.833333pt; border-style: solid; border-color: #000000 #000000 #454545;"><p data-id="07a64726-904d-4484-bf03-9c4dcc34d16e"><span style="color: #000000;">Type</span></p></td><td colspan="1" rowspan="1" style="vertical-align: top; padding: 5pt; overflow: hidden; overflow-wrap: break-word; border-width: 1pt 1pt 0.833333pt; border-style: solid; border-color: #000000 #000000 #454545;"><p data-id="859706c5-c649-45c8-8cde-cefe2b810640"><span style="color: #000000;">Description</span></p></td></tr><tr><td colspan="1" rowspan="1" style="vertical-align: top; padding: 2pt; overflow: hidden; overflow-wrap: break-word; border-width: 0.833333pt; border-style: solid; border-color: #454545;"><p data-id="e7dcdfbb-584d-45d6-9224-b427296f6ffa"><span style="color: #000000;">appointable</span></p></td><td colspan="1" rowspan="1" style="vertical-align: top; padding: 2pt; overflow: hidden; overflow-wrap: break-word; border-width: 0.833333pt; border-style: solid; border-color: #454545;"><p data-id="0624105a-4028-4e07-9e43-2b486e8d12c4"><span style="color: #000000;">string</span></p></td><td colspan="1" rowspan="1" style="vertical-align: top; padding: 2pt; overflow: hidden; overflow-wrap: break-word; border-width: 0.833333pt; border-style: solid; border-color: #454545;"><p data-id="d9052615-666b-4604-8dcd-2773c304fee5"><span style="color: #000000;">Morph alias of the entity type (e.g. client, application)</span></p></td></tr><tr><td colspan="1" rowspan="1" style="vertical-align: top; padding: 2pt; overflow: hidden; overflow-wrap: break-word; border-width: 0.833333pt; border-style: solid; border-color: #454545;"><p data-id="0602d742-8290-4308-91c8-f3042b099fc1"><span style="color: #000000;">appointable_id</span></p></td><td colspan="1" rowspan="1" style="vertical-align: top; padding: 2pt; overflow: hidden; overflow-wrap: break-word; border-width: 0.833333pt; border-style: solid; border-color: #454545;"><p data-id="712c45eb-7370-40c8-ab7c-044418293a02"><span style="color: #000000;">integer</span></p></td><td colspan="1" rowspan="1" style="vertical-align: top; padding: 2pt; overflow: hidden; overflow-wrap: break-word; border-width: 0.833333pt; border-style: solid; border-color: #454545;"><p data-id="0d02ae9d-b613-4547-959e-c1e121173810"><span style="color: #000000;">ID of the entity</span></p></td></tr></tbody></table>

  

Payload

  

<table data-id="aa63761d-9b0a-456f-8ef9-8f74ab3ee4dd" style="min-width: 25px;"><colgroup><col style="min-width: 25px;"></colgroup><tbody><tr><td colspan="1" rowspan="1" style="vertical-align: top; padding: 5pt; overflow: hidden; overflow-wrap: break-word; border-width: 1pt; border-style: solid; border-color: #000000;"><p data-id="c1ab1445-2d75-47d3-b10c-fd3ebdd5cffc" style="text-align: justify;"><span style="color: #000000;">{</span></p><p data-id="41a598a6-4385-45e3-a92c-45cd388a9d31" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;"title": "Client Consultation",</span></p><p data-id="b54b6661-ad21-4cf8-95c5-4552073e6a2e" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;"appointment_date": "2026-04-20 10:30:00",</span></p><p data-id="9406002e-14d3-41a4-a974-ca12924762d7" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;"appointment_time": "10:30",</span></p><p data-id="41fd2ce4-fa1b-4017-9f45-fadcad87b2d3" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;"time_format": "AM",</span></p><p data-id="2d4dfb6d-fdd7-43b9-b54d-b32e1c4a5bc1" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;"timezone": "Asia/Kolkata",</span></p><p data-id="eb5d578f-8b88-4ec0-948c-2ff5918e2a69" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;"description": "Initial consultation meeting",</span></p><p data-id="f59ba125-9332-426b-9e1c-d14429d75841" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;"invitees": [1, 2, 3]</span></p><p data-id="cfc6ab1a-8a0f-4703-beb1-e5d1461d7f81" style="text-align: justify;"><span style="color: #000000;">}</span></p></td></tr></tbody></table>

  

Note: invitees is an array of user ids.

  

Response

  

<table data-id="8b43ba73-6de2-4963-89a1-6f6704dfa869" style="min-width: 25px;"><colgroup><col style="min-width: 25px;"></colgroup><tbody><tr><td colspan="1" rowspan="1" style="vertical-align: top; padding: 5pt; overflow: hidden; overflow-wrap: break-word; border-width: 1pt; border-style: solid; border-color: #000000;"><p data-id="11439d38-2bfb-4770-bb39-f076d7c9006e" style="text-align: justify;"><span style="color: #000000;">{</span></p><p data-id="9adcf5fa-c8c0-45b0-96b9-e81bafc5ac4e" style="text-align: justify;"><span style="color: #000000;">&nbsp;&nbsp;"message": "Appointment saved"</span></p><p data-id="d71b5a6e-b3a7-41fd-a8ab-29d006215071" style="text-align: justify;"><span style="color: #000000;">}</span></p></td></tr></tbody></table>
