---
title: "Get Single Reference"
method: GET
path: "/references/{entry_id}"
tags: ["References"]
---

# Get Single Reference

`GET /references/{entry_id}`

## Path parameters

- `entry_id` string, required

## Query parameters

- `response_format` string — The output format requested (see section Response Format). Defaults to the format string 'json', which specifies the standard output format described in this specification. Example: `http://example.com/v1/structures?response_format=xml`
- `email_address` string, email, nullable — An email address of the user making the request. The email SHOULD be that of a person and not an automatic system. Example: `http://example.com/v1/structures?email_address=user@example.com`
- `response_fields` string — A comma-delimited set of fields to be provided in the output. If provided, these fields MUST be returned along with the REQUIRED fields. Other OPTIONAL fields MUST NOT be returned when this parameter is present. Example: `http://example.com/v1/structures?response_fields=last_modified,nsites`
- `include` string — A server MAY implement the JSON API concept of returning [compound documents](https://jsonapi.org/format/1.0/#document-compound-documents) by utilizing the `include` query parameter as specified by [JSON API 1.0](https://jsonapi.org/format/1.0/#fetching-includes). All related resource objects MUST be returned as part of an array value for the top-level `included` field, see the section JSON Response Schema: Common Fields. The value of `include` MUST be a comma-separated list of "relationship paths", as defined in the [JSON API](https://jsonapi.org/format/1.0/#fetching-includes). If relationship paths are not supported, or a server is unable to identify a relationship path a `400 Bad Request` response MUST be made. The **default value** for `include` is `references`. This means `references` entries MUST always be included under the top-level field `included` as default, since a server assumes if `include` is not specified by a client in the request, it is still specified as `include=references`. Note, if a client explicitly specifies `include` and leaves out `references`, `references` resource objects MUST NOT be included under the top-level field `included`, as per the definition of `included`, see section JSON Response Schema: Common Fields. > **Note**: A query with the parameter `include` set to the empty string means no related resource objects are to be returned under the top-level field `included`.
- `api_hint` string — If the client provides the parameter, the value SHOULD have the format `vMAJOR` or `vMAJOR.MINOR`, where MAJOR is a major version and MINOR is a minor version of the API. For example, if a client appends `api_hint=v1.0` to the query string, the hint provided is for major version 1 and minor version 0.

## Response `200`

Successful Response

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `404` — Not Found
- `422` — Unprocessable Entity
- `500` — Internal Server Error
- `501` — Not Implemented
- `553` — Version Not Supported

---

[API](https://skmtc.net/materials-consortia/apis/optimade-api.md) · [All operations](https://skmtc.net/materials-consortia/apis/optimade-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/materials-consortia/optimade-api/versions/843c6d7e5fff/schema)