---
title: List guides
description: "Returns guides in the project. Results use the standard Developer API list envelope with cursor pagination ( cursor , limit ). Full-text search ( q ) and cus…"
product: general
lang: en
last_updated: 2026-10-27
token_estimate: 2083
---
# List guides

> For AI agents: a documentation index is available at [/docs/llms.txt](/docs/llms.txt). Append `.md` to any page URL for markdown, or send `Accept: text/markdown`.

## List guides

**GET** `/v1/projects/{project_id}/guides`

Full URL: `https://developer-api.amplitude.com/v1/projects/{project_id}/guides`

**Servers:**
- Production (US): `https://developer-api.amplitude.com/v1/projects/{project_id}/guides`
- Production (EU): `https://developer-api.eu.amplitude.com/v1/projects/{project_id}/guides`

List guides

Returns guides in the project. Results use the standard
Developer API list envelope with cursor pagination (`cursor`, `limit`).

Full-text search (`q`) and custom sort orders are not supported yet.

## Authorizations

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| Authorization | string | Yes | — | http |

## Path parameters

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| project_id (path) | string | Yes | 12345 | Amplitude project identifier, backed by the canonical app ID. Constraints: pattern: ^[0-9]+$ |

## Query parameters

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| cursor (query) | string | No | — | Opaque cursor from `pagination.next_cursor` on the previous response. Numeric offsets are capped by the underlying search index (10,000 results per query). Well-formed pagination stops before that window; requests whose cursor would exceed it return 400 `pagination_not_supported`. Constraints: nullable |
| limit (query) | integer | No | 50 | Number of items to return. Defaults to 50, max 200. Constraints: min: 1, max: 200 |
| platform (query) | string | No | — | Target platform. Guides and surveys without an explicit platform are returned as `web`. Allowed values: web, ios, android, react-native, desktop, flutter |
| created_after (query) | string | No | — | Constraints: format: date-time |
| created_before (query) | string | No | — | Constraints: format: date-time |
| created_by (query) | string | No | — | Filter by creator email or login id (exact match). |
| include_archived (query) | boolean | No | false | — |

## Response (application/json)

**200** — Successful response.

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| data | object[] | Yes | — | — |
| data.id | string | Yes | — | Numeric nudge identifier. Constraints: pattern: ^[0-9]+$ |
| data.object | string | Yes | — | — |
| data.project_id | string | Yes | — | Constraints: pattern: ^[0-9]+$ |
| data.type | string | Yes | — | — |
| data.platform | string | Yes | — | Target platform. Guides and surveys without an explicit platform are returned as `web`. Allowed values: web, ios, android, react-native, desktop, flutter |
| data.title | string | Yes | — | Constraints: nullable |
| data.description | string | No | — | Constraints: nullable |
| data.is_archived | boolean | Yes | — | — |
| data.priority | integer | Yes | — | Trigger precedence (4 = urgent, 1 = low). Constraints: min: 1, max: 4 |
| data.status | string | Yes | — | Derived rollout state. Read-only on API responses. Allowed values: draft, published, testing, scheduled, scheduled-active, scheduled-inactive, experiment-running, experiment-inactive, archived |
| data.status_description | string | Yes | — | — |
| data.key | string | Yes | — | Feature flag key that controls delivery. Matches the `[Guides-Surveys] Key` property on SDK-tracked guide and survey events, so use it to join events to this guide or survey. Constraints: nullable |
| data.start_at | string | Yes | — | Scheduled start of the live flag. `null` when no start is scheduled. Constraints: format: date-time, nullable |
| data.end_at | string | Yes | — | Scheduled end of the live flag. `null` when no end is scheduled. Constraints: format: date-time, nullable |
| data.url | string | Yes | — | Admin URL for the guide or survey. Constraints: format: uri |
| data.page_target_segments | unknown[] | No | — | Page URL targeting rules. Empty means globally eligible. |
| data.tags | string[] | No | — | — |
| data.created_by | string | No | — | Constraints: nullable |
| data.last_modified_by | string | No | — | Constraints: nullable |
| data.created_at | string | Yes | — | Constraints: format: date-time, nullable |
| data.updated_at | string | Yes | — | Constraints: format: date-time, nullable |
| data.latest_version | integer | Yes | — | Monotonic version for optimistic concurrency. Send the value from the latest GET on PATCH; a stale value returns 409. |
| pagination | object | Yes | — | — |
| pagination.next_cursor | string | Yes | — | Cursor for the next page, or `null` on the last page. Chart list responses may stop before all project charts are enumerated because the search backend caps each query at 10,000 sorted hits. Constraints: nullable |
| pagination.has_more | boolean | Yes | — | — |

```json
{
  "data": [
    {
      "id": "string",
      "object": "guide",
      "project_id": "string",
      "type": "GUIDE",
      "platform": "web",
      "title": "string",
      "description": "string",
      "is_archived": true,
      "priority": 1,
      "status": "draft",
      "status_description": "string",
      "key": "string",
      "start_at": "2024-01-01T00:00:00Z",
      "end_at": "2024-01-01T00:00:00Z",
      "url": "https://example.com",
      "page_target_segments": [
        null
      ],
      "tags": [
        "string"
      ],
      "created_by": "string",
      "last_modified_by": "string",
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z",
      "latest_version": 0
    }
  ],
  "pagination": {
    "next_cursor": "string",
    "has_more": true
  }
}
```

**400**

**401**

**403**

**429**

**500**

## Code samples

### cURL

```bash
curl -X GET "https://developer-api.amplitude.com/v1/projects/12345/guides?limit=50&include_archived=false" \
  -H "Content-Type: application/json" \
  -H "Authorization: YOUR_API_KEY"
```

### Python

```python
import requests

response = requests.get(
    "https://developer-api.amplitude.com/v1/projects/12345/guides?limit=50&include_archived=false",
    headers={
        "Content-Type": "application/json",
        "Authorization": "YOUR_API_KEY"
    }
)
data = response.json()
```

### JavaScript

```javascript
const response = await fetch("https://developer-api.amplitude.com/v1/projects/12345/guides?limit=50&include_archived=false", {
  method: "GET",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_KEY"
  }
});
const data = await response.json();
```

### PHP

```php
<?php
$ch = curl_init("https://developer-api.amplitude.com/v1/projects/12345/guides?limit=50&include_archived=false");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Content-Type: application/json",
    "Authorization: YOUR_API_KEY"
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
```

### Go

```go
package main

import (
  "bytes"
  "net/http"
)

func main() {
req, _ := http.NewRequest("GET", "https://developer-api.amplitude.com/v1/projects/12345/guides?limit=50&include_archived=false", nil)
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "YOUR_API_KEY")
  client := &http.Client{}
  resp, _ := client.Do(req)
  defer resp.Body.Close()
}
```

### Java

```java
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
      .uri(URI.create("https://developer-api.amplitude.com/v1/projects/12345/guides?limit=50&include_archived=false"))
      .method("GET", HttpRequest.BodyPublishers.noBody())
.header("Content-Type", "application/json")
      .header("Authorization", "YOUR_API_KEY")
      .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```ruby
require "net/http"
require "json"

uri = URI("https://developer-api.amplitude.com/v1/projects/12345/guides?limit=50&include_archived=false")
request = Net::HTTP::Get.new(uri)
request["Content-Type"] = "application/json"
request["Authorization"] = "YOUR_API_KEY"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end
```