List or search guides

GET

/guides

const url = 'https://www.glitter.io/api/v1/guides?limit=50';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://www.glitter.io/api/v1/guides?limit=50' \
  --header 'Authorization: Bearer <token>'

Every guide the key reaches, drafts included, newest first. Narrow to a team with team_id, search titles with q, and page with limit and cursor.

Authorizations

BearerAuth

Parameters

Query Parameters

team_id

string format: uuid

Narrow to one team. Omit for every team the key reaches.

string

>= 2 characters <= 200 characters

Case-insensitive match on the guide title.

limit

integer

default: 50 >= 1 <= 100

Rows per page, 1 to 100.

cursor

string

The next_cursor of the previous page.

Responses

200

Successful response

application/json

object

data

required

Pass as cursor to fetch the next page; null on the last page.

Array<object>

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

locked

required

Past the plan’s guide limit: the guide opens as a short cut, in the app and through the API alike.

boolean

next_cursor

required

Pass as cursor to fetch the next page; null on the last page.

string | null

Example

{
  "data": [
    {
      "publish_status": "DRAFT"
    }
  ]
}

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"
}