Skip to main content
GET
/
api
/
v2
/
revision
/
list
List Revisions
curl --request GET \
  --url https://app.octavehq.com/api/v2/revision/list \
  --header 'api_key: <api-key>'
{
  "data": {
    "revisions": [
      {
        "revisionOId": "<string>",
        "summary": "<string>",
        "entityName": "<string>",
        "entityOId": "<string>",
        "createdAt": "<string>",
        "authorName": "<string>"
      }
    ],
    "total": 123,
    "limit": 123,
    "offset": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.octavehq.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
api_key
string
header
required

Query Parameters

​
entityTypes
enum<string>[]

Optional list of entity types to filter revisions to (Persona, Product, Service, Solution, Segment, UseCase, Competitor, Alternative, BuyingTrigger, Objection, ProofPoint, Reference, Playbook, ContentAgent, Hypothesis, WorkspaceCompany, WritingStyle, BrandVoice, ChainedAgentWorkflow, SmartExample).

Available options:
Product,
Service,
Solution,
Persona,
UseCase,
Reference,
Segment,
Competitor,
Alternative,
BuyingTrigger,
Objection,
ProofPoint,
Playbook,
ContentAgent,
Hypothesis,
WorkspaceCompany,
WritingStyle,
BrandVoice,
ChainedAgentWorkflow,
SmartExample
​
entityOIds
string[]

Optional list of entity oIds (e.g. 'pe_' for persona, 'pb_' for playbook) to constrain the search to revisions of those specific entities. Capped at 20.

Maximum array length: 20
​
startDate
string<date-time>

Optional ISO 8601 start date — return revisions created on or after this date.

​
endDate
string<date-time>

Optional ISO 8601 end date — return revisions created on or before this date.

​
authorOId
string

Optional user oId (e.g. 'u_*') to filter revisions to changes authored by a specific user.

​
includeRestored
boolean | null
default:false

If true, include revisions that have already been restored. Defaults to false.

​
limit
integer
default:25

Maximum number of revisions to return (default 25, max 100).

Required range: 1 <= x <= 100
​
offset
integer | null
default:0

Pagination offset (default 0).

Required range: x >= 0

Response

200 - application/json

List of revisions for the workspace.

​
data
object
required