---
title: Pull Queue Messages
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api)
[Queues](https://developers.cloudflare.com/api/resources/queues)
[Messages](https://developers.cloudflare.com/api/resources/queues/subresources/messages)
Copy Markdown
Open in **Claude**Open in **ChatGPT**Open in **Cursor**
---
**Copy Markdown****View as Markdown**
# Pull Queue Messages
POST/accounts/{account\_id}/queues/{queue\_id}/messages/pull
Pulls a batch of messages from a Queue for an HTTP pull consumer.
##### Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
**Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
**Example:**X-Auth-Email: user@example.com
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
**Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required)
`Queues Write``Workers Scripts Write`
##### P ath ParametersExpand Collapse
account\_id: string
A Resource identifier.
maxLength32
[Link to this property](<#(resource)%20queues.messages%20%3E%20(method)%20pull%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>)
queue\_id: string
A Resource identifier.
maxLength32
[Link to this property](<#(resource)%20queues.messages%20%3E%20(method)%20pull%20%3E%20(params)%20default%20%3E%20(param)%20queue_id%20%3E%20(schema)>)
##### Body ParametersJSONExpand Collapse
batch\_size: optional number
The maximum number of messages to include in a batch.
[Link to this property](<#(resource)%20queues.messages%20%3E%20(method)%20pull%20%3E%20(params)%200%20%3E%20(param)%20batch_size%20%3E%20(schema)>)
visibility\_timeout\_ms: optional 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](<#(resource)%20queues.messages%20%3E%20(method)%20pull%20%3E%20(params)%200%20%3E%20(param)%20visibility_timeout_ms%20%3E%20(schema)>)
##### ReturnsExpand Collapse
errors: optional array of ResponseInfo { code, message, documentation\_url, source }
minLength1
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20queues.messages%20%3E%20(method)%20pull%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)
messages: optional array of string
[Link to this property](<#(resource)%20queues.messages%20%3E%20(method)%20pull%20%3E%20(network%20schema)%20%3E%20(property)%20messages>)
result: optional object {message\_backlog\_count, messages, metadata }
message\_backlog\_count: optional number
The number of unacknowledged messages in the queue.
Link to this property
messages: optional array of object {id, attempts, body, 3 more }
id: optional string
Link to this property
attempts: optional number
Link to this property
body: optional string
Link to this property
lease\_id: optional string
An ID that represents an “in-flight” message that has been pulled from a Queue. You must hold on to this ID and use it to acknowledge this message.
Link to this property
metadata: optional unknown
Link to this property
timestamp\_ms: optional number
Link to this property
Link to this property
metadata: optional object {metrics }
metrics: optional object {backlog\_bytes, backlog\_count, oldest\_message\_timestamp\_ms }
Best-effort metrics for the queue. Values may be approximate due to the distributed nature of queues.
backlog\_bytes: number
The size in bytes of unacknowledged messages in the queue.
Link to this property
backlog\_count: number
The number of unacknowledged messages in the queue.
Link to this property
oldest\_message\_timestamp\_ms: number
Unix timestamp in milliseconds of the oldest unacknowledged message in the queue. Returns 0 if unknown.
Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20queues.messages%20%3E%20(method)%20pull%20%3E%20(network%20schema)%20%3E%20(property)%20result>)
success: optional true
Indicates if the API call was successful or not.
[Link to this property](<#(resource)%20queues.messages%20%3E%20(method)%20pull%20%3E%20(network%20schema)%20%3E%20(property)%20success>)
### Pull Queue Messages
HTTP
HTTPTypeScriptPythonGoTerraform
```
curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/queues/$QUEUE_ID/messages/pull \
-X POST \
-H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
```
200 example
```
{
"errors": [
{
"code": 7003,
"message": "No route for the URI",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
"string"
],
"result": {
"message_backlog_count": 5,
"messages": [
{
"id": "b01b5594f784d0165c2985833f5660dd",
"attempts": 1,
"body": "hello world",
"lease_id": "eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2Q0JDLUhTNTEyIn0..Q8p21d7dceR6vUfwftONdQ.JVqZgAS-Zk7MqmqccYtTHeeMElNHaOMigeWdb8LyMOg.T2_HV99CYzGaQuhTyW8RsgbnpTRZHRM6N7UoSaAKeK0",
"metadata": {
"CF-Content-Type": "text",
"CF-sourceMessageSource": "dash"
},
"timestamp_ms": 1710950954154
}
],
"metadata": {
"metrics": {
"backlog_bytes": 1024,
"backlog_count": 5,
"oldest_message_timestamp_ms": 1710950954154
}
}
},
"success": true
}
```
##### Returns Examples
200 example
```
{
"errors": [
{
"code": 7003,
"message": "No route for the URI",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
"string"
],
"result": {
"message_backlog_count": 5,
"messages": [
{
"id": "b01b5594f784d0165c2985833f5660dd",
"attempts": 1,
"body": "hello world",
"lease_id": "eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2Q0JDLUhTNTEyIn0..Q8p21d7dceR6vUfwftONdQ.JVqZgAS-Zk7MqmqccYtTHeeMElNHaOMigeWdb8LyMOg.T2_HV99CYzGaQuhTyW8RsgbnpTRZHRM6N7UoSaAKeK0",
"metadata": {
"CF-Content-Type": "text",
"CF-sourceMessageSource": "dash"
},
"timestamp_ms": 1710950954154
}
],
"metadata": {
"metrics": {
"backlog_bytes": 1024,
"backlog_count": 5,
"oldest_message_timestamp_ms": 1710950954154
}
}
},
"success": true
}
```