Relationship: members

GET

/v1/datasets/{dataset_id}/entities/{entity}/records/{id}/relationships/{relationship}

const url = 'https://data.example.test/v1/datasets/example/entities/example/records/example/relationships/example?limit=10';
const options = {
  method: 'GET',
  headers: {
    'Data-Purpose': 'https://demo.example.gov/purpose/demo-review',
    Authorization: 'Bearer <token>'
  }
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://data.example.test/v1/datasets/example/entities/example/records/example/relationships/example?limit=10' \
  --header 'Authorization: Bearer <token>' \
  --header 'Data-Purpose: https://demo.example.gov/purpose/demo-review'

Returns the members (has_many) target(s) for one household record. Foreign key: household_id.

Authorizations

bearerAuth
apiKeyAuth

Parameters

Path Parameters

required

string

Entity primary key

dataset_id

required

string

Dataset identifier

entity

required

string

Entity name

relationship

required

string

Relationship name

Query Parameters

limit

integer format: int32

>= 1

Maximum records to return. Capped by the entity’s api.max_limit.

Examples

default

cursor

string

Opaque pagination cursor returned in a prior response’s pagination.next_cursor.

Header Parameters

Data-Purpose

required

string

>= 1 characters

Purpose-of-use IRI or controlled string. When require_purpose_header is set on this entity, the header must be present; a missing value returns 400 auth.purpose_required. The value is always recorded verbatim in the audit trail when present; purpose values are not enforced or validated at the consultation layer. Registry Notary is the purpose-certification layer. Header names are case-insensitive (Data-Purpose and data-purpose are equivalent).

Example

https://demo.example.gov/purpose/demo-review

Responses

200

Successful response

application/json

object

data

required

Array<object>

object

age

Optional integer field.

integer | null format: int64

household

Registered household.

object

area_geometry

Optional string field.

string | null

required

Required string field.

string

members

Array<object> recursive

region

Optional string field. Codelist: https://example.test/vocab/codelists/Region.

string | null

household_id

required

Required string field.

string

required

Required string field.

string

pagination

required

object

has_more

required

True when more pages remain after this one.

boolean

next_cursor

Opaque cursor for the next page; null when has_more is false.

string | null

Example

{
  "data": [
    {
      "age": 42,
      "household_id": "01HZX9...",
      "id": "01HZX9..."
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "eyJvIjoyMH0="
  }
}

401

Missing or invalid bearer credential.

application/problem+json

RFC 9457 Problem Details, returned for every non-2xx response.

object

code

required

string

detail

required

string

request_id

required

string

status

required

integer format: int32

title

required

string

type

required

string format: uri

key

additional properties

any

Example

{
  "code": "auth.missing_credential",
  "detail": "no credential provided in Authorization or x-api-key header",
  "request_id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "status": 401,
  "title": "Missing credential",
  "type": "https://registry-relay.dev/problems/auth/missing_credential"
}

403

Authenticated principal lacks the scope required for this operation.

application/problem+json

RFC 9457 Problem Details, returned for every non-2xx response.

object

code

required

string

detail

required

string

request_id

required

string

status

required

integer format: int32

title

required

string

type

required

string format: uri

key

additional properties

any

Example

{
  "code": "auth.missing_credential",
  "detail": "no credential provided in Authorization or x-api-key header",
  "request_id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "status": 401,
  "title": "Missing credential",
  "type": "https://registry-relay.dev/problems/auth/missing_credential"
}

404

Parent record not found, or relationship target unavailable.

application/problem+json

RFC 9457 Problem Details, returned for every non-2xx response.

object

code

required

string

detail

required

string

request_id

required

string

status

required

integer format: int32

title

required

string

type

required

string format: uri

key

additional properties

any

Example

{
  "code": "auth.missing_credential",
  "detail": "no credential provided in Authorization or x-api-key header",
  "request_id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "status": 401,
  "title": "Missing credential",
  "type": "https://registry-relay.dev/problems/auth/missing_credential"
}

default

Problem Details error response.

application/problem+json

RFC 9457 Problem Details, returned for every non-2xx response.

object

code

required

string

detail

required

string

request_id

required

string

status

required

integer format: int32

title

required

string

type

required

string format: uri

key

additional properties

any

Example

{
  "code": "auth.missing_credential",
  "detail": "no credential provided in Authorization or x-api-key header",
  "request_id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "status": 401,
  "title": "Missing credential",
  "type": "https://registry-relay.dev/problems/auth/missing_credential"
}