Quickstart

This guide will get you all set up and ready to use the OneCal Unified Calendar API. We'll cover how to generate a new API key from your Dashboard and how to send your first request to the API.

Before you can make requests to the Protocol API, you will need to grab your API key from your dashboard. You find it under API Keys from the left navigation menu in your OneCal Unified Dashboard.

Generate an API key

To generate an API key, first log in to your OneCal Unified Dashboard, select your application and navigate to the API Keys page from the left navigation menu.

Click on New API Key.

Give your key a descriptive name, choose the expiration, then click Create.

Once created make sure to copy the key and save it in a secure location. You will not be able to see this key again.

The API Key is meant to be used in a server-only environment. Do not store it or share it in a client-side environment.

Get your App ID

To get your App ID, first log in to your OneCal Unified Dashboard, then navigate to the API Keys page from the left navigation menu. Your App ID is displayed at the top of the page.

The App ID is safe to share in your client-side environment.

Making your first API request

After generating your API key, you are ready to make your first call to the OneCal API. Below, you can see how to send a GET request to the End User Accounts endpoint to get a list of your end user accounts authorized to your application.

GET

/v1/endUserAccounts

curl -G https://api.onecalunified.com/api/v1/endUserAccounts \
  -H "x-api-key: {API KEY}"

Read the docs for the End User Accounts endpoint

What's next?

Great, you're now set up with an API key and have made your first request to the API. Here are a few links that might be handy as you venture further into the OneCal API: