GET /help/versions

Retrieves a list of version documentation objects currently in the system.

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

Table 2. GET /help/versions request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
Range	header	Optional	String	text/plain	Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.
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.
filter	query	Optional	String	text/plain	Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.

Table 3. GET /help/versions response codes
HTTP Response Code	Unique Code	Description
200		The version documentation list was retrieved.
500	1020	An unexpected error has occurred.

Response Description

An array of version documentation objects. 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 from 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.

Response Sample


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