Guides

Get all guides

Changed on Jul 30, 2026

Get all guides for a user

get/api/v1/guides

Request

Base URL: http://localhost:8080
URL: http://localhost:8080/api/v1/guides
Auth: none declared

Query parameters

team_idstring

status'draft' | 'published' | 'archived' | 'deleted'

The status of the guide

exclude_archivedboolean

pageinteger

limitinteger

sort_by'created_at' | 'updated_at'

The field to sort guides by

sort_dirstring nullable

Response

OK

limitinteger required

pageinteger required

totalinteger required

Example response

{
  "data": [
    {
      "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "team_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
    }
  ]
}

Changes

Jul 30, 20269330a2f45986 Revision changes
- breaking
  removed the required property from the response with the status
- info
  added the new optional query request parameter exclude_archived
- info
  added the new optional query request parameter limit
- info
  added the new optional query request parameter page
- info
  added the new optional query request parameter sort_by
- info
  added the new optional query request parameter sort_dir
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
Jul 27, 2026febecbafa164 Revision changes
- breaking
  removed the enum value pending_purge from the property anyOf[GuideStatus]/ of the query request parameter status
- info
  added the new optional query request parameter team_id
- info
  removed the pending_purge enum value from the // response property for the response status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status

Operation history