---
title: "List all documentation pages"
description: "Returns the metadata for every page, sorted by slug."
url: https://beacon-arodoni.vercel.app/api-reference/list-docs
---

# List all documentation pages

`GET /docs.json`

Base URL: `https://example.com/api/v1`

Returns the metadata for every page, sorted by slug.

## Responses

### 200

Metadata for every page

Content type: `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| docs | array<object> | Yes |  |
| docs.slug | string | Yes |  |
| docs.title | string | Yes |  |
| docs.description | string | Yes |  |
| docs.url | string (uri) | Yes |  |
| docs.markdownUrl | string (uri) | Yes |  |
| docs.apiUrl | string (uri) | Yes |  |

```json
{
  "docs": [
    {
      "slug": "quickstart",
      "title": "Quickstart",
      "description": "Create a site and deploy it.",
      "url": "https://example.com/quickstart",
      "markdownUrl": "https://example.com/quickstart.md",
      "apiUrl": "https://example.com/api/v1/docs/quickstart.json"
    }
  ]
}
```

## Code samples

### cURL

```bash
curl --request GET \
  --url 'https://example.com/api/v1/docs.json'
```

### JavaScript

```javascript
const response = await fetch("https://example.com/api/v1/docs.json", {
  method: "GET",
});

console.log(await response.json());
```

### Python

```python
import requests

response = requests.request(
    "GET",
    "https://example.com/api/v1/docs.json",
)

print(response.json())
```