Get an entity

get/entities/v1/{entityId}

Returns the entity's ID, the entity types, the provenance, and the properties with the data types and provenance of their values, of its current edition. propertyMetadata leaves out a value without a stored data type, and a list that contains one.

Requires a bearer token. See Entities authorization.

Copy link to this sectionPath ParametersCopy link to this section

entityIdstringRequired

The ID of the entity to read. An ID that names a draft is answered with 400.

Copy link to this sectionResponseCopy link to this section

An entity the caller may view.

application/json

metadataRequired

What identifies and classifies the entity, and where its data comes from.

propertiesRequired

The entity's properties, keyed by the base URL of their property type.

propertyMetadataRequired

The data types of the values in properties, and where they come from.

linkOptional

Copy link to this sectionHeadersCopy link to this section

RateLimit-PolicystringOptional

The budgets the request was checked against, one item each, as draft-ietf-httpapi-ratelimit-headers-11 defines them. q is the burst a budget admits at once, and w the whole seconds an exhausted budget takes to refill, so q requests per w seconds stay within its sustained rate.

Example: "actor";q=500;w=50

RateLimitstringOptional

The requests each budget in RateLimit-Policy has left after this request, as its r. A crossed budget reports r=0.

Example: "actor";r=499

Cache-ControlstringRequired

Always private, no-store: the response depends on the caller, so no cache stores it.

Example: private, no-store

Get an entity · Request

curl -X GET 'https://api.hash.ai/entities/v1/8d86c8c3-d66d-43d1-859b-676c3bcaeadc~be2c5b2f-e3e1-4f26-a0c4-0f8b5e9c4a1d' \
  -H "Authorization: Bearer $HASH_API_KEY"

curl -X GET 'https://api.hash.ai/entities/v1/8d86c8c3-d66d-43d1-859b-676c3bcaeadc~be2c5b2f-e3e1-4f26-a0c4-0f8b5e9c4a1d' \  -H "Authorization: Bearer $HASH_API_KEY"

Get an entity · Response

Schema

{
  "metadata": {
    "entityId": "8d86c8c3-d66d-43d1-859b-676c3bcaeadc~be2c5b2f-e3e1-4f26-a0c4-0f8b5e9c4a1d",
    "entityTypeIds": [
      "https://hash.ai/@h/types/entity-type/user/v/1"
    ],
    "provenance": {
      "actorType": "user",
      "origin": {
        "type": "external"
      }
    }
  },
  "properties": {
    "https://hash.ai/@h/types/property-type/preferred-name/": "Alice",
    "https://hash.ai/@h/types/property-type/shortname/": "alice"
  },
  "propertyMetadata": {
    "https://hash.ai/@h/types/property-type/preferred-name/": {
      "dataTypeId": "https://blockprotocol.org/@blockprotocol/types/data-type/text/v/1"
    },
    "https://hash.ai/@h/types/property-type/shortname/": {
      "dataTypeId": "https://blockprotocol.org/@blockprotocol/types/data-type/text/v/1"
    }
  }
}

{  "metadata": {    "entityId": "8d86c8c3-d66d-43d1-859b-676c3bcaeadc~be2c5b2f-e3e1-4f26-a0c4-0f8b5e9c4a1d",    "entityTypeIds": [      "https://hash.ai/@h/types/entity-type/user/v/1"    ],    "provenance": {      "actorType": "user",      "origin": {        "type": "external"      }    }  },  "properties": {    "https://hash.ai/@h/types/property-type/preferred-name/": "Alice",    "https://hash.ai/@h/types/property-type/shortname/": "alice"  },  "propertyMetadata": {    "https://hash.ai/@h/types/property-type/preferred-name/": {      "dataTypeId": "https://blockprotocol.org/@blockprotocol/types/data-type/text/v/1"    },    "https://hash.ai/@h/types/property-type/shortname/": {      "dataTypeId": "https://blockprotocol.org/@blockprotocol/types/data-type/text/v/1"    }  }}

PreviousCreate entities

NextQuery entities

Get an entity

Copy link to this sectionPath ParametersCopy link to this section

Copy link to this sectionResponseCopy link to this section

Copy link to this sectionHeadersCopy link to this section

Join our community of HASH developers

Learn

Projects

Get Involved