Qodex.ai

Teamup Calendar API Examples

Number of APIs: 9

This is a Qodex collection of examples showing the use of the Teamup calendar API. This collection includes basic examples meant to help a new API user get started. To keep things simple, not all parameter and options are covered.

These examples complement our reference documentation at apidocs.teamup.com.

Teamup Support: support@teamup.com

Getting Started

Step 1) Fork the collection

To get started fork the collection from [Teamup's public workspace] within Qodex.

The%20button%20to%20start%20the%20process%20of%20forking%20a%20collection%20into%20ones%20own%20workspace

Enter a name for your fork and select the workspace where it will be created:

Fork form

Step 2) Get your API key

To run requests you'll need to supply your secret API key and set it up as a variable of your forked collection.

  1. Go to https://teamup.com/api-keys/request and get your API key.
  2. Open the Variables tab of your forked collection and assign the obtained API key to variable apiKey, as shown below:
Obtain%20and%20supply%20your%20API%20key.

Note that the API key must be submitted with every request as a header with name Teamup-Token. All examples in this collection have this header set up already and it obtains the value from collection variable apiKey.

Step 3) Submit a test requests

You should now be ready to make a first test request. The collection contains a test request with the name Test API. If you sent this request and your API key is set up correctly, you will receive a status code 200 OK, as shown below.

Submit%20a%20test%20request

Step 4) Get a test calendar

Now you are ready to start querying a calendar. You can use your own calendar or a demo calendar from our demo gallery.

All api requests require a calendar identifier or a secret calendar key to address a calendar. It is important to understand these two terms.

  • A calendar identifier is a string of 6 characters that uniquely addresses a calendar. It is used if you plan to authenticate calendar users by username and passwords.
  • A secret calendar key is string of 18 characters that can be used to access a calendar without any user login. When the secret calendar key is part of a URL it forms a secret URL. The technical term for this is a capability URL.
    A calendar can have many secret URLs, each with different permissions. An example of a secret URL is this read-only URL of a demo calendar: https://teamup.com/ksmh1v99y2u1w168qn. In this example, the string ksmh1v99y2u1w168qn is the secret key.

Since secret calendar keys are easy to use and work well for API use cases, we use them here for a first test of the API. To obtain a secret calendar key for your calendar go to Settings -> Sharing of your calendar. Use the button Create link to create a new secret URL or use an existing URL. Extract the secret key from the URL:

A%20secret%20calendar%20key

Now go to the Variables tab of your forked collection and assign the secret calendar key to variable calendarKeyOrId, as shown below:

Step 5) Ready to test the API

You are now ready to use the provided API examples to query your calendar. Currently, the collection contain basic examples of all major API operations like reading events, creating events, updating events and deleting events. Try to get started with example Get events, which reads the events for a specified date range from your calendar.

Note that each example has a documetation with some useful hints on its use. The example documentation can be opened in the right sidebar of Qodex as shown below:

We plan to add more advanced examples in the future. In case you run into any issues, you can reach us at support@teamup.com.

  1. Configuration - Get the calendar configuration GET {{baseUrl}}/:calendarKey/configuration

  2. Test API GET {{baseUrl}}/check-access

  3. Events - Get events GET {{baseUrl}}/:calendarKeyOrId/events?startDate=2024-04-01&endDate=2024-04-07&tz=America/London

  4. Events - Get event GET {{baseUrl}}/:calendarKeyOrId/events/:event_id?tz=Europe/London

  5. Events - Delete event DELETE {{baseUrl}}/:calendarKeyOrId/events/:event_id

  6. Events - Insert event POST {{baseUrl}}/:calendarKeyOrId/events?tz=Europe/London

  7. Events - Update event PUT {{baseUrl}}/:calendarKeyOrId/events/:event_id?tz=Europe/London

  8. Events - Undo PUT {{baseUrl}}/:calendarKeyOrId/events/undo/:undoId

  9. Sub-Calendars - Get sub-calendars GET {{baseUrl}}/:calendarKeyOrId/subcalendars?includeInactive=false