company logo

Help center

Go to Agentcis
Follow us on FacebookFollow us on Linkedin
All collectionsAPI DocumentationAppointments API Documentation

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


Parameter

Type

Description

appointable

string

Morph alias of the entity type (e.g. client, application)

appointable_id

integer

ID of the entity


Query String Parameters


page=1&per_page=10



Response

{

  "data": [

    {

      "id": 123,

      "title": "Meeting Title",

      "description": "Meeting details",

      "appointment_date": {

        "formatted": "27 Mar 2026",

        "actual": "2026-03-27T10:30:00+05:30",

        "day_date": "27 Thu",

        "day_name": "Thu",

        "date": "27",

        "month": "Mar",

        "month_name": "March",

        "year": "2026",

        "time": "10:30",

        "full_date": "27 Thu, Mar 2026",

        "referential_date": "3 days from now"

      },

      "appointable": { },

      "invitees": [

        {

          "id": 456,

          "name": "John Doe",

          "email": "[email protected]",

          "avatar": "https://..."

        }

      ],

      "creator": {

        "id": 789,

        "email": "[email protected]",

        "name": "Jane Smith",

        "avatar": "https://..."

      },

      "permissions": {

        "edit": true,

        "delete": true

      }

    }

  ],

  "links": { },

  "meta": { }

}

Create Appointment 🔒

  • Endpoint: {{Base URL}}/appointments/{appointable}/{appointable_id}

  • Method: POST

  • Description: Created Appointment

Path Parameters


Parameter

Type

Description

appointable

string

Morph alias of the entity type (e.g. client, application)

appointable_id

integer

ID of the entity


Payload


{

  "title": "Client Consultation",

  "appointment_date": "2026-04-20 10:30:00",

  "appointment_time": "10:30",

  "time_format": "AM",

  "timezone": "Asia/Kolkata",

  "description": "Initial consultation meeting",

  "invitees": [1, 2, 3]

}


Note: invitees is an array of user ids.


Response


{

  "message": "Appointment saved"

}

Did this answer your question?
😞
😐
😁