API overview
Awtomated has two APIs for your own systems:
- Public API: create contacts, companies, deals, projects, leads, tickets, invoices and other records, read the choice lists your forms need, and send interpretation requests.
- Partner API: read and manage your vendors and their rate cards.
The endpoint reference lists every endpoint with its parameters and responses. It is generated from the code of the release that runs in production, so it is always current. You can also download the OpenAPI file for tools such as Postman or Insomnia.
Base URL
Section titled “Base URL”https://api.awtomated.comAll requests and responses use JSON. Send Content-Type: application/json with every request that has a body.
Get an API key
Section titled “Get an API key”An administrator of your organization creates the key in Awtomated under Settings > API (click Generate API Key). The Partner API tab on the same page creates partner keys. Keep keys secret: anyone with a key can act for your organization. You can roll (replace) a key there at any time.
Authentication
Section titled “Authentication”Public API (/public/...): send the key as the value of the Authorization header, without a prefix.
curl https://api.awtomated.com/public/choices/language/ \ -H "Authorization: YOUR_API_KEY"Partner API (/partner_api/...): partner keys start with aw_. Send them as a bearer token.
curl https://api.awtomated.com/partner_api/vendors/ \ -H "Authorization: Bearer aw_YOUR_PARTNER_KEY"Public API endpoints
Section titled “Public API endpoints”| Endpoint | What it does |
|---|---|
POST /public/<module>/ |
Creates a record. Modules: contacts, companies, deals, projects, tickets, leads, invoices, estimates, purchase_orders, payouts, project_files. |
GET /public/choices/<list>/ |
Returns a choice list for your forms. Lists: industry, domain, language, deal_pipeline, lead_pipeline, contact_origin, country_state, no_of_employees, vat_options, currency. |
GET /public/interpretation_requests/ |
Returns the fields an interpretation request needs. |
POST /public/interpretation_requests/ |
Creates an interpretation request. Sending the same external reference again returns the existing request instead of creating a duplicate. |
Status codes
Section titled “Status codes”| Code | Meaning |
|---|---|
| 200 | Success |
| 201 | Created |
| 400 | Bad request: a field is missing or invalid (the response says which) |
| 401 | Unauthorized: the API key is missing, wrong or rolled |
| 404 | Not found |
| 405 | Method not allowed |
| 422 | The API key or its settings are incomplete |
| 500 | Server error: please contact support |

