Skip to main content
GET
/
v4
/
queue
/
{queueId}
Get queue by ID
curl --request GET \
  --url https://api.example.com/v4/queue/{queueId} \
  --header 'x-meetergo-api-user-id: <api-key>'
import requests

url = "https://api.example.com/v4/queue/{queueId}"

headers = {"x-meetergo-api-user-id": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'x-meetergo-api-user-id': '<api-key>'}};

fetch('https://api.example.com/v4/queue/{queueId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v4/queue/{queueId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-meetergo-api-user-id: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/v4/queue/{queueId}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-meetergo-api-user-id", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/v4/queue/{queueId}")
.header("x-meetergo-api-user-id", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v4/queue/{queueId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-meetergo-api-user-id"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "meetingTypeId": "<string>",
  "companyId": "<string>",
  "userCapacities": [
    {
      "userId": "<string>",
      "capacity": 123
    }
  ],
  "userCustomLinks": [
    {
      "userId": "<string>",
      "link": "<string>"
    }
  ],
  "roundRobinEntries": [
    {
      "id": 123,
      "createdAt": "<string>",
      "userId": "<string>",
      "groupId": "<string>",
      "appointmentId": "<string>",
      "queueId": "<string>",
      "selectionReason": "<string>"
    }
  ],
  "userGroups": [
    {
      "id": "<string>",
      "users": [
        {
          "id": "<string>",
          "givenName": "<string>",
          "familyName": "<string>",
          "slug": "<string>",
          "userType": "<string>",
          "picture": "<string>"
        }
      ],
      "userIds": [
        "<string>"
      ]
    }
  ],
  "userGroupIds": [
    "<string>"
  ],
  "users": [
    {
      "id": "<string>",
      "givenName": "<string>",
      "familyName": "<string>",
      "slug": "<string>",
      "userType": "<string>",
      "picture": "<string>"
    }
  ],
  "userIds": [
    "<string>"
  ],
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "workspaceId": "<string>"
}

Authorizations

x-meetergo-api-user-id
string
header
required

User ID to act on behalf of. Platform API Keys only (required with an API Key unless the endpoint states otherwise). Requests authenticated with a Personal Access Token are rejected if this header names another user.

Path Parameters

queueId
string
required

ID of the queue

Response

200 - application/json

Queue retrieved successfully

id
string
required
type
enum<string>
required

Round robin queue type

Available options:
simpleRoundRobin,
advancedRoundRobin,
equalDistribution
meetingTypeId
string
required
companyId
string
required
userCapacities
object[]
required
roundRobinEntries
object[]
required
userGroups
object[]
required
userGroupIds
string[]
required
users
object[]
required
userIds
string[]
required
createdAt
string
required
updatedAt
string
required
workspaceId
string