Skip to main content
GET
/
api
/
v1
/
refinements
/
{refinement_id}
Get Refinement
curl --request GET \
  --url https://api.example.com/api/v1/refinements/{refinement_id} \
  --header 'Authorization: Bearer <token>'
{
  "analysis": "<string>",
  "assignee_id": "<string>",
  "board_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "decisions": [
    "<string>"
  ],
  "description": "<string>",
  "id": "<string>",
  "ideation_id": "<string>",
  "in_scope": [
    "<string>"
  ],
  "labels": [
    "<string>"
  ],
  "out_of_scope": [
    "<string>"
  ],
  "status": "draft",
  "title": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "version": 123,
  "architecture_designs": [],
  "archived": false,
  "knowledge_bases": [],
  "pre_archive_status": "<string>",
  "qa_items": [],
  "screen_mockups": [
    {
      "id": "<string>",
      "title": "<string>",
      "annotations": [
        {
          "id": "<string>",
          "text": "<string>",
          "author_id": "<string>"
        }
      ],
      "description": "<string>",
      "html_content": "",
      "order": 0,
      "screen_type": "page"
    }
  ],
  "specs": []
}

Documentation Index

Fetch the complete documentation index at: https://docs.oktolabs.ai/llms.txt

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

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

refinement_id
string
required

Response

Successful Response

Schema for full refinement response.

analysis
string | null
required
assignee_id
string | null
required
board_id
string
required
created_at
string<date-time>
required
created_by
string
required
decisions
string[] | null
required
description
string | null
required
id
string
required
ideation_id
string
required
in_scope
string[] | null
required
labels
string[] | null
required
out_of_scope
string[] | null
required
status
enum<string>
required

Refinement lifecycle status.

Available options:
draft,
review,
approved,
done,
cancelled
title
string
required
updated_at
string<date-time>
required
version
integer
required
architecture_designs
ArchitectureDesignSummary · object[]
archived
boolean
default:false
knowledge_bases
RefinementKnowledgeSummary · object[]
pre_archive_status
string | null
qa_items
RefinementQAResponse · object[]
screen_mockups
ScreenMockup · object[] | null
specs
SpecSummary · object[]
Last modified on May 8, 2026