Getting Started
Introduction
Welcome to SwitchTransact's API documentation
Notes
- API endpoints are RESTful GET/POST HTTP requests
- A Token will be passed for all request through the header and found under the Developers section.
- Requests to the API will be limited to 100 requests per second to reduce the load on the platform.
- A validation error will come back as an HTTP 422 and will include a message about the error. These errors are documented here.
- Dates are to be specified as YYYY-MM-DD
- Required column keys are defined as:
- Y - Yes
- N - No
- C - Conditional
- L - Lookup Value (Lookups table ID or title must be provided as input)
- F - Defaults to No
/workflow
paths require approval on the admin system before changes will be incorporated into production.
Authentication
URL | https://app.switchtransact.com/api/1.0 |
---|---|
Headers | |
Authorization | Token generated in API section |
Content-Type | application/json |
Response codes
200 | Successful response |
---|---|
401 | Unauthorized |
422 | Validation error |
429 | Rate limit reached |
500 | API error |