api-docs-icon

Retrieve single API link

GET
/ api_link/ {id}

id
string (uuid)
required

Responses

Retrieved api link

application/json
object
api_version
object
required

Summary object of the api version included in the api link

build_request_enabled
boolean
required
created_at
string (date-time)
required
doc_version
object
required

Summary object of the doc version included in the api link

group_id
string (uuid)
required
id
string (uuid)
required
include_mock_server
boolean
required

automatically add the sideko mock server as one of the server options when building a request in the api reference (requires mock server to be enabled on the linked Api Version)

nav_label
string
required
Example:
Generation API
order
integer
required
Example:
0
policy
enum
required

defines how the link should be automatically updated as new API version are added

Allowed Values:
latest
pinned
slug
string
required
Example:
generation-api

Code Examples

Response