# calendars.getByName

Get calendar by name.

Returns collection details and sync token for a calendar by its URL name slug.

```ts
openemail.calendars.getByName(
  identityId: string,
  name: string,
  options?: CallOptions,
): ApiPromise<PimCollection>
```

It calls `GET /identities/{identityId}/calendars/by-name/{name}`: [Get calendar by name](/docs/api/pim/get_CalendarGetByName) in the API reference.

## Example

```ts
const pimCollection = await openemail.calendars.getByName(identityId, name)
```

## Arguments

| Argument | Type | Description |
| --- | --- | --- |
| `identityId` | `string` | Identity ULID identifier. The path's `{identityId}`. |
| `name` | `string` | The collection's name slug (exact match). The path's `{name}`. |

## Options

It takes no options of its own. 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, [`PimCollection`](/docs/sdks/typescript/types/pim-collection). 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 collection by that name, or mailbox not accessible |
| `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: [`PimCollection`](/docs/sdks/typescript/types/pim-collection).
