---
title: Consumers
---

[Skip to content](#%5Ftop) 

[API Reference](https://developers.cloudflare.com/api/typescript)

[Queues](https://developers.cloudflare.com/api/typescript/resources/queues)

Copy Markdown

Open in **Claude**

Open in **ChatGPT**

Open in **Cursor**

---

**Copy Markdown**

**View as Markdown**

# Consumers

##### [List Queue Consumers](https://developers.cloudflare.com/api/typescript/resources/queues/subresources/consumers/methods/list)

client.queues.consumers.list(stringqueueID, ConsumerListParams { account\_id } params, RequestOptionsoptions?): SinglePage<[Consumer](https://developers.cloudflare.com/api/typescript/resources/queues#%28resource%29%20queues.consumers%20%3E%20%28model%29%20consumer%20%3E%20%28schema%29)\>

GET/accounts/{account\_id}/queues/{queue\_id}/consumers

##### [Get Queue Consumer](https://developers.cloudflare.com/api/typescript/resources/queues/subresources/consumers/methods/get)

client.queues.consumers.get(stringconsumerID, ConsumerGetParams { account\_id, queue\_id } params, RequestOptionsoptions?): [Consumer](https://developers.cloudflare.com/api/typescript/resources/queues#%28resource%29%20queues.consumers%20%3E%20%28model%29%20consumer%20%3E%20%28schema%29)

GET/accounts/{account\_id}/queues/{queue\_id}/consumers/{consumer\_id}

##### [Create a Queue Consumer](https://developers.cloudflare.com/api/typescript/resources/queues/subresources/consumers/methods/create)

client.queues.consumers.create(stringqueueID, ConsumerCreateParamsparams, RequestOptionsoptions?): [Consumer](https://developers.cloudflare.com/api/typescript/resources/queues#%28resource%29%20queues.consumers%20%3E%20%28model%29%20consumer%20%3E%20%28schema%29)

POST/accounts/{account\_id}/queues/{queue\_id}/consumers

##### [Update Queue Consumer](https://developers.cloudflare.com/api/typescript/resources/queues/subresources/consumers/methods/update)

client.queues.consumers.update(stringconsumerID, ConsumerUpdateParamsparams, RequestOptionsoptions?): [Consumer](https://developers.cloudflare.com/api/typescript/resources/queues#%28resource%29%20queues.consumers%20%3E%20%28model%29%20consumer%20%3E%20%28schema%29)

PUT/accounts/{account\_id}/queues/{queue\_id}/consumers/{consumer\_id}

##### [Delete Queue Consumer](https://developers.cloudflare.com/api/typescript/resources/queues/subresources/consumers/methods/delete)

client.queues.consumers.delete(stringconsumerID, ConsumerDeleteParams { account\_id, queue\_id } params, RequestOptionsoptions?): [ConsumerDeleteResponse](https://developers.cloudflare.com/api/typescript/resources/queues#%28resource%29%20queues.consumers%20%3E%20%28model%29%20consumer%5Fdelete%5Fresponse%20%3E%20%28schema%29) { errors, messages, success } 

DELETE/accounts/{account\_id}/queues/{queue\_id}/consumers/{consumer\_id}

##### ModelsExpand Collapse 

Consumer \= MqWorkerConsumerResponse { consumer\_id, created\_on, dead\_letter\_queue, 4 more } | MqHTTPConsumerResponse { consumer\_id, created\_on, dead\_letter\_queue, 3 more } 

Response body representing a consumer

One of the following:

MqWorkerConsumerResponse { consumer\_id, created\_on, dead\_letter\_queue, 4 more } 

consumer\_id?: string

A Resource identifier.

maxLength32

created\_on?: string

formatdate-time

dead\_letter\_queue?: string

Name of the dead letter queue, or empty string if not configured

queue\_name?: string

script\_name?: string

Name of a Worker

settings?: Settings { batch\_size, max\_concurrency, max\_retries, 2 more } 

batch\_size?: number

The maximum number of messages to include in a batch.

max\_concurrency?: number

Maximum number of concurrent consumers that may consume from this Queue. Set to `null` to automatically opt in to the platform’s maximum (recommended).

max\_retries?: number

The maximum number of retries

max\_wait\_time\_ms?: number

The number of milliseconds to wait for a batch to fill up before attempting to deliver it

retry\_delay?: number

The number of seconds to delay before making the message available for another attempt.

type?: "worker"

MqHTTPConsumerResponse { consumer\_id, created\_on, dead\_letter\_queue, 3 more } 

consumer\_id?: string

A Resource identifier.

maxLength32

created\_on?: string

formatdate-time

dead\_letter\_queue?: string

Name of the dead letter queue, or empty string if not configured

queue\_name?: string

settings?: Settings { batch\_size, max\_retries, retry\_delay, visibility\_timeout\_ms } 

batch\_size?: number

The maximum number of messages to include in a batch.

max\_retries?: number

The maximum number of retries

retry\_delay?: number

The number of seconds to delay before making the message available for another attempt.

visibility\_timeout\_ms?: number

The number of milliseconds that a message is exclusively leased. After the timeout, the message becomes available for another attempt.

type?: "http\_pull"

ConsumerDeleteResponse { errors, messages, success } 

errors?: Array<[ResponseInfo](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20response%5Finfo%20%3E%20%28schema%29) { code, message, documentation\_url, source } \>

minLength1

code: number

minimum1000

message: string

documentation\_url?: string

source?: Source { pointer } 

pointer?: string

messages?: Array<string\>

success?: true

Indicates if the API call was successful or not.