---
title: Get Queue Purge Status
---

[Skip to content](#_top)

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

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

[Purge](https://developers.cloudflare.com/api/typescript/resources/queues/subresources/purge)

Copy Markdown

Open in **Claude**Open in **ChatGPT**Open in **Cursor**

---

**Copy Markdown****View as Markdown**

# Get Queue Purge Status

client.queues.purge.status(stringqueueID, PurgeStatusParams {account\_id } params, RequestOptionsoptions?): [PurgeStatusResponse](<https://developers.cloudflare.com/api/typescript/resources/queues#(resource)%20queues.purge%20%3E%20(model)%20purge_status_response%20%3E%20(schema)>) {completed, started\_at }

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

Returns the status of a Queue purge operation.

##### Security

<details>

<summary>API Token</summary>



The preferred authorization scheme for interacting with the Cloudflare API. <a href="https://developers.cloudflare.com/fundamentals/api/get-started/create-token/">Create a token</a>.

**Example:**<code>Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY</code>

</details>

<details>

<summary>API Email + API Key</summary>



The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

**Example:**<code>X-Auth-Email: user@example.com</code>

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

**Example:**<code>X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194</code>

</details>

##### Accepted Permissions (at least one required)

`Queues Write``Queues Read``Workers Scripts Write``Workers Scripts Read`

##### ParametersExpand Collapse

queueID: string

A Resource identifier.

maxLength32

[Link to this property](<#(resource)%20queues.purge%20%3E%20(method)%20status%20%3E%20(params)%20default%20%3E%20(param)%20queue_id%20%3E%20(schema)>)

<details>

<summary>

params: PurgeStatusParams {account\_id }

</summary>

account\_id: string

A Resource identifier.

maxLength32

<a href="#(resource)%20queues.purge%20%3E%20(method)%20status%20%3E%20(params)%20default%20%3E%20(param)%20account_id">Link to this property</a>

</details>

[Link to this property](<#(resource)%20queues.purge%20%3E%20(method)%20status%20%3E%20(params)%20default>)

##### ReturnsExpand Collapse

<details>

<summary>

PurgeStatusResponse {completed, started\_at }

</summary>

completed?: string

Indicates if the last purge operation completed successfully.

<a href="#(resource)%20queues.purge%20%3E%20(model)%20purge_status_response%20%3E%20(schema)%20%3E%20(property)%20completed">Link to this property</a>

started\_at?: string

Timestamp when the last purge operation started.

<a href="#(resource)%20queues.purge%20%3E%20(model)%20purge_status_response%20%3E%20(schema)%20%3E%20(property)%20started_at">Link to this property</a>

</details>

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

### Get Queue Purge Status

TypeScript

HTTPTypeScriptPythonGoTerraform

```
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const response = await client.queues.purge.status('023e105f4ecef8ad9ca31a8372d0c353', {
  account_id: '023e105f4ecef8ad9ca31a8372d0c353',
});

console.log(response.completed);
```

200 example

```
{
  "errors": [
    {
      "code": 7003,
      "message": "No route for the URI",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    "string"
  ],
  "result": {
    "completed": "completed",
    "started_at": "started_at"
  },
  "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": {
    "completed": "completed",
    "started_at": "started_at"
  },
  "success": true
}
```