records.facility.get

GET

/v1/records/facilities/{record_id}

curl --request GET \
  --url 'https://example.com/v1/records/facilities/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0?accessProfile=example' \
  --header 'Authorization: Bearer <token>'

Authorizations

• bearerAuth

Parameters

Path Parameters

record_id

required

string format: uuid

Canonical record UUID.

Header Parameters

traceparent

string

>= 55 characters <= 55 characters /^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$/

Optional W3C trace context. Responses carry Registry trace context for the request.

Query Parameters

accessProfile

required

string

<= 128 characters

Select one compiled access profile. Required when the route has no default; otherwise omission uses its default.

$select

string

<= 16384 characters

Comma-separated subset of readable API property names.

Responses

200

Record returned

object

data

required

object

domainData

required

object

addressLine

string

>= 1 characters <= 240 characters

city

string

>= 1 characters <= 120 characters

facilityCode

string

>= 1 characters <= 64 characters

jurisdiction

string

>= 1 characters <= 40 characters

name

string

>= 1 characters <= 200 characters

postalCode

string

>= 1 characters <= 24 characters

status

string

Allowed values: active inactive

recordIdentifier

required

string format: uuid

revisionIdentifier

required

string

/^[1-9][0-9]*$/

meta

required

object

datasetIdentifier

required

Allowed value: facility-registry

entityTypeIdentifier

required

Allowed value: facility

registryIdentifier

required

Allowed value: facility-registry

Example

{
  "data": {
    "domainData": {
      "status": "active"
    }
  },
  "meta": {
    "datasetIdentifier": "facility-registry",
    "entityTypeIdentifier": "facility",
    "registryIdentifier": "facility-registry"
  }
}

object

@context

required

Allowed value: https://id.registrystack.org/contexts/registry-record/v1

data

required

object

domainData

required

object

addressLine

string

>= 1 characters <= 240 characters

city

string

>= 1 characters <= 120 characters

facilityCode

string

>= 1 characters <= 64 characters

jurisdiction

string

>= 1 characters <= 40 characters

name

string

>= 1 characters <= 200 characters

postalCode

string

>= 1 characters <= 24 characters

status

string

Allowed values: active inactive

recordIdentifier

required

string format: uuid

revisionIdentifier

required

string

/^[1-9][0-9]*$/

meta

required

object

datasetIdentifier

required

Allowed value: facility-registry

entityTypeIdentifier

required

Allowed value: facility

registryIdentifier

required

Allowed value: facility-registry

Example

{
  "@context": "https://id.registrystack.org/contexts/registry-record/v1",
  "data": {
    "domainData": {
      "status": "active"
    }
  },
  "meta": {
    "datasetIdentifier": "facility-registry",
    "entityTypeIdentifier": "facility",
    "registryIdentifier": "facility-registry"
  }
}

Headers

Cache-Control

Allowed value: no-store

Caller-dependent responses must not be stored.

ETag

string

/^\"breg-[\x21\x23-\x7E]+\"$/

Strong Registry ETag bound to the record, package revision, caller profile, and response field set.

Link

string

Example

<https://id.registrystack.org/profiles/registry-record/v1>; rel="profile", </v1/schemas/facility>; rel="describedby"

Emitted only for application/json and application/ld+json Registry Record responses and omitted for application/geo+json. Carries the Registry Record profile and caller-visible record type schema. The describedby target includes the configured deployment prefix and is never derived from Host or forwarded headers.

Vary

string

Responses vary by authorization and negotiated representation.

traceparent

string

>= 55 characters <= 55 characters /^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$/

Trace context for this response.

Example

00-11111111111111111111111111111111-2222222222222222-01

400

Problem response

Media typeapplication/problem+json

object

code

required

string

Allowed values: action.evidence_failed action.guard_failed action.handler_failed action.refused authentication.refused idempotency.conflict idempotency.expired ingestion.chunk_mismatch ingestion.profile_mismatch ingestion.receipt_erased ingestion.run_blocked ingestion.run_not_open lookup.unresolved mutation.conflict precondition.failed precondition.required proposal.rejected proposal.review_result_mismatch proposal.submission_expired query.cursor_invalid query.invalid request.invalid request.timeout resource.not_found runtime.field_encryption.unavailable service.unavailable source.unavailable statistical_dataset.domain_violation statistical_dataset.release_refused statistical_dataset.version_conflict statistical_dataset.version_withdrawn unsupported.media_type

constraintId

string

>= 1 characters <= 128 characters

constraintKind

string

Allowed values: compare int-range vocabulary

detail

required

string

<= 256 characters

field

string

>= 1 characters <= 128 characters

fieldId

string

>= 1 characters <= 128 characters

fieldPath

string

<= 256 characters

left

string

>= 1 characters <= 128 characters

reasonCode

