Skip to content

Yumeru API (1.0.0)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server

https://api-docs.yumeru.ai/_mock/openapi/

Usage

Operations

Agents

Operations

Campaigns

Operations

Get booked meetings

Request

Get all booked meetings for a specific organization

Security
BearerAuth
Query
organizationIdstringrequired
startDatestringrequired
endDatestringrequired
campaignIdstring
curl -i -X GET \
  'https://api-docs.yumeru.ai/_mock/openapi/meetings?organizationId=string&startDate=string&endDate=string&campaignId=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Booked meetings retrieved successfully

Bodyapplication/json
calendarBookingsArray of objectsrequired
calendarBookings[].​idnumberrequired
calendarBookings[].​targetEmailstringrequired
calendarBookings[].​calBookingIdstringrequired
calendarBookings[].​scheduledAtstringrequired
calendarBookings[].​bookedAtstringrequired
calendarBookings[].​campaignobject or nullrequired
calendarBookings[].​campaign.​idnumberrequired
calendarBookings[].​campaign.​namestringrequired
calendarBookings[].​targetobject or nullrequired
calendarBookings[].​target.​idnumberrequired
calendarBookings[].​target.​contactobject or nullrequired
calendarBookings[].​target.​contact.​firstNamestring or nullrequired
calendarBookings[].​target.​contact.​lastNamestring or nullrequired
calendarBookings[].​target.​contact.​emailstringrequired
callBookingsArray of objectsrequired
callBookings[].​idstringrequired
callBookings[].​targetEmailstringrequired
callBookings[].​scheduledAtstringrequired
callBookings[].​bookedAtstringrequired
callBookings[].​campaignobject or nullrequired
callBookings[].​campaign.​idnumberrequired
callBookings[].​campaign.​namestringrequired
callBookings[].​targetobject or nullrequired
callBookings[].​target.​idnumberrequired
callBookings[].​target.​contactobject or nullrequired
callBookings[].​target.​contact.​firstNamestring or nullrequired
callBookings[].​target.​contact.​lastNamestring or nullrequired
callBookings[].​target.​contact.​emailstringrequired
Response
application/json
{
  "calendarBookings": [
    { … }
  ],
  "callBookings": [
    { … }
  ]
}

Webhooks

Operations