---
title: Consumers
---

[Skip to content](#_top)

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

[Queues](https://developers.cloudflare.com/api/go/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/go/resources/queues/subresources/consumers/methods/list)

client.Queues.Consumers.List(ctx, queueID, query) (\*SinglePage\[[Consumer](<https://developers.cloudflare.com/api/go/resources/queues#(resource)%20queues.consumers%20%3E%20(model)%20consumer%20%3E%20(schema)>)], error)

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

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

client.Queues.Consumers.Get(ctx, queueID, consumerID, query) (\*[Consumer](<https://developers.cloudflare.com/api/go/resources/queues#(resource)%20queues.consumers%20%3E%20(model)%20consumer%20%3E%20(schema)>), error)

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

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

client.Queues.Consumers.New(ctx, queueID, params) (\*[Consumer](<https://developers.cloudflare.com/api/go/resources/queues#(resource)%20queues.consumers%20%3E%20(model)%20consumer%20%3E%20(schema)>), error)

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

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

client.Queues.Consumers.Update(ctx, queueID, consumerID, params) (\*[Consumer](<https://developers.cloudflare.com/api/go/resources/queues#(resource)%20queues.consumers%20%3E%20(model)%20consumer%20%3E%20(schema)>), error)

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

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

client.Queues.Consumers.Delete(ctx, queueID, consumerID, body) (\*[ConsumerDeleteResponse](<https://developers.cloudflare.com/api/go/resources/queues#(resource)%20queues.consumers%20%3E%20(model)%20ConsumerDeleteResponse%20%3E%20(schema)>), error)

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

##### ModelsExpand Collapse

<details>

<summary>

type Consumer interface{…}

Response body representing a consumer

</summary>

One of the following:

<details>

<summary>

type ConsumerMqWorkerConsumerResponse struct{…}

</summary>

ConsumerID stringOptional

A Resource identifier.

maxLength32

<a href="#(resource)%20queues.consumers%20%3E%20(model)%20consumer%20%3E%20(schema)%20%3E%20(variant)%200%20%3E%20(property)%20consumer_id">Link to this property</a>

CreatedOn TimeOptional

formatdate-time

<a href="#(resource)%20queues.consumers%20%3E%20(model)%20consumer%20%3E%20(schema)%20%3E%20(variant)%200%20%3E%20(property)%20created_on">Link to this property</a>

DeadLetterQueue stringOptional

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

<a href="#(resource)%20queues.consumers%20%3E%20(model)%20consumer%20%3E%20(schema)%20%3E%20(variant)%200%20%3E%20(property)%20dead_letter_queue">Link to this property</a>

QueueName stringOptional

<a href="#(resource)%20queues.consumers%20%3E%20(model)%20consumer%20%3E%20(schema)%20%3E%20(variant)%200%20%3E%20(property)%20queue_name">Link to this property</a>

ScriptName stringOptional

Name of a Worker

<a href="#(resource)%20queues.consumers%20%3E%20(model)%20consumer%20%3E%20(schema)%20%3E%20(variant)%200%20%3E%20(property)%20script_name">Link to this property</a>

<details>

<summary>

Settings ConsumerMqWorkerConsumerResponseSettingsOptional

</summary>

BatchSize float64Optional

The maximum number of messages to include in a batch.

<a href="#(resource)%20queues.consumers%20%3E%20(model)%20consumer%20%3E%20(schema)%20%3E%20(variant)%200%20%3E%20(property)%20settings%20%3E%20(property)%20batch_size">Link to this property</a>

MaxConcurrency float64Optional

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

<a href="#(resource)%20queues.consumers%20%3E%20(model)%20consumer%20%3E%20(schema)%20%3E%20(variant)%200%20%3E%20(property)%20settings%20%3E%20(property)%20max_concurrency">Link to this property</a>

MaxRetries float64Optional

The maximum number of retries

<a href="#(resource)%20queues.consumers%20%3E%20(model)%20consumer%20%3E%20(schema)%20%3E%20(variant)%200%20%3E%20(property)%20settings%20%3E%20(property)%20max_retries">Link to this property</a>

MaxWaitTimeMs float64Optional

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

<a href="#(resource)%20queues.consumers%20%3E%20(model)%20consumer%20%3E%20(schema)%20%3E%20(variant)%200%20%3E%20(property)%20settings%20%3E%20(property)%20max_wait_time_ms">Link to this property</a>

RetryDelay float64Optional

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

<a href="#(resource)%20queues.consumers%20%3E%20(model)%20consumer%20%3E%20(schema)%20%3E%20(variant)%200%20%3E%20(property)%20settings%20%3E%20(property)%20retry_delay">Link to this property</a>

</details>

<a href="#(resource)%20queues.consumers%20%3E%20(model)%20consumer%20%3E%20(schema)%20%3E%20(variant)%200%20%3E%20(property)%20settings">Link to this property</a>

Type ConsumerMqWorkerConsumerResponseTypeOptional

<a href="#(resource)%20queues.consumers%20%3E%20(model)%20consumer%20%3E%20(schema)%20%3E%20(variant)%200%20%3E%20(property)%20type">Link to this property</a>

</details>

<a href="#(resource)%20queues.consumers%20%3E%20(model)%20consumer%20%3E%20(schema)%20%3E%20(variant)%200">Link to this property</a>

<details>

<summary>

type ConsumerMqHTTPConsumerResponse struct{…}

</summary>

ConsumerID stringOptional

A Resource identifier.

maxLength32

<a href="#(resource)%20queues.consumers%20%3E%20(model)%20consumer%20%3E%20(schema)%20%3E%20(variant)%201%20%3E%20(property)%20consumer_id">Link to this property</a>

CreatedOn TimeOptional

formatdate-time

<a href="#(resource)%20queues.consumers%20%3E%20(model)%20consumer%20%3E%20(schema)%20%3E%20(variant)%201%20%3E%20(property)%20created_on">Link to this property</a>

DeadLetterQueue stringOptional

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

<a href="#(resource)%20queues.consumers%20%3E%20(model)%20consumer%20%3E%20(schema)%20%3E%20(variant)%201%20%3E%20(property)%20dead_letter_queue">Link to this property</a>

QueueName stringOptional

<a href="#(resource)%20queues.consumers%20%3E%20(model)%20consumer%20%3E%20(schema)%20%3E%20(variant)%201%20%3E%20(property)%20queue_name">Link to this property</a>

<details>

<summary>

Settings ConsumerMqHTTPConsumerResponseSettingsOptional

</summary>

BatchSize float64Optional

The maximum number of messages to include in a batch.

<a href="#(resource)%20queues.consumers%20%3E%20(model)%20consumer%20%3E%20(schema)%20%3E%20(variant)%201%20%3E%20(property)%20settings%20%3E%20(property)%20batch_size">Link to this property</a>

MaxRetries float64Optional

The maximum number of retries

<a href="#(resource)%20queues.consumers%20%3E%20(model)%20consumer%20%3E%20(schema)%20%3E%20(variant)%201%20%3E%20(property)%20settings%20%3E%20(property)%20max_retries">Link to this property</a>

RetryDelay float64Optional

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

<a href="#(resource)%20queues.consumers%20%3E%20(model)%20consumer%20%3E%20(schema)%20%3E%20(variant)%201%20%3E%20(property)%20settings%20%3E%20(property)%20retry_delay">Link to this property</a>

VisibilityTimeoutMs float64Optional

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

<a href="#(resource)%20queues.consumers%20%3E%20(model)%20consumer%20%3E%20(schema)%20%3E%20(variant)%201%20%3E%20(property)%20settings%20%3E%20(property)%20visibility_timeout_ms">Link to this property</a>

</details>

<a href="#(resource)%20queues.consumers%20%3E%20(model)%20consumer%20%3E%20(schema)%20%3E%20(variant)%201%20%3E%20(property)%20settings">Link to this property</a>

Type ConsumerMqHTTPConsumerResponseTypeOptional

<a href="#(resource)%20queues.consumers%20%3E%20(model)%20consumer%20%3E%20(schema)%20%3E%20(variant)%201%20%3E%20(property)%20type">Link to this property</a>

</details>

<a href="#(resource)%20queues.consumers%20%3E%20(model)%20consumer%20%3E%20(schema)%20%3E%20(variant)%201">Link to this property</a>

</details>

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