--- title: Consumers --- [Skip to content](#_top) [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]()> 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]() 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]() 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]() 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]() {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 Link to this property created\_on?: string formatdate-time Link to this property dead\_letter\_queue?: string Name of the dead letter queue, or empty string if not configured Link to this property queue\_name?: string Link to this property script\_name?: string Name of a Worker Link to this property

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

batch\_size?: number The maximum number of messages to include in a batch. Link to this property 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). Link to this property max\_retries?: number The maximum number of retries Link to this property max\_wait\_time\_ms?: number The number of milliseconds to wait for a batch to fill up before attempting to deliver it Link to this property retry\_delay?: number The number of seconds to delay before making the message available for another attempt. Link to this property

Link to this property type?: "worker" Link to this property

Link to this property

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

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

batch\_size?: number The maximum number of messages to include in a batch. Link to this property max\_retries?: number The maximum number of retries Link to this property retry\_delay?: number The number of seconds to delay before making the message available for another attempt. Link to this property visibility\_timeout\_ms?: number The number of milliseconds that a message is exclusively leased. After the timeout, the message becomes available for another attempt. Link to this property

Link to this property type?: "http\_pull" Link to this property

Link to this property

[Link to this property](<#(resource)%20queues.consumers%20%3E%20(model)%20consumer%20%3E%20(schema)>)

ConsumerDeleteResponse {errors, messages, success }

errors?: Array<ResponseInfo {code, message, documentation\_url, source } > minLength1

code: number minimum1000 Link to this property message: string Link to this property documentation\_url?: string Link to this property

source?: Source {pointer }

pointer?: string Link to this property

Link to this property

Link to this property messages?: Array<string> Link to this property success?: true Indicates if the API call was successful or not. Link to this property

[Link to this property](<#(resource)%20queues.consumers%20%3E%20(model)%20consumer_delete_response%20%3E%20(schema)>)