Get Timezones

Get timezones by region

curl --request GET \
  --url https://api.inya.ai/platform/v1/agents/config/timezone/{regId} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.inya.ai/platform/v1/agents/config/timezone/{regId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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)"
      }
    ]
  }
}

{
  "status": "failure",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "Region not found"
}

{
  "status": "failure",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "<string>"
}

GET

agents

config

timezone

{regId}

Get timezones by region

curl --request GET \
  --url https://api.inya.ai/platform/v1/agents/config/timezone/{regId} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.inya.ai/platform/v1/agents/config/timezone/{regId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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)"
      }
    ]
  }
}

{
  "status": "failure",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "Region not found"
}

{
  "status": "failure",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "<string>"
}

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

curl "https://api.inya.ai/platform/v1/agents/config/timezone/asia" \
  -H "x-api-key: <your_api_key>"

Americas Region

curl "https://api.inya.ai/platform/v1/agents/config/timezone/america" \
  -H "x-api-key: <your_api_key>"

Response

Success (200)

{
  "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

{
  "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

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.

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

Authorizations

x-api-key

string

header

required

API key with 'agents' permission

Path Parameters

regId

string

required

Region identifier, e.g. 'asia' or 'america'

Response

Timezones retrieved successfully

status

string

Example:

"success"

requestId

string

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

message

string

response

object

Getting Started

Agents API

Conversations API

Agent Config API

Agent FAQ API

Chat SDK API

Reference

Overview

Required Permission

Path Parameters

Example cURL

Asia Region

Americas Region

Response

Success (200)

Error Responses

Response Fields

Use Cases

Authorizations

Path Parameters

Response

​Overview

​Required Permission

​Path Parameters

​Example cURL

​Asia Region

​Americas Region

​Response

​Success (200)

​Error Responses

​Response Fields

​Use Cases

Authorizations

Path Parameters

Response

Overview

Required Permission

Path Parameters

Example cURL

Asia Region

Americas Region

Response

Success (200)

Error Responses

Response Fields

Use Cases