get

Gets a document.


Query Syntax

HTTP

Copied to clipboard!
URL: http://kuzzle:7512/<index>/<collection>/<documentId>[?includeTrash=<boolean>]
Method: GET

Other protocols

Copied to clipboard!
{
  "index": "<index>",
  "collection": "<collection>",
  "controller": "document",
  "action": "get",
  "_id": "<documentId>",
  "includeTrash": false
}

Arguments

  • collection: collection name
  • documentId: document unique identifier
  • index: index name

Optional:

  • includeTrash: if true, documents in the trashcan can be returned

Response

Returns an object with the following properties:

  • _id: document unique identifier
  • _source: document content
  • _version: version of the created document (should be 1)
Copied to clipboard!
{
  "status": 200,
  "error": null,
  "index": "<index>",
  "collection": "<collection>",
  "controller": "document",
  "action": "get",
  "requestId": "<unique request identifier>",
  "result": {
    "_id": "<documentId>",
    "_version": 1,
    "_source": {
      "name": {
        "first": "Steve",
        "last": "Wozniak"
      },
      "hobby": "Segway polo",
      "_kuzzle_info": {
        "author": "Bob",
        "createdAt": 1481816934209,
        "updatedAt": null,
        "updater": null,
        "active": true,
        "deletedAt": null
      }
    }
  }
}