Rigel's email addresses

email.address.list

GET/api/v1/households/{household_id}/queries/email.address.list

Query
Rigel runs it

The addresses Rigel receives at and sends from, the default first, each with its display name and, for a custom domain, the domain's state in words.

Parameters#

Rigel's email addresses: parameters
Field	Description
`household_id`pathstringrequired	The household's ID.

Response#

200 The answer.

Rigel's email addresses: response fields
Field	Description
`items`array of objectsrequired
`items[].id`stringrequired	A email address ID, such as eml_01JC0000000000000000000000.
`items[].address`stringrequired	The address.
`items[].display_name`stringrequired	The name on mail sent from it when not sent in a person's name.
`items[].is_default_from`booleanrequired	Whether it is the default address mail is sent from.
`items[].domain`object or nullrequired	The custom domain it is on, or null for an address on Rigel's own domain.
`items[].domain.id`stringrequired	A email domain ID, such as emd_01JC0000000000000000000000.
`items[].domain.domain`stringrequired	The custom domain.
`items[].domain.state`one of: pending, receiving, sending, ready, brokenrequired	The custom domain's state: pending (nothing verified), receiving (mail addressed to it has arrived), sending (verified for sending), ready (both work), broken (a record that checked out stopped checking out).
`items[].domain.state_in_words`stringrequired	What the state means, in words.

Errors#

Every error has the same envelope: error.code, error.message, error.details, error.recovery and error.request_id.

Rigel's email addresses: errors
Status	Code	When
`400`	`validation_failed`	A field is missing, misspelled or out of range. details.fields lists each problem.
`401`	`unauthenticated`	The request has no valid session.
`404`	`not_found`	The household doesn't exist, or you aren't a member of it.

Examples#

These are real. Each was recorded from a sample household, the Okafors, running through the whole API when this site was built.

List the household's email addresses

Request, curl

curl 'https://rigel.house/api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/queries/email.address.list' \
  -H "Cookie: rigel_session=$RIGEL_SESSION"

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/queries/email.address.list", {
  headers: {
    Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
  },
});
const data = await response.json();

Request, HTTP

GET /api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/queries/email.address.list HTTP/1.1
Host: rigel.house
Cookie: rigel_session=<your session>

Response, 200

HTTP/1.1 200 OK
Content-Type: application/json
X-Request-Id: req_01M6V9CSRVAXDY0T7CCWFMCQ89

{
  "items": [
    {
      "id": "eml_01M6V9CSQB5Y3M8ETS3YPHFPA1",
      "address": "home@okafors.example.com",
      "display_name": "The Okafors",
      "is_default_from": true,
      "domain": {
        "id": "emd_01M6V9CSQ63D47MKP7KG4FEBDJ",
        "domain": "okafors.example.com",
        "state": "ready",
        "state_in_words": "Ready: receiving and sending both work."
      }
    }
  ]
}

For Rigel#

Rigel's tool for this query is email_address_list. Rigel runs this on its own, then says what it did. The agent guide has the rest.