---
title: "The account's storyboards"
method: GET
path: "/storyboards"
tags: ["storyboards"]
---

# The account's storyboards

`GET /storyboards`

## Request

- Base URL: `https://api.gogoscreen.com/api/v1`
- URL: `https://api.gogoscreen.com/api/v1/storyboards`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

Every storyboard this account owns, newest first, as a cursor page. Unlike the dashboard's own list — which shows only the last day's work in progress — this one walks the whole history, because an integration reconciling its own records needs all of it.

## Query parameters

- `limit` integer
- `cursor` string

## Response `200`

The account's storyboards

- object
  - `data` object[], required
    - `appEntryUrl` string, nullable, required: Where the walkthrough was actually recorded, when a sign-in proved the app is not at `targetOrigin` — a product at app.example.com for a site at example.com. Null means the two are the same place.
    - `beatCount` number, required
    - `createdAt` string, date-time, nullable, required
    - `expiresAt` string, date-time, nullable, required
    - `hint` string, nullable, required
    - `id` string, required
    - `internalStatus` string, required
    - `lengthAdjusted` boolean, required: Whether this plan came back shorter than the request asked for, because the chosen length could not hold every step. `storyboards.get` carries the numbers and the sentence in `lengthFit`.
    - `progress` object, nullable, required: HOW FAR THE PLANNING HAS GOT, as last reported. Null once the storyboard is terminal and null while nothing has been recorded. Draw the percent as it is: nothing here is interpolated.
      - `at` string, nullable, required
      - `percent` number, required
      - `stage` string, required
    - `state` 'queued' | 'running' | 'succeeded' | 'failed' | 'cancelled', required
    - `targetOrigin` string, nullable, required
    - `targetPath` string, nullable, required
    - `title` string, nullable, required
  - `nextCursor` string, nullable, required: Pass as `cursor` for the next page; null on the last page.

## Other responses

- `400`: `validation_failed` — That request is not valid. · `invalid_cursor` — That page cursor is not valid.
- `401`: `unauthorized` — Authentication is required.
- `403`: `forbidden_scope` — This credential does not carry the scope this operation needs.
- `404`: `not_found` — No such resource.
- `429`: `rate_limited` — Too many requests. Try again shortly.
- `500`: `internal_error` — Something went wrong. Try again.

---

[API](https://skmtc.dev/gogoscreen/apis/gogoscreen-api.md) · [All operations](https://skmtc.dev/gogoscreen/apis/gogoscreen-api/llms.txt) · [OpenAPI document](https://skmtc.dev/gogoscreen/apis/gogoscreen-api/revisions/2fd812319d75?raw)
