documentation API reference | AppointmentTrader

GET

/v1/documentation/get_search_index

Get a compact index of documented endpoints and category links. Public-by-design: guests can search the public API reference; restricted documentation requires developer access.

Request example (cURL)

curl --get \
  'https://ca.appointmenttrader.com/v1/documentation/get_search_index' \
  --data-urlencode 'key={{API_KEY}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`documentation_get_search_index_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.entries`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.entries[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.entries[].category`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.entries[].method`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.entries[].summary`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.entries[].url`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.categories`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.categories[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.categories[].name`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.categories[].description`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.categories[].count`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.categories[].url`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.version`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.maxAge`	`= 3600`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/documentation/get_search_index",
    "RequestUserAlias": "example-user",
    "Payload": {
        "entries": [
            {
                "category": "example",
                "method": "get_example",
                "summary": "Read synthetic example.",
                "url": "/api-documentation?category=example#ep-example-get_example"
            }
        ],
        "categories": [
            {
                "name": "example",
                "description": "Synthetic examples.",
                "count": 1,
                "url": "/api-documentation?category=example"
            }
        ],
        "version": "api-docs-0000000000000000000000000000000000000000000000000000000000000000",
        "maxAge": 3600
    }
}

Machine-readable endpoint documentation