---
title: "READ: Retrieves a single document from the collection"
method: GET
path: "/{collection}/{identifier}"
tags: ["generic"]
---

# READ: Retrieves a single document from the collection

`GET /{collection}/{identifier}`

Basically this operation looks for a document matching the `identifier` field returning 200 or 404 HTTP status code.

If the document has been found in the collection but it had already been deleted, 410 HTTP status code is to be returned.

When `If-Modified-Since` header is used and its value is greater than the timestamp of the document in the collection, 304 HTTP status code with empty response content is returned. It means that the document has not been modified on server since the last retrieval to client side. With `If-Modified-Since` header and less or equal timestamp `srvModified` a normal 200 HTTP status with full response is returned.

This operation requires `read` permission for the API and the collection (e.g. `api:treatments:read`)

## Query parameters

- `fields` string

## Headers

- `If-Modified-Since` string

## Response `200`

The document has been succesfully found and its JSON form returned in the response content.

- object
  - `status` integer
  - `result` union — Single document
    - object — Shared base for all documents
      - `identifier` string — Main addressing, required field that identifies document in the collection. The client should not create the identifier, the server automatically assigns it when the document is inserted. The server calculates the identifier in such a way that duplicate records are automatically merged (deduplicating is made by `date`, `device` and `eventType` fields). The best practise for all applications is not to loose identifiers from received documents, but save them carefully for other consumer applications/systems. API v3 has a fallback mechanism in place, for documents without `identifier` field the `identifier` is set to internal `_id`, when reading or addressing these documents. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `date` integer, required — Required timestamp when the record or event occured, you can choose from three input formats - Unix epoch in milliseconds (1525383610088) - Unix epoch in seconds (1525383610) - ISO 8601 with optional timezone ('2018-05-03T21:40:10.088Z' or '2018-05-03T23:40:10.088+02:00') The date is always stored in a normalized form - UTC with zero offset. If UTC offset was present, it is going to be set in the `utcOffset` field. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `utcOffset` integer — Local UTC offset (timezone) of the event in minutes. This field can be set either directly by the client (in the incoming document) or it is automatically parsed from the `date` field. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `app` string, required — Application or system in which the record was entered by human or device for the first time. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `device` string — The device from which the data originated (including serial number of the device, if it is relevant and safe). Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `_id` string — Internally assigned database id. This field is for internal server purposes only, clients communicate with API by using identifier field.
      - `srvCreated` integer — The server's timestamp of document insertion into the database (Unix epoch in ms). This field appears only for documents which were inserted by API v3. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `subject` string — Name of the security subject (within Nightscout scope) which has created the document. This field is automatically set by the server from the passed JWT. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `srvModified` integer — The server's timestamp of the last document modification in the database (Unix epoch in ms). This field appears only for documents which were somehow modified by API v3 (inserted, updated or deleted). Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `modifiedBy` string — Name of the security subject (within Nightscout scope) which has patched or deleted the document for the last time. This field is automatically set by the server. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `isValid` boolean — A flag set by the server only for deleted documents. This field appears only within history operation and for documents which were deleted by API v3 (and they always have a false value) Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `isReadOnly` boolean — A flag set by client that locks the document from any changes. Every document marked with `isReadOnly=true` is forever immutable and cannot even be deleted. Any attempt to modify the read-only document will end with status 422 UNPROCESSABLE ENTITY.
      - `some_property` string — ...
    - object — Shared base for all documents
      - `identifier` string — Main addressing, required field that identifies document in the collection. The client should not create the identifier, the server automatically assigns it when the document is inserted. The server calculates the identifier in such a way that duplicate records are automatically merged (deduplicating is made by `date`, `device` and `eventType` fields). The best practise for all applications is not to loose identifiers from received documents, but save them carefully for other consumer applications/systems. API v3 has a fallback mechanism in place, for documents without `identifier` field the `identifier` is set to internal `_id`, when reading or addressing these documents. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `date` integer, required — Required timestamp when the record or event occured, you can choose from three input formats - Unix epoch in milliseconds (1525383610088) - Unix epoch in seconds (1525383610) - ISO 8601 with optional timezone ('2018-05-03T21:40:10.088Z' or '2018-05-03T23:40:10.088+02:00') The date is always stored in a normalized form - UTC with zero offset. If UTC offset was present, it is going to be set in the `utcOffset` field. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `utcOffset` integer — Local UTC offset (timezone) of the event in minutes. This field can be set either directly by the client (in the incoming document) or it is automatically parsed from the `date` field. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `app` string, required — Application or system in which the record was entered by human or device for the first time. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `device` string — The device from which the data originated (including serial number of the device, if it is relevant and safe). Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `_id` string — Internally assigned database id. This field is for internal server purposes only, clients communicate with API by using identifier field.
      - `srvCreated` integer — The server's timestamp of document insertion into the database (Unix epoch in ms). This field appears only for documents which were inserted by API v3. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `subject` string — Name of the security subject (within Nightscout scope) which has created the document. This field is automatically set by the server from the passed JWT. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `srvModified` integer — The server's timestamp of the last document modification in the database (Unix epoch in ms). This field appears only for documents which were somehow modified by API v3 (inserted, updated or deleted). Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `modifiedBy` string — Name of the security subject (within Nightscout scope) which has patched or deleted the document for the last time. This field is automatically set by the server. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `isValid` boolean — A flag set by the server only for deleted documents. This field appears only within history operation and for documents which were deleted by API v3 (and they always have a false value) Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `isReadOnly` boolean — A flag set by client that locks the document from any changes. Every document marked with `isReadOnly=true` is forever immutable and cannot even be deleted. Any attempt to modify the read-only document will end with status 422 UNPROCESSABLE ENTITY.
      - `type` string — sgv, mbg, cal, etc
      - `sgv` number — The glucose reading. (only available for sgv types)
      - `direction` string — Direction of glucose trend reported by CGM. (only available for sgv types)
      - `noise` number — Noise level at time of reading. (only available for sgv types)
      - `filtered` number — The raw filtered value directly from CGM transmitter. (only available for sgv types)
      - `unfiltered` number — The raw unfiltered value directly from CGM transmitter. (only available for sgv types)
      - `rssi` number — The signal strength from CGM transmitter. (only available for sgv types)
      - `units` string — The units for the glucose value, mg/dl or mmol/l. It is strongly recommended to fill in this field.
    - object — Shared base for all documents
      - `identifier` string — Main addressing, required field that identifies document in the collection. The client should not create the identifier, the server automatically assigns it when the document is inserted. The server calculates the identifier in such a way that duplicate records are automatically merged (deduplicating is made by `date`, `device` and `eventType` fields). The best practise for all applications is not to loose identifiers from received documents, but save them carefully for other consumer applications/systems. API v3 has a fallback mechanism in place, for documents without `identifier` field the `identifier` is set to internal `_id`, when reading or addressing these documents. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `date` integer, required — Required timestamp when the record or event occured, you can choose from three input formats - Unix epoch in milliseconds (1525383610088) - Unix epoch in seconds (1525383610) - ISO 8601 with optional timezone ('2018-05-03T21:40:10.088Z' or '2018-05-03T23:40:10.088+02:00') The date is always stored in a normalized form - UTC with zero offset. If UTC offset was present, it is going to be set in the `utcOffset` field. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `utcOffset` integer — Local UTC offset (timezone) of the event in minutes. This field can be set either directly by the client (in the incoming document) or it is automatically parsed from the `date` field. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `app` string, required — Application or system in which the record was entered by human or device for the first time. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `device` string — The device from which the data originated (including serial number of the device, if it is relevant and safe). Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `_id` string — Internally assigned database id. This field is for internal server purposes only, clients communicate with API by using identifier field.
      - `srvCreated` integer — The server's timestamp of document insertion into the database (Unix epoch in ms). This field appears only for documents which were inserted by API v3. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `subject` string — Name of the security subject (within Nightscout scope) which has created the document. This field is automatically set by the server from the passed JWT. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `srvModified` integer — The server's timestamp of the last document modification in the database (Unix epoch in ms). This field appears only for documents which were somehow modified by API v3 (inserted, updated or deleted). Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `modifiedBy` string — Name of the security subject (within Nightscout scope) which has patched or deleted the document for the last time. This field is automatically set by the server. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `isValid` boolean — A flag set by the server only for deleted documents. This field appears only within history operation and for documents which were deleted by API v3 (and they always have a false value) Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `isReadOnly` boolean — A flag set by client that locks the document from any changes. Every document marked with `isReadOnly=true` is forever immutable and cannot even be deleted. Any attempt to modify the read-only document will end with status 422 UNPROCESSABLE ENTITY.
      - `food` string — food, quickpick
      - `category` string — Name for a group of related records
      - `subcategory` string — Name for a second level of groupping
      - `name` string — Name of the food described
      - `portion` number — Number of units (e.g. grams) of the whole portion described
      - `unit` string — Unit for the portion
      - `carbs` number — Amount of carbs in the portion in grams
      - `fat` number — Amount of fat in the portion in grams
      - `protein` number — Amount of proteins in the portion in grams
      - `energy` number — Amount of energy in the portion in kJ
      - `gi` number — Glycemic index (1=low, 2=medium, 3=high)
      - `hideafteruse` boolean — Flag used for quickpick
      - `hidden` boolean — Flag used for quickpick
      - `position` number — Ordering field for quickpick
      - `portions` number — component multiplier if defined inside quickpick compound
      - `foods` Food[] — Neighbour documents (from food collection) that together make a quickpick compound
        - `identifier` string — Main addressing, required field that identifies document in the collection. The client should not create the identifier, the server automatically assigns it when the document is inserted. The server calculates the identifier in such a way that duplicate records are automatically merged (deduplicating is made by `date`, `device` and `eventType` fields). The best practise for all applications is not to loose identifiers from received documents, but save them carefully for other consumer applications/systems. API v3 has a fallback mechanism in place, for documents without `identifier` field the `identifier` is set to internal `_id`, when reading or addressing these documents. Note&#58; this field is immutable by the client (it cannot be updated or patched)
        - `date` integer, required — Required timestamp when the record or event occured, you can choose from three input formats - Unix epoch in milliseconds (1525383610088) - Unix epoch in seconds (1525383610) - ISO 8601 with optional timezone ('2018-05-03T21:40:10.088Z' or '2018-05-03T23:40:10.088+02:00') The date is always stored in a normalized form - UTC with zero offset. If UTC offset was present, it is going to be set in the `utcOffset` field. Note&#58; this field is immutable by the client (it cannot be updated or patched)
        - `utcOffset` integer — Local UTC offset (timezone) of the event in minutes. This field can be set either directly by the client (in the incoming document) or it is automatically parsed from the `date` field. Note&#58; this field is immutable by the client (it cannot be updated or patched)
        - `app` string, required — Application or system in which the record was entered by human or device for the first time. Note&#58; this field is immutable by the client (it cannot be updated or patched)
        - `device` string — The device from which the data originated (including serial number of the device, if it is relevant and safe). Note&#58; this field is immutable by the client (it cannot be updated or patched)
        - `_id` string — Internally assigned database id. This field is for internal server purposes only, clients communicate with API by using identifier field.
        - `srvCreated` integer — The server's timestamp of document insertion into the database (Unix epoch in ms). This field appears only for documents which were inserted by API v3. Note&#58; this field is immutable by the client (it cannot be updated or patched)
        - `subject` string — Name of the security subject (within Nightscout scope) which has created the document. This field is automatically set by the server from the passed JWT. Note&#58; this field is immutable by the client (it cannot be updated or patched)
        - `srvModified` integer — The server's timestamp of the last document modification in the database (Unix epoch in ms). This field appears only for documents which were somehow modified by API v3 (inserted, updated or deleted). Note&#58; this field is immutable by the client (it cannot be updated or patched)
        - `modifiedBy` string — Name of the security subject (within Nightscout scope) which has patched or deleted the document for the last time. This field is automatically set by the server. Note&#58; this field is immutable by the client (it cannot be updated or patched)
        - `isValid` boolean — A flag set by the server only for deleted documents. This field appears only within history operation and for documents which were deleted by API v3 (and they always have a false value) Note&#58; this field is immutable by the client (it cannot be updated or patched)
        - `isReadOnly` boolean — A flag set by client that locks the document from any changes. Every document marked with `isReadOnly=true` is forever immutable and cannot even be deleted. Any attempt to modify the read-only document will end with status 422 UNPROCESSABLE ENTITY.
        - `food` string — food, quickpick
        - `category` string — Name for a group of related records
        - `subcategory` string — Name for a second level of groupping
        - `name` string — Name of the food described
        - `portion` number — Number of units (e.g. grams) of the whole portion described
        - `unit` string — Unit for the portion
        - `carbs` number — Amount of carbs in the portion in grams
        - `fat` number — Amount of fat in the portion in grams
        - `protein` number — Amount of proteins in the portion in grams
        - `energy` number — Amount of energy in the portion in kJ
        - `gi` number — Glycemic index (1=low, 2=medium, 3=high)
        - `hideafteruse` boolean — Flag used for quickpick
        - `hidden` boolean — Flag used for quickpick
        - `position` number — Ordering field for quickpick
        - `portions` number — component multiplier if defined inside quickpick compound
        - `foods` Food[] — Neighbour documents (from food collection) that together make a quickpick compound
    - object — Shared base for all documents
      - `identifier` string — Main addressing, required field that identifies document in the collection. The client should not create the identifier, the server automatically assigns it when the document is inserted. The server calculates the identifier in such a way that duplicate records are automatically merged (deduplicating is made by `date`, `device` and `eventType` fields). The best practise for all applications is not to loose identifiers from received documents, but save them carefully for other consumer applications/systems. API v3 has a fallback mechanism in place, for documents without `identifier` field the `identifier` is set to internal `_id`, when reading or addressing these documents. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `date` integer, required — Required timestamp when the record or event occured, you can choose from three input formats - Unix epoch in milliseconds (1525383610088) - Unix epoch in seconds (1525383610) - ISO 8601 with optional timezone ('2018-05-03T21:40:10.088Z' or '2018-05-03T23:40:10.088+02:00') The date is always stored in a normalized form - UTC with zero offset. If UTC offset was present, it is going to be set in the `utcOffset` field. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `utcOffset` integer — Local UTC offset (timezone) of the event in minutes. This field can be set either directly by the client (in the incoming document) or it is automatically parsed from the `date` field. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `app` string, required — Application or system in which the record was entered by human or device for the first time. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `device` string — The device from which the data originated (including serial number of the device, if it is relevant and safe). Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `_id` string — Internally assigned database id. This field is for internal server purposes only, clients communicate with API by using identifier field.
      - `srvCreated` integer — The server's timestamp of document insertion into the database (Unix epoch in ms). This field appears only for documents which were inserted by API v3. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `subject` string — Name of the security subject (within Nightscout scope) which has created the document. This field is automatically set by the server from the passed JWT. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `srvModified` integer — The server's timestamp of the last document modification in the database (Unix epoch in ms). This field appears only for documents which were somehow modified by API v3 (inserted, updated or deleted). Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `modifiedBy` string — Name of the security subject (within Nightscout scope) which has patched or deleted the document for the last time. This field is automatically set by the server. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `isValid` boolean — A flag set by the server only for deleted documents. This field appears only within history operation and for documents which were deleted by API v3 (and they always have a false value) Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `isReadOnly` boolean — A flag set by client that locks the document from any changes. Every document marked with `isReadOnly=true` is forever immutable and cannot even be deleted. Any attempt to modify the read-only document will end with status 422 UNPROCESSABLE ENTITY.
      - `some_property` string — ...
    - object — Shared base for all documents
      - `identifier` string — Main addressing, required field that identifies document in the collection. The client should not create the identifier, the server automatically assigns it when the document is inserted. The server calculates the identifier in such a way that duplicate records are automatically merged (deduplicating is made by `date`, `device` and `eventType` fields). The best practise for all applications is not to loose identifiers from received documents, but save them carefully for other consumer applications/systems. API v3 has a fallback mechanism in place, for documents without `identifier` field the `identifier` is set to internal `_id`, when reading or addressing these documents. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `date` integer, required — Required timestamp when the record or event occured, you can choose from three input formats - Unix epoch in milliseconds (1525383610088) - Unix epoch in seconds (1525383610) - ISO 8601 with optional timezone ('2018-05-03T21:40:10.088Z' or '2018-05-03T23:40:10.088+02:00') The date is always stored in a normalized form - UTC with zero offset. If UTC offset was present, it is going to be set in the `utcOffset` field. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `utcOffset` integer — Local UTC offset (timezone) of the event in minutes. This field can be set either directly by the client (in the incoming document) or it is automatically parsed from the `date` field. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `app` string, required — Application or system in which the record was entered by human or device for the first time. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `device` string — The device from which the data originated (including serial number of the device, if it is relevant and safe). Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `_id` string — Internally assigned database id. This field is for internal server purposes only, clients communicate with API by using identifier field.
      - `srvCreated` integer — The server's timestamp of document insertion into the database (Unix epoch in ms). This field appears only for documents which were inserted by API v3. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `subject` string — Name of the security subject (within Nightscout scope) which has created the document. This field is automatically set by the server from the passed JWT. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `srvModified` integer — The server's timestamp of the last document modification in the database (Unix epoch in ms). This field appears only for documents which were somehow modified by API v3 (inserted, updated or deleted). Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `modifiedBy` string — Name of the security subject (within Nightscout scope) which has patched or deleted the document for the last time. This field is automatically set by the server. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `isValid` boolean — A flag set by the server only for deleted documents. This field appears only within history operation and for documents which were deleted by API v3 (and they always have a false value) Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `isReadOnly` boolean — A flag set by client that locks the document from any changes. Every document marked with `isReadOnly=true` is forever immutable and cannot even be deleted. Any attempt to modify the read-only document will end with status 422 UNPROCESSABLE ENTITY.
      - `some_property` string — ...
    - object — Shared base for all documents
      - `identifier` string — Main addressing, required field that identifies document in the collection. The client should not create the identifier, the server automatically assigns it when the document is inserted. The server calculates the identifier in such a way that duplicate records are automatically merged (deduplicating is made by `date`, `device` and `eventType` fields). The best practise for all applications is not to loose identifiers from received documents, but save them carefully for other consumer applications/systems. API v3 has a fallback mechanism in place, for documents without `identifier` field the `identifier` is set to internal `_id`, when reading or addressing these documents. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `date` integer, required — Required timestamp when the record or event occured, you can choose from three input formats - Unix epoch in milliseconds (1525383610088) - Unix epoch in seconds (1525383610) - ISO 8601 with optional timezone ('2018-05-03T21:40:10.088Z' or '2018-05-03T23:40:10.088+02:00') The date is always stored in a normalized form - UTC with zero offset. If UTC offset was present, it is going to be set in the `utcOffset` field. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `utcOffset` integer — Local UTC offset (timezone) of the event in minutes. This field can be set either directly by the client (in the incoming document) or it is automatically parsed from the `date` field. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `app` string, required — Application or system in which the record was entered by human or device for the first time. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `device` string — The device from which the data originated (including serial number of the device, if it is relevant and safe). Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `_id` string — Internally assigned database id. This field is for internal server purposes only, clients communicate with API by using identifier field.
      - `srvCreated` integer — The server's timestamp of document insertion into the database (Unix epoch in ms). This field appears only for documents which were inserted by API v3. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `subject` string — Name of the security subject (within Nightscout scope) which has created the document. This field is automatically set by the server from the passed JWT. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `srvModified` integer — The server's timestamp of the last document modification in the database (Unix epoch in ms). This field appears only for documents which were somehow modified by API v3 (inserted, updated or deleted). Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `modifiedBy` string — Name of the security subject (within Nightscout scope) which has patched or deleted the document for the last time. This field is automatically set by the server. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `isValid` boolean — A flag set by the server only for deleted documents. This field appears only within history operation and for documents which were deleted by API v3 (and they always have a false value) Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `isReadOnly` boolean — A flag set by client that locks the document from any changes. Every document marked with `isReadOnly=true` is forever immutable and cannot even be deleted. Any attempt to modify the read-only document will end with status 422 UNPROCESSABLE ENTITY.
      - `eventType` string — The type of treatment event. Note&#58; this field is immutable by the client (it cannot be updated or patched)
      - `glucose` string — Current glucose.
      - `glucoseType` string — Method used to obtain glucose, Finger or Sensor.
      - `units` string — The units for the glucose value, mg/dl or mmol/l. It is strongly recommended to fill in this field when `glucose` is entered.
      - `carbs` number — Amount of carbs given.
      - `protein` number — Amount of protein given.
      - `fat` number — Amount of fat given.
      - `insulin` number — Amount of insulin, if any.
      - `duration` number — Duration in minutes.
      - `preBolus` number — How many minutes the bolus was given before the meal started.
      - `splitNow` number — Immediate part of combo bolus (in percent).
      - `splitExt` number — Extended part of combo bolus (in percent).
      - `percent` number — Eventual basal change in percent.
      - `absolute` number — Eventual basal change in absolute value (insulin units per hour).
      - `targetTop` number — Top limit of temporary target.
      - `targetBottom` number — Bottom limit of temporary target.
      - `profile` string — Name of the profile to which the pump has been switched.
      - `reason` string — For example the reason why the profile has been switched or why the temporary target has been set.
      - `notes` string — Description/notes of treatment.
      - `enteredBy` string — Who entered the treatment.

