API Reference/Endpoints

Retrieve a calendar

GET/api/linkedin/gateway/calendars/{calendar_id}

Fetches a single calendar by id.

Authentication

Send your personal API key as a bearer token. A missing, malformed or revoked key returns 401.

Path parameters

FieldTypeDescription

calendar_id *stringThe calendar's id.

Query parameters

FieldTypeDescription

account_id *stringThe connected account the calendar belongs to.

Response fields

FieldTypeDescription

object"Calendar"Always this value.

idstringThe calendar's id.

namestringDisplay name.

is_read_onlybooleanWhether events can be created or edited on it.

is_owned_by_userbooleanWhether the connected account owns this calendar.

is_primarybooleanWhether this is the account's primary calendar.

access_rolestringowner, writer, reader or freeBusyReader.

background_colorstringHex color the provider assigns to the calendar.

timezonestringThe calendar's configured timezone.

Errors

·401 Unauthorized. The key is missing, malformed or has been rotated.·403 Forbidden. The account_id doesn't belong to this key.·404 Not Found. No calendar with that id belongs to this account.