--- title: Pull Queue Messages --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Queues](https://developers.cloudflare.com/api/python/resources/queues) [Messages](https://developers.cloudflare.com/api/python/resources/queues/subresources/messages) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Pull Queue Messages queues.messages.pull(strqueue\_id, MessagePullParams\*\*kwargs) -> [MessagePullResponse]() 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` ##### ParametersExpand Collapse account\_id: str 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: str 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)>) batch\_size: Optional\[float] 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)%20default%20%3E%20(param)%20batch_size%20%3E%20(schema)>) visibility\_timeout\_ms: Optional\[float] 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)%20default%20%3E%20(param)%20visibility_timeout_ms%20%3E%20(schema)>) ##### ReturnsExpand Collapse
class MessagePullResponse: … message\_backlog\_count: Optional\[float] The number of unacknowledged messages in the queue. Link to this property
messages: Optional\[List\[Message]] id: Optional\[str] Link to this property attempts: Optional\[float] Link to this property body: Optional\[str] Link to this property lease\_id: Optional\[str] 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\[object] Link to this property timestamp\_ms: Optional\[float] Link to this property
Link to this property
metadata: Optional\[Metadata]
metrics: Optional\[MetadataMetrics] Best-effort metrics for the queue. Values may be approximate due to the distributed nature of queues. backlog\_bytes: float The size in bytes of unacknowledged messages in the queue. Link to this property backlog\_count: float The number of unacknowledged messages in the queue. Link to this property oldest\_message\_timestamp\_ms: float 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(model)%20message_pull_response%20%3E%20(schema)>) ### Pull Queue Messages Python HTTPTypeScriptPythonGoTerraform ``` import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) response = client.queues.messages.pull( queue_id="023e105f4ecef8ad9ca31a8372d0c353", account_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(response.message_backlog_count) ``` 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 } ```