> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Luma: Get V1 Organizations Calendars List

> List all calendars belonging to the organization. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

List all calendars belonging to the organization.

> [!NOTE]
>
> Tool ID: `luma_get_v1_organizations_calendars_list`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'luma_get_v1_organizations_calendars_list',
  {
    "pagination_cursor": "cursor_123",
    "pagination_limit": 123
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute luma_get_v1_organizations_calendars_list --input '{
  "pagination_cursor": "cursor_123",
  "pagination_limit": 123
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "entries": [
      {
        "id": "id_123",
        "name": "Example",
        "slug": "example",
        "avatar_url": "https://example.com",
        "url": "https://example.com",
        "description": "Example description",
        "social_image_url": "https://example.com",
        "cover_image_url": "https://example.com",
        "is_personal": true,
        "location": {
          "city": "San Francisco",
          "region": "example",
          "country": "US",
          "country_code": "example",
          "timezone": "America/New_York"
        },
        "coordinate": {
          "longitude": 123,
          "latitude": 123
        },
        "instagram_handle": "example",
        "twitter_handle": "example",
        "youtube_handle": "example",
        "website": "https://example.com"
      }
    ],
    "has_more": true
  }
}
```

Use `deepline describe luma_get_v1_organizations_calendars_list --json` for the latest machine-readable contract.

## Input reference

List all calendars belonging to the organization.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.pagination_cursor` | `string` | No | — | Value of `next_cursor` from a previous request. |
| `payload.pagination_limit` | `number` | No | — | The number of items to return. The server will enforce a maximum number. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "List all calendars belonging to the organization.",
    "properties": {
      "pagination_cursor": {
        "type": "string",
        "description": "Value of `next_cursor` from a previous request."
      },
      "pagination_limit": {
        "type": "number",
        "description": "The number of items to return. The server will enforce a maximum number."
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.entries` | `array` | Yes | — | — |
| `result.data.entries[].id` | `string` | Yes | — | — |
| `result.data.entries[].name` | `string` | Yes | — | — |
| `result.data.entries[].slug` | `string \| null` | Yes | — | — |
| `result.data.entries[].avatar_url` | `string \| null` | Yes | — | — |
| `result.data.entries[].url` | `string` | Yes | — | — |
| `result.data.entries[].description` | `string \| null` | Yes | — | — |
| `result.data.entries[].social_image_url` | `string \| null` | Yes | — | — |
| `result.data.entries[].cover_image_url` | `string \| null` | Yes | — | — |
| `result.data.entries[].is_personal` | `boolean` | Yes | — | — |
| `result.data.entries[].location` | `object \| null` | Yes | — | City the calendar is based in (e.g. for city calendars). Null when the calendar isn't tied to a place. |
| `result.data.entries[].location.city` | `string` | Yes | — | City name, e.g. 'New York'. |
| `result.data.entries[].location.region` | `string \| null` | Yes | — | State or province, e.g. 'New York' or 'California'. |
| `result.data.entries[].location.country` | `string \| null` | Yes | — | Country name, e.g. 'United States'. Null for cities in disputed territories where Google omits the country. |
| `result.data.entries[].location.country_code` | `string \| null` | Yes | — | ISO 3166-1 alpha-2 country code, e.g. 'US'. |
| `result.data.entries[].location.timezone` | `string` | Yes | — | IANA timezone of the city, e.g. 'America/New\_York'. |
| `result.data.entries[].coordinate` | `object \| null` | Yes | — | Latitude and longitude of the calendar's primary location (e.g. city calendars). Null when the calendar isn't tied to a place. |
| `result.data.entries[].coordinate.longitude` | `number` | Yes | — | — |
| `result.data.entries[].coordinate.latitude` | `number` | Yes | — | — |
| `result.data.entries[].instagram_handle` | `string \| null` | Yes | — | — |
| `result.data.entries[].twitter_handle` | `string \| null` | Yes | — | — |
| `result.data.entries[].youtube_handle` | `string \| null` | Yes | — | — |
| `result.data.entries[].website` | `string \| null` | Yes | — | — |
| `result.data.has_more` | `boolean` | Yes | — | — |
| `result.data.next_cursor` | `string` | No | — | — |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "entries": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "slug": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "avatar_url": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "url": {
                  "type": "string"
                },
                "description": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "social_image_url": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "cover_image_url": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "is_personal": {
                  "type": "boolean"
                },
                "location": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "description": "City the calendar is based in (e.g. for city calendars). Null when the calendar isn't tied to a place.",
                  "properties": {
                    "city": {
                      "type": "string",
                      "description": "City name, e.g. 'New York'."
                    },
                    "region": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "State or province, e.g. 'New York' or 'California'."
                    },
                    "country": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "Country name, e.g. 'United States'. Null for cities in disputed territories where Google omits the country."
                    },
                    "country_code": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "ISO 3166-1 alpha-2 country code, e.g. 'US'."
                    },
                    "timezone": {
                      "type": "string",
                      "description": "IANA timezone of the city, e.g. 'America/New_York'."
                    }
                  },
                  "required": [
                    "city",
                    "region",
                    "country",
                    "country_code",
                    "timezone"
                  ],
                  "additionalProperties": false
                },
                "coordinate": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "description": "Latitude and longitude of the calendar's primary location (e.g. city calendars). Null when the calendar isn't tied to a place.",
                  "properties": {
                    "longitude": {
                      "type": "number"
                    },
                    "latitude": {
                      "type": "number"
                    }
                  },
                  "required": [
                    "longitude",
                    "latitude"
                  ],
                  "additionalProperties": false
                },
                "instagram_handle": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "twitter_handle": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "youtube_handle": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "website": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "required": [
                "id",
                "name",
                "slug",
                "avatar_url",
                "url",
                "description",
                "social_image_url",
                "cover_image_url",
                "is_personal",
                "location",
                "coordinate",
                "instagram_handle",
                "twitter_handle",
                "youtube_handle",
                "website"
              ],
              "additionalProperties": false
            }
          },
          "has_more": {
            "type": "boolean"
          },
          "next_cursor": {
            "type": "string"
          }
        },
        "required": [
          "entries",
          "has_more"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Luma provider guide](https://deepline.com/docs/providers/luma/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.