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

# Get Timezones

> Retrieve the list of available timezones for a specific deployment region

## Overview

Retrieve all IANA timezone identifiers available within a specific deployment region. Use the `regId` returned by **Get Regions** to load the timezone options for that region. The selected timezone controls how the Inya platform interprets scheduled events, analytics timestamps, and call scheduling.

## Required Permission

`agents`

## Path Parameters

| Name    | Type   | Required | Description                                                                |
| ------- | ------ | -------- | -------------------------------------------------------------------------- |
| `regId` | string | Yes      | Region identifier from **Get Regions** (e.g. `asia`, `america`, `europe`). |

## Example cURL

### Asia Region

```bash theme={null}
curl "https://api.inya.ai/platform/v1/agents/config/timezone/asia" \
  -H "x-api-key: <your_api_key>"
```

### Americas Region

```bash theme={null}
curl "https://api.inya.ai/platform/v1/agents/config/timezone/america" \
  -H "x-api-key: <your_api_key>"
```

## Response

### Success (200)

```json theme={null}
{
  "status": "success",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "Timezones retrieved successfully",
  "response": {
    "timezones": [
      { "timeId": "Asia/Kolkata", "name": "Indian Standard Time (IST)" },
      { "timeId": "Asia/Singapore", "name": "Singapore Standard Time (SST)" },
      { "timeId": "Asia/Tokyo", "name": "Japan Standard Time (JST)" },
      { "timeId": "Asia/Dubai", "name": "Gulf Standard Time (GST)" },
      { "timeId": "Asia/Bangkok", "name": "Indochina Time (ICT)" }
    ]
  }
}
```

### Error Responses

**404 Not Found** - Invalid or unrecognized region identifier

```json theme={null}
{
  "status": "failure",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "Region not found"
}
```

## Response Fields

| Field                | Type   | Description                                                                                                               |
| -------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------- |
| `timezones[].timeId` | string | IANA timezone identifier (e.g. `Asia/Kolkata`). Use this as the `timeZone` field in **Create Agent** or **Update Agent**. |
| `timezones[].name`   | string | Human-readable timezone name with abbreviation (e.g. `Indian Standard Time (IST)`).                                       |

## Use Cases

* Building a cascading region → timezone selector in an agent creation UI
* Validating timezone values before sending a **Create Agent** or **Update Agent** request
* Displaying timezone context in an agent settings dashboard

<Tip>
  Build a cascading selection flow: call **Get Regions** first to let the user pick a region, then call this endpoint to populate the timezone dropdown with the relevant options for that region.
</Tip>

<Note>
  Save the `requestId` from every response. You will need it if you contact Inya support to trace a specific request.
</Note>


## OpenAPI

````yaml GET /v1/agents/config/timezone/{regId}
openapi: 3.0.3
info:
  title: Platform Agent Config API
  description: >-
    Read-only endpoints for discovering valid configuration values — languages,
    regions, timezones, LLM models, ASR providers, and TTS voices — before
    creating or updating agents.
  version: 2.1.0
servers:
  - url: https://api.inya.ai/platform
    description: Production server
security:
  - ApiKeyAuth: []
tags:
  - name: AgentConfiguration
    description: Agent configuration discovery operations
paths:
  /v1/agents/config/timezone/{regId}:
    get:
      tags:
        - AgentConfiguration
      summary: Get timezones by region
      description: Retrieve all IANA timezone identifiers available for a given region.
      operationId: getTimezones
      parameters:
        - $ref: '#/components/parameters/RegionId'
      responses:
        '200':
          description: Timezones retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
              examples:
                success:
                  value:
                    status: success
                    requestId: a1b2c3d4-e5f6-7890-abcd-ef1234567890
                    message: Timezones retrieved successfully
                    response:
                      timezones:
                        - timeId: Asia/Kolkata
                          name: Indian Standard Time (IST)
                        - timeId: Asia/Singapore
                          name: Singapore Standard Time (SST)
                        - timeId: Asia/Tokyo
                          name: Japan Standard Time (JST)
        '404':
          description: Region not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                notFound:
                  value:
                    status: failure
                    requestId: a1b2c3d4-e5f6-7890-abcd-ef1234567890
                    message: Region not found
        '500':
          $ref: '#/components/responses/ServerError'
components:
  parameters:
    RegionId:
      name: regId
      in: path
      required: true
      description: Region identifier, e.g. 'asia' or 'america'
      schema:
        type: string
  schemas:
    StandardResponse:
      type: object
      properties:
        status:
          type: string
          example: success
        requestId:
          type: string
          example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
        message:
          type: string
        response:
          type: object
    ErrorResponse:
      type: object
      properties:
        status:
          type: string
          example: failure
        requestId:
          type: string
          example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
        message:
          type: string
  responses:
    ServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key with 'agents' permission

````