# calendarObjects.get

Get calendar object.

Returns a calendar object in raw text/calendar format, or as JSCalendar JSON (RFC 8984) when requested with Accept: application/json.

```ts
openemail.calendarObjects.get(
  identityId: string,
  calendarId: string,
  href: string,
  options?: CalendarObjectsGetOptions,
): ApiPromise<PimObjectJson>
```

It calls `GET /identities/{identityId}/calendars/{calendarId}/objects/{href}`: [Get calendar object](/docs/api/pim/get_CalendarObjectGet) in the API reference.

## Example

```ts
const pimObjectJson = await openemail.calendarObjects.get(identityId, calendarId, href)
```

## Arguments

| Argument | Type | Description |
| --- | --- | --- |
| `identityId` | `string` | Mailbox identity ULID. The path's `{identityId}`. |
| `calendarId` | `string` | Collection ULID or its name slug. The path's `{calendarId}`. |
| `href` | `string` | The object's href: its filename segment within the collection (e.g. 1a2b3c.ics). The path's `{href}`. |

## Options

The last argument, `options`, a `CalendarObjectsGetOptions`, takes:

| Option | Type | Sent as | Description |
| --- | --- | --- | --- |
| `uid` | `string` | query `uid` | Look up object by UID instead of href slug |

Every call also takes `signal`, `timeout`, `retry` and `headers`, which say how that one call is sent ([call options](/docs/sdks/typescript/calling-methods#call-options)).

## Answer

Awaited, it is the API's JSON, [`PimObjectJson`](/docs/sdks/typescript/types/pim-object-json). It is an [`ApiPromise`](/docs/sdks/typescript/responses): `.withResponse()` gives the same with the `Response` it came in, for its headers.

## Errors

| Status | What it means |
| --- | --- |
| `401` | unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a `WWW-Authenticate: Bearer` challenge |
| `404` | No such object, collection, or mailbox |
| `503` | temporary_failure: the platform's storage could not answer just now; retry after the Retry-After window. Any operation can answer this. A write that got it may have been applied, so retry it with the same idempotency key where it takes one, or read the state back first (see Transient failures in the API description) |

A failed call rejects with a [`RequestError`](/docs/sdks/typescript/errors): its `status`, and its `code`, the API's `error`. Decide on the code: one status covers several.

## Types

It names these types of the API, each on a page of its own: [`PimObjectJson`](/docs/sdks/typescript/types/pim-object-json).