string

Allowed values: computation-error source-data-error disclosure-risk

recordType

string

>= 1 characters <= 128 characters

refusalCode

string

>= 1 characters <= 128 characters

right

string

>= 1 characters <= 128 characters

status

required

integer

>= 400 <= 599

title

required

string

<= 128 characters

traceId

required

string

>= 32 characters <= 32 characters /^[0-9a-f]{32}$/

type

required

string format: uri

<= 256 characters

Examples

Examplerequest.invalid

{
  "code": "request.invalid",
  "detail": "The request is invalid.",
  "status": 400,
  "title": "Bad Request",
  "traceId": "11111111111111111111111111111111",
  "type": "https://id.registrystack.org/problems/registry-breg/request/invalid"
}

Headers

Cache-Control

Allowed value: no-store

Caller-dependent responses must not be stored.

traceparent

string

>= 55 characters <= 55 characters /^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$/

Trace context for this problem response.

Example

00-11111111111111111111111111111111-2222222222222222-01

401

Problem response

Media typeapplication/problem+json

object

code

required

string

Allowed values: action.evidence_failed action.guard_failed action.handler_failed action.refused authentication.refused idempotency.conflict idempotency.expired ingestion.chunk_mismatch ingestion.profile_mismatch ingestion.receipt_erased ingestion.run_blocked ingestion.run_not_open lookup.unresolved mutation.conflict precondition.failed precondition.required proposal.rejected proposal.review_result_mismatch proposal.submission_expired query.cursor_invalid query.invalid request.invalid request.timeout resource.not_found runtime.field_encryption.unavailable service.unavailable source.unavailable statistical_dataset.domain_violation statistical_dataset.release_refused statistical_dataset.version_conflict statistical_dataset.version_withdrawn unsupported.media_type

constraintId

string

>= 1 characters <= 128 characters

constraintKind

string

Allowed values: compare int-range vocabulary

detail

required

string

<= 256 characters

field

string

>= 1 characters <= 128 characters

fieldId

string

>= 1 characters <= 128 characters

fieldPath

string

<= 256 characters

left

string

>= 1 characters <= 128 characters

reasonCode

string

Allowed values: computation-error source-data-error disclosure-risk

recordType

string

>= 1 characters <= 128 characters

refusalCode

string

>= 1 characters <= 128 characters

right

string

>= 1 characters <= 128 characters

status

required

integer

>= 400 <= 599

title

required

string

<= 128 characters

traceId

required

string

>= 32 characters <= 32 characters /^[0-9a-f]{32}$/

type

required

string format: uri

<= 256 characters

Examples

Exampleauthentication.refused

{
  "code": "authentication.refused",
  "detail": "The bearer credential is missing or refused.",
  "status": 401,
  "title": "Unauthorized",
  "traceId": "11111111111111111111111111111111",
  "type": "https://id.registrystack.org/problems/registry-breg/authentication/refused"
}

Headers

Cache-Control

Allowed value: no-store

Caller-dependent responses must not be stored.

traceparent

string

>= 55 characters <= 55 characters /^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$/

Trace context for this problem response.

Example

00-11111111111111111111111111111111-2222222222222222-01

404

Problem response

Media typeapplication/problem+json

object

code

required

string

Allowed values: action.evidence_failed action.guard_failed action.handler_failed action.refused authentication.refused idempotency.conflict idempotency.expired ingestion.chunk_mismatch ingestion.profile_mismatch ingestion.receipt_erased ingestion.run_blocked ingestion.run_not_open lookup.unresolved mutation.conflict precondition.failed precondition.required proposal.rejected proposal.review_result_mismatch proposal.submission_expired query.cursor_invalid query.invalid request.invalid request.timeout resource.not_found runtime.field_encryption.unavailable service.unavailable source.unavailable statistical_dataset.domain_violation statistical_dataset.release_refused statistical_dataset.version_conflict statistical_dataset.version_withdrawn unsupported.media_type

constraintId

string

>= 1 characters <= 128 characters

constraintKind

string

Allowed values: compare int-range vocabulary

detail

required

string

<= 256 characters

field

string

>= 1 characters <= 128 characters

fieldId

string

>= 1 characters <= 128 characters

fieldPath

string

<= 256 characters

left

string

>= 1 characters <= 128 characters

reasonCode

string

Allowed values: computation-error source-data-error disclosure-risk

recordType

string

>= 1 characters <= 128 characters

refusalCode

string

>= 1 characters <= 128 characters

right

string

>= 1 characters <= 128 characters

status

required

integer

>= 400 <= 599

title

required

string

<= 128 characters

traceId

required

string

>= 32 characters <= 32 characters /^[0-9a-f]{32}$/

type

required

string format: uri

<= 256 characters

Examples

Exampleresource.not_found

