API reference · v1.0.0

API reference

Generated from the same specification the API serves, so it always matches what the service does. Download it to generate a client in your language: openapi.yaml.

Base URL https://meetings.auraplatform.org/v1/external · Authentication Authorization: Bearer <key id>.<secret>

Endpoints

Method	Path	What it does
GET	`/tenants/{tenantRef}`	Look up a customer
POST	`/tenants`	Add a customer
POST	`/tenants/{tenantRef}/identities`	Give a customer a meeting address
POST	`/meetings`	Book a meeting
GET	`/meetings/{externalId}`	Read a meeting
POST	`/meetings/{externalId}/reschedule`	Reschedule a meeting
POST	`/meetings/{externalId}/cancel`	Cancel a meeting
GET	`/meetings/{externalId}/events`	Read a meeting’s updates

GET/tenants/{tenantRef}

Look up a customer. Returns the customer, whether it is active, and all of its meeting addresses.

Parameter	In	About
`tenantRef`	path	Your own reference for the customer.

Responses: 200 401 404 500

POST/tenants

Add a customer. Adds one of the businesses you serve. Sending the same reference again returns the same customer, so a retry is always safe.

Request body

Field	Required	About
`tenantRef`	Yes	Your own reference for the customer.
`displayName`	Yes	A name people will recognise.

Responses: 200 401 422 500

POST/tenants/{tenantRef}/identities

Give a customer a meeting address. Creates a lasting, bookable address with a host, a default length and a timezone. A taken address is refused, never changed.

Parameter	In	About
`tenantRef`	path	Your own reference for the customer.

Request body

Field	Required	About
`address`	Yes	The address you want, such as northwind-sales: 3 to 64 lowercase characters and hyphens.
`assignedHostUserId`	Yes	The Aura member who hosts meetings booked here.
`meetingTitle`		The default title for meetings booked here.
`durationMinutes`		Length in minutes. 30 if left out.
`timezone`		The timezone for this address, such as America/New_York. UTC if left out.

Responses: 201 401 409 422 500

POST/meetings

Book a meeting. Books a meeting for a customer and invites the people you name. The same idempotency key never books a second meeting.

Request body

Field	Required	About
`tenantRef`	Yes	Your own reference for the customer.
`identityAddress`		Which of the customer’s meeting addresses to use. The default address if left out.
`consumerMeetingRef`		Your own reference for the meeting. Aura keeps it for you.
`title`	Yes	The meeting’s title.
`scheduledAt`		When the meeting starts, in ISO 8601. Leave it out to let the guest choose.
`durationMinutes`		Length in minutes. 30 if left out.
`invitees`	Yes	The people to invite, each with an email and, optionally, a name.
`idempotencyKey`	Yes	Your unique key for this request. Repeating it never repeats the action.

Responses: 200 201 401 422 500

GET/meetings/{externalId}

Read a meeting. The meeting as it is right now, guest by guest.

Parameter	In	About
`externalId`	path	Aura’s id for the meeting, returned when you book it.

Responses: 200 401 404 500

POST/meetings/{externalId}/reschedule

Reschedule a meeting. Moves the meeting to a new time. Everyone invited is told.

Parameter	In	About
`externalId`	path	Aura’s id for the meeting, returned when you book it.

Request body

Field	Required	About
`scheduledAt`	Yes	When the meeting starts, in ISO 8601. Leave it out to let the guest choose.
`idempotencyKey`	Yes	Your unique key for this request. Repeating it never repeats the action.

Responses: 200 401 404 409 500

POST/meetings/{externalId}/cancel

Cancel a meeting. Calls the meeting off. Everyone invited is told.

Parameter	In	About
`externalId`	path	Aura’s id for the meeting, returned when you book it.

Request body

Field	Required	About
`reason`		Why it was cancelled, kept with the meeting.
`idempotencyKey`	Yes	Your unique key for this request. Repeating it never repeats the action.

Responses: 200 401 404 409 500

GET/meetings/{externalId}/events

Read a meeting’s updates. Returns the meeting’s updates after a sequence number, with the same ids the live deliveries carried. Keep reading while hasMore is true.

Parameter	In	About
`externalId`	path	Aura’s id for the meeting, returned when you book it.
`afterSequence`	query	Return updates after this number. 0 or left out starts from the beginning.
`limit`	query	How many updates to return, up to 500. 100 if left out.

Responses: 200 401 404 500

Statuses and updates

Meeting status

SCHEDULEDACTIVEENDEDCANCELLED

Guest status

INVITEDINVITATION_ACCEPTEDINVITATION_DECLINEDJOINEDLEFTNO_SHOW

Update types

MEETING_CREATEDINVITATION_ISSUEDINVITATION_ACCEPTEDINVITATION_DECLINEDMEETING_RESCHEDULEDMEETING_CANCELLEDPARTICIPANT_JOINEDMEETING_STARTEDMEETING_ENDEDPARTICIPANT_NO_SHOW

Error codes

MEETING_NOT_FOUNDMEETING_NOT_MUTABLEPARTICIPANT_INVALIDPROVIDER_UNAVAILABLEUNAUTHORIZEDTENANT_NOT_FOUNDTENANT_NOT_ACTIVEADDRESS_TAKENADDRESS_INVALIDHOST_NOT_FOUNDIDENTITY_NOT_FOUND

← Errors