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>'
{
  "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 as when using API Key authentication (required with API Key)

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
​
userCustomLinks
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