Skip to content
Pealboard

One view

GET
/v1/views/{viewId}
curl --request GET \
  --url https://api.pealboard.com/v1/views/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

A shared view, or one of your own. Another member’s personal view is a 404.

Access. Requires the viewer role or above (viewer, member, admin, owner). A view is a saved filter over issues the member can already read. API-key scope: views:read.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
viewId
required

From GET /v1/views.

string format: uuid

From GET /v1/views.

Responses

Section titled “Responses”

200

Section titled “200”

The view.

Media typeapplication/json
object
id
required

A UUID this API issued.

string format: uuid
name
required
string
layout
required

board groups by the view’s groupBy; the other two do not.

string
Allowed values: list board table
filter
required
object
q

Full text over title, number, label names and body.

string
repository

Repository ids. Any of them matches.

Array<string>
state
string
Allowed values: open closed all
label

Label names. An issue must carry every one of them.

Array<string>
assignee

GitHub logins, @me for the caller, or none for unassigned. Any of them matches.

Array<string>
milestone

Milestone ids, or none.

Array<string>
project

Project ids. Any of them matches.

Array<string>
type

Issue type names, or none.

Array<string>
field

Project field node id to the value it must hold, or none for not set. Every entry must match.

The value is matched against the word on the card, and against an option id or an iteration id for a caller that already asked GitHub. A number is compared as a number, so 3 matches a stored 3.0. Five operators are written into the value, because the parameter’s name is already the field’s node id: >=, >, <=, <, and a..b for an inclusive range. A comparison operand has to be a number or a date as YYYY-MM-DD; anything else is a 422 rather than a refusal from Postgres. A date comparison also matches an iteration, by its start date.

object
key
additional properties
string
updatedSince

An ISO 8601 instant, or a window such as -7d, -24h, -2w.

string
closedSince

The same forms as updatedSince.

string
noProjectStatus

Issues on no project, or on one whose Status field is not set.

boolean
hasPortalRequest

Issues that are a request in at least one portal.

boolean
sort
required
object
key
string
default: updated
Allowed values: updated created number title comments field
order
string
default: desc
Allowed values: asc desc
fieldNodeId

The project field to order by, when key is field. A number sorts numerically, a date and an iteration chronologically, a single select in the project’s own option order, and a text field alphabetically. An issue with no value for the field sorts last, whichever direction is asked for. A node id that names no field falls back to the default sort, so a view saved against a field somebody has since deleted still opens.

string
groupBy
required
One of:
object
kind
required
string
Allowed values: project_field
fieldNodeId

Any kind of project field. A single select’s columns are its options, an iteration field’s are its iterations, a date’s are months, and a number’s or a text field’s are the distinct values this board holds.

string
fieldName

For a view saved before any project existed. Resolved when the board is run.

string
projectId

A UUID this API issued.

string format: uuid
columns
required

The columns the table layout shows, in order. Empty means the client’s own default set.

Array<string>
shared
required

Shared with the workspace. A view that is not shared is visible only to the member who owns it.

boolean
ownerMembershipId
required

Null for a shared view.

string | null format: uuid
builtIn
required

Which of the six seeded views this started as, or null for one somebody made.

string | null
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example
{
  "id": "3c9a1f52-7b8e-4d21-9f03-6a5b4c3d2e1f",
  "name": "Needs triage",
  "layout": "list",
  "filter": {
    "state": "open",
    "noProjectStatus": true
  },
  "sort": {
    "key": "created",
    "order": "desc"
  },
  "groupBy": null,
  "columns": [],
  "shared": true,
  "ownerMembershipId": null,
  "builtIn": "needs_triage",
  "createdAt": "2026-09-09T10:00:00.000Z",
  "updatedAt": "2026-09-09T10:00:00.000Z"
}

401

Section titled “401”

No valid credentials.

Media typeapplication/json
object
error
required
object
code
required

A stable identifier for the kind of failure. Safe to branch on.

string
message
required

What went wrong, written for a person.

string
detail

Structured particulars, when there are any.

object
key
additional properties
remedy

What to do about it, when there is something to do.

string
requestId
required

Quote this when asking about a specific failure.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "detail": {
      "additionalProperty": "example"
    },
    "remedy": "example",
    "requestId": "example"
  }
}

403

Section titled “403”

Authenticated, but not permitted.

Media typeapplication/json
object
error
required
object
code
required

A stable identifier for the kind of failure. Safe to branch on.

string
message
required

What went wrong, written for a person.

string
detail

Structured particulars, when there are any.

object
key
additional properties
remedy

What to do about it, when there is something to do.

string
requestId
required

Quote this when asking about a specific failure.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "detail": {
      "additionalProperty": "example"
    },
    "remedy": "example",
    "requestId": "example"
  }
}

404

Section titled “404”

No such resource, or it is not visible to you.

Media typeapplication/json
object
error
required
object
code
required

A stable identifier for the kind of failure. Safe to branch on.

string
message
required

What went wrong, written for a person.

string
detail

Structured particulars, when there are any.

object
key
additional properties
remedy

What to do about it, when there is something to do.

string
requestId
required

Quote this when asking about a specific failure.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "detail": {
      "additionalProperty": "example"
    },
    "remedy": "example",
    "requestId": "example"
  }
}

409

Section titled “409”

The request conflicts with the current state.

Media typeapplication/json
object
error
required
object
code
required

A stable identifier for the kind of failure. Safe to branch on.

string
message
required

What went wrong, written for a person.

string
detail

Structured particulars, when there are any.

object
key
additional properties
remedy

What to do about it, when there is something to do.

string
requestId
required

Quote this when asking about a specific failure.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "detail": {
      "additionalProperty": "example"
    },
    "remedy": "example",
    "requestId": "example"
  }
}

422

Section titled “422”

The request did not match the expected shape.

Media typeapplication/json
object
error
required
object
code
required

A stable identifier for the kind of failure. Safe to branch on.

string
message
required

What went wrong, written for a person.

string
detail

Structured particulars, when there are any.

object
key
additional properties
remedy

What to do about it, when there is something to do.

string
requestId
required

Quote this when asking about a specific failure.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "detail": {
      "additionalProperty": "example"
    },
    "remedy": "example",
    "requestId": "example"
  }
}

429

Section titled “429”

Rate limited. Retry after the interval in the header.

Media typeapplication/json
object
error
required
object
code
required

A stable identifier for the kind of failure. Safe to branch on.

string
message
required

What went wrong, written for a person.

string
detail

Structured particulars, when there are any.

object
key
additional properties
remedy

What to do about it, when there is something to do.

string
requestId
required

Quote this when asking about a specific failure.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "detail": {
      "additionalProperty": "example"
    },
    "remedy": "example",
    "requestId": "example"
  }
}

502

Section titled “502”

GitHub or another dependency refused or did not answer. Nothing in the workspace changed.

Media typeapplication/json
object
error
required
object
code
required

A stable identifier for the kind of failure. Safe to branch on.

string
message
required

What went wrong, written for a person.

string
detail

Structured particulars, when there are any.

object
key
additional properties
remedy

What to do about it, when there is something to do.

string
requestId
required

Quote this when asking about a specific failure.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "detail": {
      "additionalProperty": "example"
    },
    "remedy": "example",
    "requestId": "example"
  }
}