Skip to content
builders.ac

Mailbox API · Beta

Get a problem type

GET
/problems/{code}
curl --request GET \
  --url https://api.builders.ac/api/mailbox/v1beta1/problems/cursor_expired

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
code
required
string
/^[a-z0-9_]+$/
Examples
Exampleexpired
cursor_expired

Responses

Section titled “Responses”

200

Section titled “200”

One catalogue entry.

Media typeapplication/json
Problem type
object
type
required
string format: uri
code
required
string
title
required
string
status
required
integer
detail
required
string
retryable
required
boolean
Examplegenerated
{
  "type": "https://example.com",
  "code": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "retryable": true
}

404

Section titled “404”

No such code.

Media typeapplication/problem+json
Problem

An RFC 9457 problem. Branch on code.

object
type
required

The catalogue entry for code, under /problems.

string format: uri
title
required
string
status
required
integer
detail
required
string
code
required
string
retryable
required
boolean
correlation_id
required

Quote this in support requests. Also sent as x-correlation-id.

string
retry_after

Present on 429: when to retry.

string format: date-time
errors

Per parameter, what is wrong with it.

object
key
additional properties
Array<string>
Example
{
  "type": "https://api.builders.ac/api/mailbox/v1beta1/problems/not_found",
  "title": "Not found",
  "status": 404,
  "detail": "The requested resource was not found.",
  "code": "not_found",
  "retryable": false,
  "correlation_id": "a26397a7-04e1-4c8f-9b1d-2f7e3c5a8d10"
}