Skip to content
Pealboard

List requests

GET
/v1/portals/{portalId}/requests
curl --request GET \
  --url 'https://api.pealboard.com/v1/portals/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/requests?cursor=MDAwMS0y&limit=50&status=open&visibility=private&held=true' \
  --header 'Authorization: Bearer <token>'

Filterable by status word, company, request type, visibility, and whether the request is waiting in the hold queue. status filters on the derived word, so it is applied after the rules run rather than as a column comparison.

Access. Requires the member role or above (member, admin, owner). Answering requests is the work a portal exists for, and it is ordinary member work. API-key scope: requests:read.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
portalId
required

From GET /v1/portals.

string format: uuid

From GET /v1/portals.

Query Parameters

Section titled “Query Parameters”
cursor

The nextCursor from the previous page, unchanged. Omit it to start at the beginning.

string
Example
MDAwMS0y

The nextCursor from the previous page, unchanged. Omit it to start at the beginning.

limit

How many rows to return. At most 100.

integer
default: 50 >= 1 <= 100

How many rows to return. At most 100.

status

The stable identifier a client filters on. The word is in status.label.

string
Allowed values: open planned in_progress waiting_on_you completed merged closed

The stable identifier a client filters on. The word is in status.label.

companyId

A UUID this API issued.

string format: uuid

A UUID this API issued.

requestTypeId

A UUID this API issued.

string format: uuid

A UUID this API issued.

visibility

Private: the requester and the workspace. company: everyone in the requester’s company. public: everyone in the portal. A manager sees every request in their company whatever this says.

string
Allowed values: private company public

Private: the requester and the workspace. company: everyone in the requester’s company. public: everyone in the portal. A manager sees every request in their company whatever this says.

held

true returns only the hold queue: nothing here has reached GitHub.

string
Allowed values: true false

true returns only the hold queue: nothing here has reached GitHub.

Responses

Section titled “Responses”

200

Section titled “200”

A page of requests.

Media typeapplication/json
object
data
required
Array<object>
object
id
required

A UUID this API issued.

string format: uuid
reference
required

ACME-42.

string
number
required
integer
title
required
string
status
required

Derived from the issue at read time, never stored.

object
id
required

The stable identifier a client filters on. The word is in status.label.

string
Allowed values: open planned in_progress waiting_on_you completed merged closed
label
required

The customer-facing word. Seven, fixed, and never GitHub’s own vocabulary.

string
Allowed values: Open Planned In progress Waiting on you Completed Merged Closed
visibility
required

Private: the requester and the workspace. company: everyone in the requester’s company. public: everyone in the portal. A manager sees every request in their company whatever this says.

string
Allowed values: private company public
issue
required

Null while the request is in the hold queue: it has not reached GitHub.

object
id
required

A UUID this API issued.

string format: uuid
number
required
integer
htmlUrl
required
string format: uri
state
required
string
Allowed values: open closed
requestType
required
object
id
required

A UUID this API issued.

string format: uuid
name
required
string
requester
required
object
id
required

A UUID this API issued.

string format: uuid
name
required
string
email
required
string format: email
company
required
object
id
required

A UUID this API issued.

string format: uuid
name
required
string
voteCount
required
integer
held
required
boolean
rejectedAt
required
string | null format: date-time
url
required

The request in its portal.

string format: uri
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
nextCursor
required

Pass this back as cursor for the next page. Null on the last page.

string | null
Example
{
  "data": [
    {
      "reference": "ACME-42",
      "status": {
        "id": "open",
        "label": "Open"
      },
      "visibility": "private",
      "issue": {
        "state": "open"
      }
    }
  ]
}

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