Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

GET /help/endpoints/{endpoint_id}

 

Retrieves a single endpoint documentation object.

Retrieves a single endpoint documentation object.

Table 1: GET /help/endpoints/{endpoint_id} Resource Details

MIME Type

application/json

Table 2: GET /help/endpoints/{endpoint_id} Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

endpoint_id

path

Required

Number (Integer)

text/plain

The endpoint id.

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/endpoints/{endpoint_id} Response Codes

HTTP Response Code

Unique Code

Description

200

 

The endpoint documentation object was retrieved.

404

1002

No endpoint documentation object was found for the provided endpoint id.

500

1020

An unexpected error has occurred.

Response Description

An endpoint documentation object. An endpoint documentation object contains the following fields:

  • id - Number - The ID of the endpoint documentation. This ID is not permanent. It might change any time services are restarted.

  • summary - String - A brief summary of the endpoint.

  • deprecated - Boolean - Returns true if the endpoint is deprecated. Returns false otherwise.

  • http_method - String - The HTTP request type. One of OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, CONNECT, PATCH.

  • error_responses - Array of Objects - A list of potential error responses of this endpoint.

  • error_responses(response_code) - Number - The HTTP code for this error response.

  • error_responses(description) - String - The description for this error response.

  • error_responses(unique_code) - Number - The unique code for this error response.

  • error_responses(response_code_description) - String - The description of the response.

  • response_description - String - The description of the response.

  • version - String - The version of this endpoint.

  • success_responses - Array of Objects - A list of potential success responses for this endpoint.

  • success_responses(response_code) - Number - The HTTP code for this response.

  • success_responses(description) - String - The description of this response.

  • success_responses(response_code_description) - String - The name for the response code from RFC 2616.

  • description - String - A description of this endpoint.

  • path - String - The path of this endpoint.

  • response_mime_types - Array of Objects - A list of possible response MIME types for this endpoint.

  • response_mime_types(mime_type) - String - The MIME type value, e.g. TEXT_PLAIN

  • response_mime_types(media_type) - String - The RFC style Media Type, e.g. text/plain This value is suitable for use in HTTP requests.

  • response_mime_types(sample) - String - The sample of this response MIME type.

  • parameters - Array of Objects - A list of user parameters for this endpoint.

  • parameters(description) - String - A description of this parameter.

  • parameters(default_value) - String - The default value of this parameter. Null if there is no default value for this parameter. This is always a String, regardless of the underlying data type of the parameter.

  • parameters(type) - String - The type of parameter, one of QUERY, HEADER, PATH, BODY.

  • parameters(parameter_name) - String - The name of this parameter.

  • parameters(mime_types) - Array of Objects - A list of possible mime_types for this parameter.

  • parameters(mime_types(data_type)) - String - A description of the data type of this parameter.

  • parameters(mime_types(mime_type)) - String - The MIME type of the parameter.

  • parameters(mime_types(sample)) - String - The sample for this parameter.

  • resource_id - Number - The ID of the associated resource.

  • last_modified_version - String - The API version this endpoint was last modified. It will be less than or equal to the version in the version field.

  • caller_has_access - Boolean - Returns true if the user has the required capabilities to call this endpoint. Returns false otherwise.

Response Sample