Skip to main content
GET
/
api
/
v1
/
worker-queues
/
{queue_id}
Get Worker Queue
curl --request GET \
  --url https://control-plane.kubiya.ai/api/v1/worker-queues/{queue_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "organization_id": "<string>",
  "environment_id": "<string>",
  "name": "<string>",
  "display_name": "<string>",
  "description": "<string>",
  "status": "<string>",
  "max_workers": 123,
  "heartbeat_interval": 123,
  "tags": [
    "<string>"
  ],
  "settings": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "task_queue_name": "<string>",
  "active_workers": 0
}

Authorizations

​
Authorization
string
header
required

Enter your Kubiya API token (format: Bearer )

Path Parameters

​
queue_id
string
required

Response

Successful Response

​
id
string
required
​
organization_id
string
required
​
environment_id
string
required
​
name
string
required
​
display_name
string | null
required
​
description
string | null
required
​
status
string
required
​
max_workers
integer | null
required
​
heartbeat_interval
integer
required
​
tags
string[]
required
​
settings
Settings · object
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
created_by
string | null
required
​
task_queue_name
string
required
​
active_workers
integer
default:0