Test API Requests

Test your API requests directly in the documentation before writing any code. Use real data to verify endpoints and ensure your requests return the expected results.

What you'll learn:

• Access the interactive API testing tool
• Configure your subdomain and API token
• Send requests and interpret responses

TL;DR

• Get started? Open the API Reference and select an endpoint
• Configure request? Enter your subdomain and API token in the request panel
• Test it? Click Send API Request to see real responses

Prerequisites

• Plan: Ultimate, Advanced, or Expert
• Permissions: Administrator access to Showpad's Admin App
• Config: An OAuth client or API token

Key Benefits

• Test in the heart of the API documentation
• Use real data to get real results
• Easily test for one or more Showpad organizations

Testing Multiple Organizations

To test against a different Showpad organization, simply change the Subdomain value. Each subdomain uses its own API token, so you'll need to enter the corresponding token for that organization.

Get Started

1. Open the API Reference and select the Showpad API version you want to work with.

   

2. Enter the Showpad subdomain to test in the Subdomain text area on the upper left. The information entered is automatically set as the Production server:

   

3. Next, select an endpoint and enter an API Token for the subdomain on the right:

   

4. Enter parameters, if any.

5. Click the Send API Request button.

The call's status code and response is displayed immediately below the testing area.

Response Formats

You can switch between two display formats:

• Preview - Formatted, easy-to-read view of the response
• Raw - Unformatted JSON response (useful for copying)

Copy Response

Click on the response to select it, then copy for use in your code or debugging.

Troubleshooting

Problem	Solution
401 Unauthorized	Check that your API token is valid and hasn't expired
403 Forbidden	Verify the token has the required scopes for this endpoint
404 Not Found	Confirm the subdomain and endpoint path are correct
No response	Check your network connection and try again

Rate Limits

The Showpad API has rate limits to ensure fair usage. If you're testing multiple requests in quick succession, you may receive a 429 Too Many Requests response. Wait a moment and try again.

Next Steps

Now that you can test API requests, explore these related topics:

• Error Codes - Understand error responses and how to resolve them
• Authentication - Learn about token types and OAuth flows
• API Reference - Full endpoint specifications for all versions