Find keys based on its ID. The fields listed here will be returned when this method is called.



Name Type Description
id Required string The ID of the key.
files boolean Return attached files.
Expected request JSON HTTP POST
    "id": "73847df8-e993-11e2-b739-a20c5589acc5",
    "files": true
Expected response JSON XML PHP
    "generated_in": "0.021",
    "status": "ok",
    "key": [
            "id": "73847df8-e993-11e2-b739-a20c5589acc5",
            "date_added": "2021-02-24 11:56:22",
            "date_modified": "2021-08-27 16:17:57",
            "name": "",
            "key_starting": "E",
            "key_ending": "",
            "arrangement_id": "84937df8-e993-11e2-b739-a20c5589acc5"
Error responses

Please see our response status codes documentation for details of potential error responses for any API request.

  • 250: Invalid page number The page number you have provided is invalid.
  • 250: Invalid page size The page size must be between 10 and 1000.
  • 401: No Key ID provided You need to specify the ID of the keys.