This guide covers the Platform API approach to executing actions. For direct REST access to provider data, see the Unified APIs.
x-account-id header, handles authentication, transforms requests to match provider APIs, and returns normalized data.
Execute an Action
- TypeScript SDK
- cURL
- Python
Request Parameters
| Parameter | Type | Description |
|---|---|---|
action | string | The action identifier (e.g., bamboohr_list_employees, greenhouse_create_candidate) |
query | object | Query parameters for the action |
body | object | Request body for write operations |
path | object | Path parameters (e.g., { "id": "emp_123" }) |
Headers
| Header | Required | Description |
|---|---|---|
x-account-id | Yes | The linked account to execute the action against |
Authorization | Yes | Basic auth with your API key |
Discover Available Actions
UseGET /actions to find what actions are available for a specific account or provider:
- TypeScript SDK
- cURL