{
  "code": "resource.not_found",
  "detail": "The requested resource was not found.",
  "status": 404,
  "title": "Not Found",
  "traceId": "11111111111111111111111111111111",
  "type": "https://id.registrystack.org/problems/registry-breg/resource/not_found"
}

Headers

Cache-Control

Allowed value: no-store

Caller-dependent responses must not be stored.

traceparent

string

>= 55 characters <= 55 characters /^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$/

Trace context for this problem response.

Example

00-11111111111111111111111111111111-2222222222222222-01

503

Problem response

Media typeapplication/problem+json

object

code

required

string

Allowed values: action.evidence_failed action.guard_failed action.handler_failed action.refused authentication.refused idempotency.conflict idempotency.expired ingestion.chunk_mismatch ingestion.profile_mismatch ingestion.receipt_erased ingestion.run_blocked ingestion.run_not_open lookup.unresolved mutation.conflict precondition.failed precondition.required proposal.rejected proposal.review_result_mismatch proposal.submission_expired query.cursor_invalid query.invalid request.invalid request.timeout resource.not_found runtime.field_encryption.unavailable service.unavailable source.unavailable statistical_dataset.domain_violation statistical_dataset.release_refused statistical_dataset.version_conflict statistical_dataset.version_withdrawn unsupported.media_type

constraintId

string

>= 1 characters <= 128 characters

constraintKind

string

Allowed values: compare int-range vocabulary

detail

required

string

<= 256 characters

field

string

>= 1 characters <= 128 characters

fieldId

string

>= 1 characters <= 128 characters

fieldPath

string

<= 256 characters

left

string

>= 1 characters <= 128 characters

reasonCode

string

Allowed values: computation-error source-data-error disclosure-risk

recordType

string

>= 1 characters <= 128 characters

refusalCode

string

>= 1 characters <= 128 characters

right

string

>= 1 characters <= 128 characters

status

required

integer

>= 400 <= 599

title

required

string

<= 128 characters

traceId

required

string

>= 32 characters <= 32 characters /^[0-9a-f]{32}$/

type

required

string format: uri

<= 256 characters

Examples

Examplesource.unavailable

{
  "code": "source.unavailable",
  "detail": "The Registry data service is unavailable.",
  "status": 503,
  "title": "Service Unavailable",
  "traceId": "11111111111111111111111111111111",
  "type": "https://id.registrystack.org/problems/registry-breg/source/unavailable"
}

Headers

Cache-Control

Allowed value: no-store

Caller-dependent responses must not be stored.

traceparent

string

>= 55 characters <= 55 characters /^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$/

Trace context for this problem response.

Example

00-11111111111111111111111111111111-2222222222222222-01

504

Problem response

Media typeapplication/problem+json

object

code

required

string

Allowed values: action.evidence_failed action.guard_failed action.handler_failed action.refused authentication.refused idempotency.conflict idempotency.expired ingestion.chunk_mismatch ingestion.profile_mismatch ingestion.receipt_erased ingestion.run_blocked ingestion.run_not_open lookup.unresolved mutation.conflict precondition.failed precondition.required proposal.rejected proposal.review_result_mismatch proposal.submission_expired query.cursor_invalid query.invalid request.invalid request.timeout resource.not_found runtime.field_encryption.unavailable service.unavailable source.unavailable statistical_dataset.domain_violation statistical_dataset.release_refused statistical_dataset.version_conflict statistical_dataset.version_withdrawn unsupported.media_type

constraintId

string

>= 1 characters <= 128 characters

constraintKind

string

Allowed values: compare int-range vocabulary

detail

required

string

<= 256 characters

field

string

>= 1 characters <= 128 characters

fieldId

string

>= 1 characters <= 128 characters

fieldPath

string

<= 256 characters

left

string

>= 1 characters <= 128 characters

reasonCode

string

Allowed values: computation-error source-data-error disclosure-risk

recordType

string

>= 1 characters <= 128 characters

refusalCode

string

>= 1 characters <= 128 characters

right

string

>= 1 characters <= 128 characters

status

required

integer

>= 400 <= 599

title

required

string

<= 128 characters

traceId

required

string

>= 32 characters <= 32 characters /^[0-9a-f]{32}$/

type

required

string format: uri

<= 256 characters

Examples

Examplerequest.timeout

{
  "code": "request.timeout",
  "detail": "The request timed out.",
  "status": 504,
  "title": "Gateway Timeout",
  "traceId": "11111111111111111111111111111111",
  "type": "https://id.registrystack.org/problems/registry-breg/request/timeout"
}

Headers

Cache-Control

Allowed value: no-store

Caller-dependent responses must not be stored.

traceparent

string

>= 55 characters <= 55 characters /^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$/

Trace context for this problem response.

Example

00-11111111111111111111111111111111-2222222222222222-01