---
title: "Get a queue and its approximate counts"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.ezghcloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Queues API

`GET /v1/organizations/{orgId}/projects/{projectId}/queues/{queueId}`

## Authentication

Requires one of the following:

- `apiKey`, http, header `Authorization`
- `oauth`, http, header `Authorization`
- `sessionCookie`, apiKey, in cookie

## Path parameters

- `GetQueue.path.orgId` (string, required)
  - format `uuid`
- `GetQueue.path.projectId` (string, required)
  - format `uuid`
- `GetQueue.path.queueId` (string, required)
  - format `uuid`

## Code samples

### cURL

```curl
curl --request GET \
  --url https://queues-api.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/queues/497f6eca-6276-4993-bfeb-53cbbbba6f08 \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://queues-api.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/queues/497f6eca-6276-4993-bfeb-53cbbbba6f08';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://queues-api.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/queues/497f6eca-6276-4993-bfeb-53cbbbba6f08"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)
```

## Responses

### 200

The queue.

#### Example

```json
{
  "contentBasedDedup": false,
  "counts": {
    "delayed": 0,
    "inFlight": 0,
    "truncated": true,
    "visible": 0
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "delaySeconds": 0,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "organizationId": "string",
  "partitions": 1,
  "projectId": "string",
  "receiveWaitSeconds": 0,
  "redrive": {
    "deadLetterQueue": "c2dca0ef-30c5-45c0-a6f1-19982b5212bb",
    "maxReceiveCount": 1
  },
  "resourceName": "string",
  "retentionSeconds": 345600,
  "slug": "string",
  "tags": {
    "property1": "string",
    "property2": "string"
  },
  "type": "standard",
  "updatedAt": "2019-08-24T14:15:22Z",
  "visibilityTimeoutSeconds": 30
}
```

- `GetQueue.response.200.contentBasedDedup` (boolean, required) — FIFO only: a message without a dedupId is deduplicated by the SHA-256 of its body.
  - default `false`
- `GetQueue.response.200.counts` (object, required) — Approximate message counts. Each is exact up to 100,000; beyond that truncated is true.
  - `GetQueue.response.200.counts.delayed` (integer, required)
    - min 0
  - `GetQueue.response.200.counts.inFlight` (integer, required)
    - min 0
  - `GetQueue.response.200.counts.truncated` (boolean, required)
  - `GetQueue.response.200.counts.visible` (integer, required)
    - min 0
- `GetQueue.response.200.createdAt` (string, required)
  - format `date-time`
- `GetQueue.response.200.delaySeconds` (integer, required) — The queue's default delivery delay.
  - min 0; max 900; default `0`
- `GetQueue.response.200.id` (string, required)
  - format `uuid`
- `GetQueue.response.200.name` (string, required) — Unique in the project; fixed at creation.
  - pattern `^[A-Za-z0-9_-]{1,80}$`
- `GetQueue.response.200.organizationId` (string, required)
- `GetQueue.response.200.partitions` (integer, required) — The queue's partitions: 1 at creation, raised automatically with its send rate, at most 64.
  - min 1; max 64
- `GetQueue.response.200.projectId` (string, required)
- `GetQueue.response.200.receiveWaitSeconds` (integer, required) — The default long-poll wait of a receive.
  - min 0; max 20; default `0`
- `GetQueue.response.200.redrive` (one of, required)
  - one of: [RedrivePolicy](/queues-api/schemas/RedrivePolicy/), `null`
- `GetQueue.response.200.resourceName` (string, required)
- `GetQueue.response.200.retentionSeconds` (integer, required) — How long a message is kept after it's sent.
  - min 60; max 1209600; default `345600`
- `GetQueue.response.200.slug` (string, required) — que_ and 12 characters.
- `GetQueue.response.200.tags` (map<string>, required) — At most 50; keys 1-128 characters, values at most 256, keys starting with ezgh: are reserved.
- `GetQueue.response.200.type` (unknown, required) — standard: at-least-once, best-effort order. fifo: strict order per message group and send deduplication. Fixed at creation.
  - one of `"standard"`, `"fifo"`
- `GetQueue.response.200.updatedAt` (string, required)
  - format `date-time`
- `GetQueue.response.200.visibilityTimeoutSeconds` (integer, required) — How long a received message stays hidden from other receivers.
  - min 0; max 43200; default `30`

### 400

