Who is in the family

family.person.list

GET/api/v1/households/{household_id}/queries/family.person.list

Query
Rigel runs it

Every person in the household's immediate family, in page order, with their age in words.

Parameters#

Who is in the family: parameters
Field	Description
`household_id`pathstringrequired	The household's ID.

Response#

200 The answer.

Who is in the family: response fields
Field	Description
`items`array of objectsrequired
`items[].id`stringrequired	A person ID, such as per_01JC0000000000000000000000.
`items[].name`stringrequired	What the family calls them.
`items[].age`string or nullrequired	Their age in words, such as "3 years old", or null without a birth date.
`items[].signs_in`booleanrequired	Whether they have an account and sign in.

Errors#

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

Who is in the family: 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 people in the household

Request, curl

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

Request, TypeScript

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

Request, HTTP

GET /api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/queries/family.person.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_01M6V9CS7D3NXMENJ9SW62671Y

{
  "items": [
    {
      "id": "per_01M6V9CS6RX26JK5KVYGRN22D2",
      "name": "Ada Okafor",
      "age": null,
      "signs_in": true
    },
    {
      "id": "per_01M6V9CS744BQQH188FS6CXY9W",
      "name": "Ben Okafor",
      "age": null,
      "signs_in": false
    },
    {
      "id": "per_01M6V9CS79TMYHDAM7FTA9ZK3Z",
      "name": "Nia",
      "age": "8 years old",
      "signs_in": false
    },
    {
      "id": "per_01M6V9CS7CDAEP5VDA5T8R9TG6",
      "name": "Theo",
      "age": "5 years old",
      "signs_in": false
    }
  ]
}

For Rigel#

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