Skip to main content
Answer

How to Obtain Required Parameters for Testing the Calendly Scheduled Events API in Postman?

  • October 3, 2024
  • 2 replies
  • 375 views
H

Hello,
I am trying to test the Calendly API endpoint https://api.calendly.com/scheduled_events in Postman to retrieve all scheduled events. Could you please help me understand how to obtain all the necessary parameters, such as the organization, user, and group URIs? Specifically, I'd like to know:

  1. How can I obtain the organization URI for my account?
  2. What is the best way to retrieve the user and group URIs required for this API?
  3. Are there any specific parameters or steps I should follow to ensure I get all events for the organization?

Best answer by tcampb

  1. How can I obtain the organization URI for my account?

    https://api.calendly.com/users/me 

    The endpoint above will return your current organization URI (current_organization property) as well as your user’s URI (uri property)

    https://developer.calendly.com/api-docs/005832c83aeae-get-current-user

     
  2. What is the best way to retrieve the user and group URIs required for this API?

    To retrieve all user URIs you can call the organization memberships endpoint (https://developer.calendly.com/api-docs/eaed2e61a6bc3-list-organization-memberships) with your organization URI from question 1.

    To retrieve all user group URIs you can call the user groups endpoint (https://developer.calendly.com/api-docs/6rb6dtdln74sy-list-groups) with your organization URI from question 1.

     
  3. Are there any specific parameters or steps I should follow to ensure I get all events for the organization?

    As long as you are an organization owner / admin and are using the organization URI query parameter, you can retrieve all scheduled events from the organization.

2 replies

M
Employee
  • mattmanning
  • Employee
  • October 4, 2024

Hi,

You can get your organization and user from the Get Current User endpoint. Those values are sufficient for getting scheduled events for a specific user. If you want to get scheduled events for a group you can use the List Groups endpoint to get a group uri.

Cheers,
Matt

tcampb
Employee
  • tcampb
  • Employee
  • Answer
  • October 4, 2024
  1. How can I obtain the organization URI for my account?

    https://api.calendly.com/users/me 

    The endpoint above will return your current organization URI (current_organization property) as well as your user’s URI (uri property)

    https://developer.calendly.com/api-docs/005832c83aeae-get-current-user

     
  2. What is the best way to retrieve the user and group URIs required for this API?

    To retrieve all user URIs you can call the organization memberships endpoint (https://developer.calendly.com/api-docs/eaed2e61a6bc3-list-organization-memberships) with your organization URI from question 1.

    To retrieve all user group URIs you can call the user groups endpoint (https://developer.calendly.com/api-docs/6rb6dtdln74sy-list-groups) with your organization URI from question 1.

     
  3. Are there any specific parameters or steps I should follow to ensure I get all events for the organization?

    As long as you are an organization owner / admin and are using the organization URI query parameter, you can retrieve all scheduled events from the organization.
Need Help? Visit 'Get Help. Give Help.'
Terms & ConditionsCookie SettingsAccessibility statement