invalid_request (with issues), invalid_cursor, or the endpoint's own 400 codes.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetQueue.response.400.error` (object, required)
  - `GetQueue.response.400.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetQueue.response.400.error.message` (string, required)
    - maxLength 1024
  - `GetQueue.response.400.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetQueue.response.400.error.issues.message` (string, required)
    - `GetQueue.response.400.error.issues.path` (string, required)
  - `GetQueue.response.400.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetQueue.response.400.error.quota.id` (string, required)
    - `GetQueue.response.400.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetQueue.response.400.error.quota.limit` (integer, required)
      - min 0
    - `GetQueue.response.400.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetQueue.response.400.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetQueue.response.400.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetQueue.response.400.error.quota.region` (string, optional)
    - `GetQueue.response.400.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetQueue.response.400.error.quota.scopeResourceName` (string, optional)
    - `GetQueue.response.400.error.quota.used` (integer, optional)
      - min 0
    - `GetQueue.response.400.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 401

unauthenticated: no credential, or one that doesn't check out.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetQueue.response.401.error` (object, required)
  - `GetQueue.response.401.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetQueue.response.401.error.message` (string, required)
    - maxLength 1024
  - `GetQueue.response.401.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetQueue.response.401.error.issues.message` (string, required)
    - `GetQueue.response.401.error.issues.path` (string, required)
  - `GetQueue.response.401.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetQueue.response.401.error.quota.id` (string, required)
    - `GetQueue.response.401.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetQueue.response.401.error.quota.limit` (integer, required)
      - min 0
    - `GetQueue.response.401.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetQueue.response.401.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetQueue.response.401.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetQueue.response.401.error.quota.region` (string, optional)
    - `GetQueue.response.401.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetQueue.response.401.error.quota.scopeResourceName` (string, optional)
    - `GetQueue.response.401.error.quota.used` (integer, optional)
      - min 0
    - `GetQueue.response.401.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 403

access_denied: the caller's policies don't allow the action; forbidden_origin: a cookie-authenticated write from an origin that isn't allowed; spend_limit_reached.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetQueue.response.403.error` (object, required)
  - `GetQueue.response.403.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetQueue.response.403.error.message` (string, required)
    - maxLength 1024
  - `GetQueue.response.403.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetQueue.response.403.error.issues.message` (string, required)
    - `GetQueue.response.403.error.issues.path` (string, required)
  - `GetQueue.response.403.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetQueue.response.403.error.quota.id` (string, required)
    - `GetQueue.response.403.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetQueue.response.403.error.quota.limit` (integer, required)
      - min 0
    - `GetQueue.response.403.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetQueue.response.403.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetQueue.response.403.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetQueue.response.403.error.quota.region` (string, optional)
    - `GetQueue.response.403.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetQueue.response.403.error.quota.scopeResourceName` (string, optional)
    - `GetQueue.response.403.error.quota.used` (integer, optional)
      - min 0
    - `GetQueue.response.403.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 404

not_found: unknown, malformed, or in an organization the caller isn't in.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetQueue.response.404.error` (object, required)
  - `GetQueue.response.404.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetQueue.response.404.error.message` (string, required)
    - maxLength 1024
  - `GetQueue.response.404.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetQueue.response.404.error.issues.message` (string, required)
    - `GetQueue.response.404.error.issues.path` (string, required)
  - `GetQueue.response.404.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetQueue.response.404.error.quota.id` (string, required)
    - `GetQueue.response.404.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetQueue.response.404.error.quota.limit` (integer, required)
      - min 0
    - `GetQueue.response.404.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetQueue.response.404.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetQueue.response.404.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetQueue.response.404.error.quota.region` (string, optional)
    - `GetQueue.response.404.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetQueue.response.404.error.quota.scopeResourceName` (string, optional)
    - `GetQueue.response.404.error.quota.used` (integer, optional)
      - min 0
    - `GetQueue.response.404.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 429

too_many_requests, with Retry-After; or quota_exceeded (a rate, usage or concurrency quota, with quota), never with Retry-After.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetQueue.response.429.error` (object, required)
  - `GetQueue.response.429.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetQueue.response.429.error.message` (string, required)
    - maxLength 1024
  - `GetQueue.response.429.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetQueue.response.429.error.issues.message` (string, required)
    - `GetQueue.response.429.error.issues.path` (string, required)
  - `GetQueue.response.429.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetQueue.response.429.error.quota.id` (string, required)
    - `GetQueue.response.429.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetQueue.response.429.error.quota.limit` (integer, required)
      - min 0
    - `GetQueue.response.429.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetQueue.response.429.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetQueue.response.429.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetQueue.response.429.error.quota.region` (string, optional)
    - `GetQueue.response.429.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetQueue.response.429.error.quota.scopeResourceName` (string, optional)
    - `GetQueue.response.429.error.quota.used` (integer, optional)
      - min 0
    - `GetQueue.response.429.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 500

internal_error: a bug; the details are in the logs, under the request ID.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetQueue.response.500.error` (object, required)
  - `GetQueue.response.500.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetQueue.response.500.error.message` (string, required)
    - maxLength 1024
  - `GetQueue.response.500.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetQueue.response.500.error.issues.message` (string, required)
    - `GetQueue.response.500.error.issues.path` (string, required)
  - `GetQueue.response.500.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetQueue.response.500.error.quota.id` (string, required)
    - `GetQueue.response.500.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetQueue.response.500.error.quota.limit` (integer, required)
      - min 0
    - `GetQueue.response.500.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetQueue.response.500.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetQueue.response.500.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetQueue.response.500.error.quota.region` (string, optional)
    - `GetQueue.response.500.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetQueue.response.500.error.quota.scopeResourceName` (string, optional)
    - `GetQueue.response.500.error.quota.used` (integer, optional)
      - min 0
    - `GetQueue.response.500.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 503

unavailable: a dependency the request needs is down. Retry after Retry-After.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetQueue.response.503.error` (object, required)
  - `GetQueue.response.503.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetQueue.response.503.error.message` (string, required)
    - maxLength 1024
  - `GetQueue.response.503.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetQueue.response.503.error.issues.message` (string, required)
    - `GetQueue.response.503.error.issues.path` (string, required)
  - `GetQueue.response.503.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetQueue.response.503.error.quota.id` (string, required)
    - `GetQueue.response.503.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetQueue.response.503.error.quota.limit` (integer, required)
      - min 0
    - `GetQueue.response.503.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetQueue.response.503.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetQueue.response.503.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetQueue.response.503.error.quota.region` (string, optional)
    - `GetQueue.response.503.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetQueue.response.503.error.quota.scopeResourceName` (string, optional)
    - `GetQueue.response.503.error.quota.used` (integer, optional)
      - min 0
    - `GetQueue.response.503.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.


Source: https://docs.ezghcloud.com/queues-api/GetQueue/index.md