Get timezones by region
curl --request GET \
--url https://api.inya.ai/platform/v1/agents/config/timezone/{regId} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.inya.ai/platform/v1/agents/config/timezone/{regId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)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>"
}Agent Config API
Get Timezones
Retrieve the list of available timezones for a specific deployment region
GET
/
v1
/
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>'import requests
url = "https://api.inya.ai/platform/v1/agents/config/timezone/{regId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)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>"
}What it does: 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 Agent Builder 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). |
Minimum working example
curl "https://api.inya.ai/platform/v1/agents/config/timezone/asia" \
-H "x-api-key: <your_api_key>"
Additional examples
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)" }
]
}
}
Errors
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 Gnani support to trace a specific request.Authorizations
API key with 'agents' permission
Path Parameters
Region identifier, e.g. 'asia' or 'america'
Was this page helpful?