Skip to main content
GET
/
api
/
examples
Get a list of example API definitions.
curl --request GET \
  --url https://{tenant}/api/examples \
  --header 'Authorization: Bearer <token>'
[
  {
    "location": "udg/vat-checker",
    "name": "VAT number checker UDG",
    "shortDescription": "Simple REST API wrapped in GQL using Universal Data Graph that allows user to check validity of a VAT number and display some details about it."
  },
  {
    "location": "udg/geo-info",
    "name": "Geo information about the World",
    "shortDescription": "Countries GQL API extended with information from geocode.xyz"
  },
  {
    "location": "udg/react-conferences",
    "name": "React conferences in Europe",
    "shortDescription": "Information about React conferences in Europe. This Data Graph stitches together two GQL APIs. The flag image is added by using Trevorblades API as a data source."
  }
]

Documentation Index

Fetch the complete documentation index at: https://tyk.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

The Tyk Dashboard API Access Credentials

Headers

​
x-tyk-examples-index
string
default:https://raw.githubusercontent.com/TykTechnologies/tyk-examples/main/repository.json

URL path to the repository.json in the repository defined in `x-tyk-repo-url.

Response

List of API examples response.

​
location
string
Example:

"udg/vat-checker"

​
name
string
Example:

"VAT number checker UDG"

​
shortDescription
string
Example:

"Simple REST API wrapped in GQL using Universal Data Graph that allows user to check validity of a VAT number and display some details about it."