get
https://api.marketcircle.net/v1/appointments/
List the details of an appointment
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Appointment Attributes
| Attribute Name | Type | Description | Attributes |
|---|---|---|---|
self | reference | URL of the Appointment | Read-only Non-null |
subject | string | Subject | Read-Write Nullable Searchable |
timezone | string | Timezone | Read-Write Nullable Searchable |
all_day | boolean | All day appointment | Read-Write Nullable |
local_start | datetime | Start date of the appointment | Read-Write Nullable |
local_end | datetime | End date of the appointment | Read-Write Nullable |
utc_start | datetime | Start date of the appointment (UTC) | Read-Write Nullable Searchable |
utc_end | datetime | End date of the appointment (UTC) | Read-Write Nullable Searchable |
show_as | string | Appear as "busy" or "free". | Read-Write Non-null |
category | string | Category name | Read-Write Nullable Searchable |
resources | array of string / reference | List of Resources | Read-Write Nullable |
keywords | array of string | List of Keywords | Read-Write Nullable Searchable |
invitations | array of string / reference | List of invitees and their status | Read-Write Nullable Searchable |
contacts | array of string / reference | List of linked Contacts | Read-Write Nullable Searchable |
companies | array of string / reference | List of linked Companies | Read-Write Nullable Searchable |
groups | array of string / reference | List of linked Groups | Read-Write Nullable Searchable |
notes | array of string / reference | List of linked Notes | Read-Write Nullable Searchable |
opportunities | array of string / reference | List of linked Opportunities | Read-Write Nullable Searchable |
projects | array of string / reference | List of linked Projects | Read-Write Nullable Searchable |
tasks | array of string / reference | List of linked Tasks | Read-Write Nullable Searchable |
type | string | The type of appointment. Can be one of appointment, event, outbound_call, inbound_call, chat, vacation, meeting, video | Read-Write Non-null Searchable |
status | string | Status of object. Can be other, tentative, confirmed, postponed, completed, cancelled | Read-Write Non-null Searchable |
location | string | Location | Read-Write Nullable Searchable |
details | string | Details | Read-Write Nullable |
owner | reference | URL of the User that is responsible for the appointment | Read-Write Non-null |
creator | reference | URL of the User that created the appointment | Read-only Non-null |
trashed | boolean | Item in the trash | Read-Write Nullable |
create_date | datetime | Timestamp from when the opportunity was created | Read-only Non-null |
modify_date | datetime | Timestamp from when the opportunity was last updated | Read-only Non-null |
Appointment types
"appointment" | Normal Appointment |
"event" | An event |
"outbound_call" | An outbound call |
"inbound_call" | An inbound call |
"chat" | A chat |
"vacation" | A vacation |
"meeting" | A meeting |
"video" | A video call appointment |
Appointment statuses
"other" | Other type of status |
"tentative" | The Appointment is tentative |
"confirmed" | The Appointment has been confirmed |
"postponed" | The Appointment has been postponed |
"completed" | The Appointment has been completed |
"cancelled" | The Appointment has been cancelled |