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

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.

get/v1/projects/{project_id}/guides

Authorizations

Authorizationstringrequired

http

Path parameters

project_idstringrequired

Amplitude project identifier, backed by the canonical app ID.

Example:12345
Constraints:pattern: ^[0-9]+$

Query parameters

cursorstring

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
limitinteger

Number of items to return. Defaults to 50, max 200.

Default:50
Constraints:min: 1max: 200
platformstring

Target platform. Guides and surveys without an explicit platform are returned as web.

Allowed values:webiosandroidreact-nativedesktopflutter
created_afterstring
Constraints:format: date-time
created_beforestring
Constraints:format: date-time
created_bystring

Filter by creator email or login id (exact match).

include_archivedboolean
Default:false

Response

application/json
200· Successful response.
dataobject[]required
Show child attributes
idstringrequired

Numeric nudge identifier.

Constraints:pattern: ^[0-9]+$
objectstringrequired
project_idstringrequired
Constraints:pattern: ^[0-9]+$
typestringrequired
platformstringrequired

Target platform. Guides and surveys without an explicit platform are returned as web.

Allowed values:webiosandroidreact-nativedesktopflutter
titlestringrequired
Constraints:nullable
descriptionstring
Constraints:nullable
is_archivedbooleanrequired
priorityintegerrequired

Trigger precedence (4 = urgent, 1 = low).

Constraints:min: 1max: 4
statusstringrequired

Derived rollout state. Read-only on API responses.

Allowed values:draftpublishedtestingscheduledscheduled-activescheduled-inactiveexperiment-runningexperiment-inactivearchived
status_descriptionstringrequired
keystringrequired

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
start_atstringrequired

Scheduled start of the live flag. null when no start is scheduled.

Constraints:format: date-timenullable
end_atstringrequired

Scheduled end of the live flag. null when no end is scheduled.

Constraints:format: date-timenullable
urlstringrequired

Admin URL for the guide or survey.

Constraints:format: uri
page_target_segmentsunknown[]

Page URL targeting rules. Empty means globally eligible.

tagsstring[]
created_bystring
Constraints:nullable
last_modified_bystring
Constraints:nullable
created_atstringrequired
Constraints:format: date-timenullable
updated_atstringrequired
Constraints:format: date-timenullable
latest_versionintegerrequired

Monotonic version for optimistic concurrency. Send the value from the latest GET on PATCH; a stale value returns 409.

paginationobjectrequired
Show child attributes
next_cursorstringrequired

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
has_morebooleanrequired

Was this helpful?