Get one guide

GET

/guides/{guideId}

By id or permalink: metadata with markdown_body, the same text Export to markdown produces, screenshots as image links. On a plan without full API access markdown_body is the same preview a file export gets, locked guides are cut to their public preview, and notice (also closing markdown_body) says so.

Authorizations

BearerAuth

Responses

200

Successful response

application/json

object

data

required

object

team_id

string | null

created_at

string | null

string

title

string | null

description

string | null

owner_name

string | null

icon_url

string | null

permalink

string | null

publish_status

string | null

Allowed values: DRAFT PUBLISHED

updated_at

string | null

language

string

text_direction

string

Allowed values: rtl ltr

app_version

string | null

thumbnail_url

string | null

tags

Array<string> | null

folder_id

string | null

is_public

boolean

markdown_body

required

The guide as markdown, the same text Export to markdown produces; a preview closes with the notice.

string

brand_color

required

The team’s brand color, null for Glitter’s default.

string | null

locked

required

Past the plan’s guide limit: markdown_body is the short cut the guide’s public page shows.

boolean

notice

required

Null when the plan includes full guides through the API; otherwise why the guide stops where it does.

string | null

Example

{
  "data": {
    "publish_status": "DRAFT",
    "text_direction": "rtl"
  }
}

400

Invalid request

application/json

object

type

string

title

string

status

integer

detail

string

code

string

request_id

string

Example

{
  "type": "https://www.glitter.io/developers/api-reference#errors",
  "title": "Invalid request",
  "detail": "limit: Too big",
  "code": "invalid_request",
  "request_id": "3f2a9c1e-7b4d-4e0a-9c2f-1d5e6a7b8c9d"
}

401

Invalid or expired key

application/json

object

type

string

title

string

status

integer

detail

string

code

string

request_id

string

Example

{
  "type": "https://www.glitter.io/developers/api-reference#errors",
  "title": "Invalid API key",
  "detail": "This API key is not known.",
  "code": "invalid_key",
  "request_id": "3f2a9c1e-7b4d-4e0a-9c2f-1d5e6a7b8c9d"
}

403

Scope missing or API turned off

application/json

object

type

string

title

string

status

integer

detail

string

code

string

request_id

string

Example

{
  "type": "https://www.glitter.io/developers/api-reference#errors",
  "title": "Scope missing",
  "detail": "This key lacks the members:read scope.",
  "code": "scope_missing",
  "request_id": "3f2a9c1e-7b4d-4e0a-9c2f-1d5e6a7b8c9d"
}

429

Rate limited

application/json

object

type

string

title

string

status

integer

detail

string

code

string

request_id

string

Example

{
  "type": "https://www.glitter.io/developers/api-reference#errors",
  "title": "Too many requests",
  "detail": "600 requests per minute per key.",
  "code": "rate_limited",
  "request_id": "3f2a9c1e-7b4d-4e0a-9c2f-1d5e6a7b8c9d"
}

500

Internal error

application/json

object

type

string

title

string

status

integer

detail

string

code

string

request_id

string

Example

{
  "type": "https://www.glitter.io/developers/api-reference#errors",
  "title": "Something went wrong",
  "detail": "Something went wrong on our side.",
  "code": "internal_error",
  "request_id": "3f2a9c1e-7b4d-4e0a-9c2f-1d5e6a7b8c9d"
}