Public API

Sessions’ Public API provides a REST API option that uses HTTPS requests and responses. You can use the APIs to automate flows and build new capabilities that best align with your needs.

Accessing the Public APIs

To access Sessions’ Public API, you must generate an API Key (access token), which will be used to invoke APIs.

How to add a Public API Key:

1. Go to your Profile → Account settings.

2. Click on Public API.

3. Click on the New key button.

4. Enter a name for your API key and click Confirm.

5. Your API Key token is generated. Copy and store the token. It won't be available later on.

⚠️

Due to security reasons, you cannot edit your API Key or see the generated token again.

You can revoke (delete) a created API key. Once revoked, that key won't work anymore if the token is used.

Schema

All Sessions’ Public API access is over HTTPS, and can be accessed from https://api.app.sessions.us/api-docs/. All data is sent and received as JSON.

💡

Note: if you have CNAME active, you can use the set api URL instead of the Sessions’ one.

Rate limiting

The Sessions’ Public API uses rate limiting to control API traffic. Currently, the number of allowed requests is 10 per minute. If this is reached, requests will fail with Error Code 429. Details about the allowed requests, remaining requests and number of seconds left in the current period can be found in Headers.

Endpoints available on Sessions’ Public API

For more details regarding the Public API schemas, please check https://api.app.sessions.us/api-docs/.

GET /api/booking-page/{id} -> Returns a specific booking page

PUT /api/booking-page/{id} -> Update a booking page

DELETE /api/booking-page/{id} -> Delete a booking page

GET /api/booking-page -> Returns 20 booking pages for the current user, paginated

POST /api/booking-page -> Create a booking page

GET /api/bookings -> Returns 20 bookings for the current user, paginated

POST /api/bookings -> Create a booking

PUT /api/bookings/{id} -> Update a booking

POST /api/bookings/{id} -> Cancel a booking

DELETE /api/bookings/{id} -> Delete a booking

GET /api/sessions/{id} -> Returns a specific session.

PUT /api/sessions/{id} -> Update a session

DELETE /api/sessions/{id} -> Delete a session

GET /api/sessions -> Returns 20 sessions for the current user, paginated

POST /api/sessions -> Create a session

GET /api/sessions/{id}/participants -> Returns a specific session’s participants.

POST /api/sessions/{id}/participants -> Add participants to session

PUT /api/sessions/{id}/participants -> Update participants from session

DELETE /api/sessions/{id}/participants -> Delete participants from session

GET /api/sessions/{id}/takeaways -> Get session takeaways.

GET /api/sessions/{id}/transcripts -> Get session transcripts.