The API Request action in API by Zapier lets you securely call any API: credentials are stored in your connection and never exposed in the Zap. You send an HTTP request (GET, POST, PUT, PATCH, or DELETE) to any URL and optionally add query params, headers, and a body.
Prerequisites
- The API endpoint URL you want to call and, if required, any query params, headers, or body from the API docs.
Note- To use this feature, you'll need to be familiar with sending HTTP requests, APIs, and reading API documentation.
- Zapier Support can help with the API by Zapier action itself but cannot troubleshoot the API you use.
1. Add the action
- In the Zap editor, click the Action step (or the + to add a step). A dialog box will appear.
- Search for and select API by Zapier.
- Select the API Request action event.
- Choose your API by Zapier connection (or create one).
- Click Continue.
API by Zapier steps all display the same app name in your Zap flow. To make it easier to identify which API each step calls, click the step name in the editor and rename it to something descriptive (e.g., "Create Jira Issue" or "Update HubSpot Contact"). You can also add notes to your steps for more context.
2. Configure the request
Open the Configure tab and complete the fields below.
Method
Select the HTTP method from the dropdown (e.g. GET, POST, PUT, PATCH, DELETE). Use whatever your API endpoint expects.
URL
Enter the full URL for the request. The URL must match your connection's domain filter (the domain(s) you allowed when you set up the connection).
Query String Parameters (optional)
Add key-value pairs to append to the URL as query parameters. Use this for pagination, filters, or other options your API supports.
Headers (optional)
Add any additional headers the API needs. Authentication headers are added automatically from your connection; only add extra headers (e.g. Accept, custom headers) here.
Body (optional)
Enter the request body when the method requires it (e.g. POST with a JSON body). For JSON, provide valid JSON (e.g. {"key": "value"}). Content-Type will be auto-detected as application/json if the body is a valid JSON object.
You can map values from previous steps into the body. Ensure the result is valid JSON, including proper quoting.
3. Test the action
- Click Continue.
- Click Test step to run the request.
- Review the response. If the API returns an error, check the URL, method, and that your connection's auth (if any) is valid and that the URL matches your connection's domain filter.