## Other responses

- `304` — The document has not been modified on the server since timestamp specified in If-Modified-Since header
- `401` — The request was not successfully authenticated using JWT, so that the request cannot continue due to the security policy.
- `403` — Insecure HTTP scheme used or the request has been successfully authenticated, but the security subject is not authorized for the operation.
- `404` — The collection or document specified was not found.
- `406` — The requested content type (in `Accept` header) is not supported.
- `410` — The requested document has already been deleted.

## Changes

- **2026-07-17** `5b0d424433e1` — 1 info
  - the endpoint scheme security `accessToken` was removed from the API
- **2021-01-07** `8252719e8e34` — 1 breaking, 11 info
  - the response's body type/format changed from `object`/`` to ``/`` for status `200`
  - the endpoint scheme security `accessToken` was added to the API
  - the endpoint scheme security `jwtoken` was added to the API
  - the endpoint scheme security `apiKeyAuth` was removed from the API
  - …8 more
- **2020-01-12** `4f4eedb269d0` — 3 info
  - added the media type `application/xml` for the response with the status `200`
  - added the media type `text/csv` for the response with the status `200`
  - added the non-success response with the status `406`
- **2019-11-02** `6b2eb690f4ab` — 6 info
  - added the optional property `oneOf[#/components/schemas/DeviceStatus]/allOf[#/components/schemas/DocumentBase]/isReadOnly` to the response with the `200` status
  - added the optional property `oneOf[#/components/schemas/Entry]/allOf[#/components/schemas/DocumentBase]/isReadOnly` to the response with the `200` status
  - added the optional property `oneOf[#/components/schemas/Food]/allOf[#/components/schemas/DocumentBase]/isReadOnly` to the response with the `200` status
  - added the optional property `oneOf[#/components/schemas/Profile]/allOf[#/components/schemas/DocumentBase]/isReadOnly` to the response with the `200` status
  - …2 more
- …earlier changes not shown

[Full history](https://skmtc.dev/nightscout/apis/nightscout-api/changes/:collection/:identifier/get.md)

---

[API](https://skmtc.dev/nightscout/apis/nightscout-api.md) · [All operations](https://skmtc.dev/nightscout/apis/nightscout-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nightscout/nightscout-api/revisions/5b0d424433e1/schema)
