post
https://api.marketcircle.net/v1/appointments/_search
Search for appointments
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
See the search filtering documentation for details about the query syntax. The searchable attributes and the operators each one accepts are listed in the request body below.
Appointment-specific notes
typeandstatustake the values listed on Appointment:
{ "type": { "any": ["meeting", "video"] } }- Times are searched in UTC with
utc_startandutc_end:
{ "utc_start": { "in_range": ["2025-04-01T00:00:00Z", "2025-04-30T23:59:59Z"] } } invitationstake a filter on invitations, by invitee reference or response status:
{ "invitations": { "any": { "invitee": { "equal": "/v1/users/1000" } } } }
{ "invitations": { "any": { "status": { "equal": "accepted" } } } }resourcestake a resource search filter. Match a resource by its ID or name, not its reference:
{ "resources": { "any": { "resource_id": { "equal": 1000 } } } }
{ "resources": { "any": { "name": { "equal": "Boardroom" } } } }- Linked records (
contacts,companies,opportunities,projects,tasks,groups,notes,forms,email_messages) take a search filter for that record type withany, using the linked record's reference:
{ "contacts": { "any": { "contact": { "equal": "/v1/contacts/1000" } } } } categorymatches by name.appointmentandappointment_idmatch the appointment itself, by reference or by numeric ID.