GET /help/versions/{version_id}

Retrieves a single version documentation object.

Table 1. GET /help/versions/{version_id} resource details
MIME Type
application/json

Table 2. GET /help/versions/{version_id} request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
version_id	path	Required	Number (Integer)	text/plain	The ID of the version documentation to retrieve.
fields	query	Optional	String	text/plain	Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3. GET /help/versions/{version_id} response codes
HTTP Response Code	Unique Code	Description
200		The version documentation object was retrieved.
404	1002	No version documentation object was found for the provided version id.
500	1020	An unexpected error has occurred.

Response Description

A version documentation object. A version documentation object contains the following fields:

id - Number - The ID of the version documentation object. This ID is not permanent. It might change any time services are restarted.
deprecated - Boolean - Returns true if this version is deprecated. Returns false otherwise.
removed - Boolean - Returns true if this version is removed. Returns false otherwise. Endpoints cannot be called with an API version that is removed.
root_resource_ids - Array of Numbers - Resource IDs of the root resources in this version of the API.
version - String - The API version that this version documentation represents.


{
    "deprecated": true,
    "id": 42,
    "removed": true,
    "root_resource_ids": [
        42
    ],
    "version": "String"
}