Nothing Found
    Nothing Found
Help Centre
Select...

How to try out an API

Try out an API’s endpoints to see how they work.

You need to be logged in and have a valid credential for the endpoint you want to try out. If the API you want to use is restricted, you need to request access before you can get credentials for it.
Need help getting started? Take a look at our QuickStart Guide. If you need help with adding apps and credentials, check out our How to get credentials tutorial.

Step 1 - Choose an API to try out

  1. Click or tap the Our APIs tab in the top menu to view our APIs.
  2. Click or tap on an API to view its documentation.
  3. In the left menu, click or tap on the endpoint you’re interested in.
  4. In the right hand panel, click or tap the Try it button.
If you aren’t logged in already, you’ll be prompted to log in or sign up.

Step 2 - Provide a valid credential

  1. In Credentials, choose or enter a valid credential.

You may see various options, depending on the endpoint. Some endpoints permit you to use a credential you created within the Developer Portal. You can select from apps which have credentials that will work with the endpoint.

Other endpoints may require you to enter a credential created outside of the Developer Portal. You can paste the credential into the text entry field(s).

You may also have the option to 'skip' credential entry and instead enter an Access Token generated outside of the Developer Portal.

If the API is secured in Auth0 and you need an OAuth 2.0 Client Credential grant credential, only a credential created for that specific API will be valid.
  1. If prompted, click or tap Generate access token.
You need to generate an access token for all OAuth 2.0 grant types, including Client Credential, Authorisation Code and Password.
  1. Review your credential details, and, if returned, your JWT.

If your credential has any scopes associated with it, check the ones you want to use in the request. You’ll only see the scopes you've been provisioned with your credential. The API documentation will include information about which scopes you need for the endpoint you’re trying out.

Step 3 - Add parameters

  1. Enter any mandatory parameters.
  2. Enter any optional parameters you wish to include in your request.
Depending on the endpoint you’re trying out, the Request panel may include path parameters, query parameters or request body parameters - or any combination of these. For more information about the specific parameters in the endpoint you’re trying out, read the API documentation.

Step 4 - Send your request

  1. Review the target service and endpoint.
  2. Click or tap Send.

Step 5 - View the response

  1. Click or tap the Response tab to view the response.