{ "openapi": "3.1.0", "info": { "title": "BusinessHRM API", "version": "v1", "description": "Welcome to the **BusinessHRM REST API**. Everything in your workspace — contacts, leads, projects, tasks, invoices, employees and more — is available over a clean, predictable HTTPS API.\n\n- **Base URL:** `https://app.businesshrm.com/api/v1`\n- **Format:** JSON for every request and response (`Content-Type: application/json`).\n- **Auth:** a single API key sent as a Bearer token (see below).\n- **MCP endpoint (AI assistants):** `https://app.businesshrm.com/mcp` — connect Claude, Cursor, etc. with your API key. See **Model Context Protocol (MCP)** at the end of this guide.\n\n---\n\n## 1. Authentication\n\nThe API uses **API keys** (bearer tokens). You create a key once in the app and send it on every request.\n\n**Create a key:** go to **Settings → API Keys → Create API Key**, choose either *Full access* or specific permissions, and copy the key. You only see it once, so store it safely.\n\n**Send it** in the `Authorization` header on every request:\n\n```\nAuthorization: Bearer YOUR_API_KEY\n```\n\nThat's it — no OAuth dance, no refresh tokens. A key keeps working until you revoke or rotate it.\n\n> **Permissions:** a key is limited to the resources you ticked when creating it (e.g. a key with only the *Contacts* permission can call `/contact*` but not `/invoice`). A *Full access* key can call everything. Granting a parent permission (e.g. *Contacts*) also covers its sub-resources (`contact-category`, `contact-sub-category`).\n\n---\n\n## 2. Quick start\n\nCopy, paste your key, and run — this lists your contacts:\n\n```bash\ncurl https://app.businesshrm.com/api/v1/contact \\\n -H \"Authorization: Bearer YOUR_API_KEY\" \\\n -H \"Accept: application/json\"\n```\n\nCreate a contact:\n\n```bash\ncurl -X POST https://app.businesshrm.com/api/v1/contact \\\n -H \"Authorization: Bearer YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"Acme Corporation\",\n \"email\": \"buyer@acme.com\",\n \"contact_detail\": { \"company_name\": \"Acme Corporation\", \"city\": \"Lahore\", \"contact_type\": \"customer\" }\n }'\n```\n\n---\n\n## 3. Response shape\n\n**A single record** comes back as:\n\n```json\n{\n \"message\": \"Resource created successfully\",\n \"data\": { \"id\": 576 },\n \"meta\": { \"time\": 0.07 }\n}\n```\n\n**A list** comes back as a `data` array plus paging info in `meta`:\n\n```json\n{\n \"data\": [ { \"id\": 148, \"name\": \"Osvaldo Conn\", \"email\": \"osvaldo@acme.com\" } ],\n \"meta\": {\n \"paging\": { \"total\": 104, \"links\": { \"next\": \"https://app.businesshrm.com/api/v1/contact?offset=20\" } },\n \"time\": 0.02\n }\n}\n```\n\n---\n\n## 4. Pagination\n\nUse `limit` (how many) and `offset` (where to start). `meta.paging.total` is the full count and `meta.paging.links.next` is the ready-to-call next page.\n\n```bash\n# second page of 20\ncurl \"https://app.businesshrm.com/api/v1/contact?limit=20&offset=20\" -H \"Authorization: Bearer YOUR_API_KEY\"\n```\n\nDefault page size is 20; the maximum is 1000.\n\n---\n\n## 5. Choosing fields\n\nBy default each endpoint returns a sensible set of fields. Ask for exactly the ones you want with `fields` (comma-separated) to get smaller, faster responses:\n\n```bash\ncurl \"https://app.businesshrm.com/api/v1/contact?fields=id,name,email\" -H \"Authorization: Bearer YOUR_API_KEY\"\n```\n\n---\n\n## 6. Sorting\n\nUse `order` with a column name. Prefix with `-` for descending:\n\n```bash\ncurl \"https://app.businesshrm.com/api/v1/contact?order=-id\" -H \"Authorization: Bearer YOUR_API_KEY\"\n```\n\n---\n\n## 7. Filtering & Search\n\nFiltering uses one `filters` parameter. The shape is always:\n\n```\nfilters=(field operator value)\n```\n\nCombine conditions with `and` / `or`. **You can copy any example below and just change the values.**\n\n| You want… | Use this filter |\n|---|---|\n| Status is exactly *active* | `filters=(status eq \"active\")` |\n| Name contains *jan* (search) | `filters=(name lk \"%jan%\")` |\n| Email is a specific address | `filters=(email eq \"buyer@acme.com\")` |\n| Two conditions (both true) | `filters=((status eq \"active\") and (name lk \"%acme%\"))` |\n| Either condition | `filters=((status eq \"active\") or (status eq \"pending\"))` |\n\n**Operators:** `eq` equals · `ne` not equals · `gt` greater than · `ge` greater-or-equal · `lt` less than · `le` less-or-equal · `lk` like/contains (use `%` as the wildcard).\n\n**Full, ready-to-run example** — active contacts whose name contains \"acme\":\n\n```bash\ncurl -G \"https://app.businesshrm.com/api/v1/contact\" \\\n -H \"Authorization: Bearer YOUR_API_KEY\" \\\n --data-urlencode 'filters=((status eq \"active\") and (name lk \"%acme%\"))'\n```\n\n> Tip: when testing in a browser/Postman, remember to URL-encode the filter (spaces become `%20`, `\"` becomes `%22`). The `curl -G --data-urlencode` form above does this for you.\n\nYou can only filter on fields a resource marks as filterable — each endpoint lists them.\n\n---\n\n## 8. Errors\n\nErrors return the right HTTP status and a JSON body:\n\n```json\n{ \"message\": \"The email field is required.\", \"error\": { \"message\": \"The email field is required.\", \"code\": 422 } }\n```\n\n| Status | Meaning |\n|---|---|\n| 400 | Bad request / not allowed for this key |\n| 401 | Missing or invalid API key |\n| 403 | Authenticated, but not permitted |\n| 404 | Resource not found |\n| 422 | Validation failed (check `message`) |\n| 500 | Something went wrong on our side |\n\n---\n\n## 9. Working with Contact tags\n\nContact tags are always referenced by **name** (never by id). When you send a name that doesn't exist yet, it is **created automatically** — so you never manage tag ids.\n\nThere are two different ways to set tags, and they behave differently:\n\n| What you call | What happens to existing tags |\n|---|---|\n| `contact_tags` on **Create / Update / Upsert** | **Replaces the whole list.** Only the tags you send remain; any others on the contact are removed. |\n| `POST /contact/{id}/tags` | **Adds** the given tags and keeps the existing ones. |\n| `DELETE /contact/{id}/tags` | **Removes** only the named tags (the tag itself is not deleted, just detached). |\n\n**Example:** a contact already has `[\"A\", \"B\", \"C\", \"D\", \"E\"]`.\n\n- Send `\"contact_tags\": [\"VIP\", \"Newsletter\"]` on **update** → the contact ends up with **only** `[\"VIP\", \"Newsletter\"]` (A–E are removed).\n- Call **POST** `/contact/{id}/tags` with `{ \"tags\": [\"VIP\", \"Newsletter\"] }` → the contact ends up with `[\"A\",\"B\",\"C\",\"D\",\"E\",\"VIP\",\"Newsletter\"]`.\n- Call **DELETE** `/contact/{id}/tags` with `{ \"tags\": [\"A\"] }` → the contact ends up with `[\"B\",\"C\",\"D\",\"E\"]`.\n\nSo: use `contact_tags` when you want to set the **complete** tag list; use the add/remove endpoints when you want to change **individual** tags without resending everything.\n\n---\n\nPick a resource on the left to see every endpoint, every field, and a copy-paste example you can run immediately. Use the **Test Request** button to call the API right from this page.\n\n---\n\n## Model Context Protocol (MCP)\n\nUse BusinessHRM directly from AI assistants (Claude Desktop, Claude.ai, Cursor, Claude Code, …). Every REST endpoint on this page is exposed as an MCP **tool**, so an assistant can read and write your workspace on your behalf — always limited to your own account and permissions.\n\n### Endpoint\n\n```\nhttps://.businesshrm.com/mcp\n```\n\nUse your workspace's own address — the same subdomain you sign in to. **Transport:** Streamable HTTP.\n\n### Connecting — one‑click sign‑in (recommended)\n\nThe endpoint is a standards‑compliant **OAuth 2.1** server (PKCE + Dynamic Client Registration), so most clients connect with **just the URL** — no API key to copy or paste. When you add the connector the client opens a BusinessHRM sign‑in + approval screen; after you click **Allow**, you're connected.\n\n**Claude Desktop / Claude.ai** — Settings → **Connectors** → **Add custom connector**, paste your endpoint:\n\n```\nhttps://.businesshrm.com/mcp\n```\n\nConnect, sign in to BusinessHRM, and approve. (Tokens refresh automatically; you won't be asked again unless you disconnect.)\n\n**Cursor, Claude Code, and other OAuth‑capable clients** — point them at the same URL; they run the same sign‑in flow.\n\n### Connecting — API key header (alternative)\n\nClients that let you set a request header can skip the sign‑in and authenticate with an API key (*Settings → API Keys*):\n\n- **Claude Code (CLI):**\n ```bash\n claude mcp add --transport http businesshrm https://.businesshrm.com/mcp \\\n --header \"Authorization: Bearer YOUR_API_KEY\"\n ```\n- **Cursor (JSON):**\n ```json\n { \"mcpServers\": { \"businesshrm\": {\n \"url\": \"https://.businesshrm.com/mcp\",\n \"headers\": { \"Authorization\": \"Bearer YOUR_API_KEY\" } } } }\n ```\n\nEither way, the assistant can only do what your account is permitted to do.\n\n### Tools\n\nEach endpoint becomes one tool (e.g. `get_contact`, `post_invoice`). A tool's input is an object with required **path parameters** at the top level (e.g. an `id`), an optional **`query`** object (`limit`, `offset`, `fields`, `order`, `filters`), and an optional **`body`** object for `POST`/`PUT`. Two helpers are always available: `businesshrm_list_endpoints` (discover endpoints) and `businesshrm_request` (call any endpoint by method + path).\n\n### Troubleshooting\n\n- **401 / \"missing API key\"** — the `Authorization: Bearer` header isn't being sent, or the key was revoked.\n- **403 / not permitted** — your key lacks that resource's permission; create a *Full access* key or tick the needed resources.\n- **Tool doesn't appear** — fully restart the client after editing its config.\n\n> The tool list is generated live from this OpenAPI document, so the MCP server always matches the current API.\n\n\n\n---\n\n## Reference data\n\nValues you can pass for the `country_id`, `country_phonecode`, `locale` and `timezone` fields.\n\n### Locales — `locale`\n\nPass the **Code**.\n\n| Code | Language | Status |\n|---|---|---|\n| `sq` | Albanian | disabled |\n| `ar` | Arabic | disabled |\n| `bg` | Bulgarian | disabled |\n| `zh-CN` | Chinese (S) | disabled |\n| `zh-TW` | Chinese (T) | disabled |\n| `nl` | Dutch | disabled |\n| `en` | English | enabled |\n| `et` | Estonian | disabled |\n| `fa` | Farsi | disabled |\n| `fr` | French | disabled |\n| `ka` | Georgian | disabled |\n| `de` | German | disabled |\n| `el` | Greek | disabled |\n| `hi` | Hindi | disabled |\n| `id` | Indonesian | disabled |\n| `it` | Italian | disabled |\n| `ja` | Japanese | disabled |\n| `ko` | korean | disabled |\n| `pl` | Polish | disabled |\n| `pt` | Portuguese | disabled |\n| `pt-br` | Portuguese (Brazil) | disabled |\n| `ro` | Romanian | disabled |\n| `ru` | Russian | disabled |\n| `sr` | Serbian | disabled |\n| `es` | Spanish | disabled |\n| `th` | Thai | disabled |\n| `tr` | Turkish | disabled |\n| `vi` | Vietnamese | disabled |\n\n### Timezones — `timezone`\n\n
\n419 timezones — click to expand\n\n`Africa/Abidjan`, `Africa/Accra`, `Africa/Addis_Ababa`, `Africa/Algiers`, `Africa/Asmara`, `Africa/Bamako`, `Africa/Bangui`, `Africa/Banjul`, `Africa/Bissau`, `Africa/Blantyre`, `Africa/Brazzaville`, `Africa/Bujumbura`, `Africa/Cairo`, `Africa/Casablanca`, `Africa/Ceuta`, `Africa/Conakry`, `Africa/Dakar`, `Africa/Dar_es_Salaam`, `Africa/Djibouti`, `Africa/Douala`, `Africa/El_Aaiun`, `Africa/Freetown`, `Africa/Gaborone`, `Africa/Harare`, `Africa/Johannesburg`, `Africa/Juba`, `Africa/Kampala`, `Africa/Khartoum`, `Africa/Kigali`, `Africa/Kinshasa`, `Africa/Lagos`, `Africa/Libreville`, `Africa/Lome`, `Africa/Luanda`, `Africa/Lubumbashi`, `Africa/Lusaka`, `Africa/Malabo`, `Africa/Maputo`, `Africa/Maseru`, `Africa/Mbabane`, `Africa/Mogadishu`, `Africa/Monrovia`, `Africa/Nairobi`, `Africa/Ndjamena`, `Africa/Niamey`, `Africa/Nouakchott`, `Africa/Ouagadougou`, `Africa/Porto-Novo`, `Africa/Sao_Tome`, `Africa/Tripoli`, `Africa/Tunis`, `Africa/Windhoek`, `America/Adak`, `America/Anchorage`, `America/Anguilla`, `America/Antigua`, `America/Araguaina`, `America/Argentina/Buenos_Aires`, `America/Argentina/Catamarca`, `America/Argentina/Cordoba`, `America/Argentina/Jujuy`, `America/Argentina/La_Rioja`, `America/Argentina/Mendoza`, `America/Argentina/Rio_Gallegos`, `America/Argentina/Salta`, `America/Argentina/San_Juan`, `America/Argentina/San_Luis`, `America/Argentina/Tucuman`, `America/Argentina/Ushuaia`, `America/Aruba`, `America/Asuncion`, `America/Atikokan`, `America/Bahia`, `America/Bahia_Banderas`, `America/Barbados`, `America/Belem`, `America/Belize`, `America/Blanc-Sablon`, `America/Boa_Vista`, `America/Bogota`, `America/Boise`, `America/Cambridge_Bay`, `America/Campo_Grande`, `America/Cancun`, `America/Caracas`, `America/Cayenne`, `America/Cayman`, `America/Chicago`, `America/Chihuahua`, `America/Ciudad_Juarez`, `America/Costa_Rica`, `America/Coyhaique`, `America/Creston`, `America/Cuiaba`, `America/Curacao`, `America/Danmarkshavn`, `America/Dawson`, `America/Dawson_Creek`, `America/Denver`, `America/Detroit`, `America/Dominica`, `America/Edmonton`, `America/Eirunepe`, `America/El_Salvador`, `America/Fort_Nelson`, `America/Fortaleza`, `America/Glace_Bay`, `America/Goose_Bay`, `America/Grand_Turk`, `America/Grenada`, `America/Guadeloupe`, `America/Guatemala`, `America/Guayaquil`, `America/Guyana`, `America/Halifax`, `America/Havana`, `America/Hermosillo`, `America/Indiana/Indianapolis`, `America/Indiana/Knox`, `America/Indiana/Marengo`, `America/Indiana/Petersburg`, `America/Indiana/Tell_City`, `America/Indiana/Vevay`, `America/Indiana/Vincennes`, `America/Indiana/Winamac`, `America/Inuvik`, `America/Iqaluit`, `America/Jamaica`, `America/Juneau`, `America/Kentucky/Louisville`, `America/Kentucky/Monticello`, `America/Kralendijk`, `America/La_Paz`, `America/Lima`, `America/Los_Angeles`, `America/Lower_Princes`, `America/Maceio`, `America/Managua`, `America/Manaus`, `America/Marigot`, `America/Martinique`, `America/Matamoros`, `America/Mazatlan`, `America/Menominee`, `America/Merida`, `America/Metlakatla`, `America/Mexico_City`, `America/Miquelon`, `America/Moncton`, `America/Monterrey`, `America/Montevideo`, `America/Montserrat`, `America/Nassau`, `America/New_York`, `America/Nome`, `America/Noronha`, `America/North_Dakota/Beulah`, `America/North_Dakota/Center`, `America/North_Dakota/New_Salem`, `America/Nuuk`, `America/Ojinaga`, `America/Panama`, `America/Paramaribo`, `America/Phoenix`, `America/Port-au-Prince`, `America/Port_of_Spain`, `America/Porto_Velho`, `America/Puerto_Rico`, `America/Punta_Arenas`, `America/Rankin_Inlet`, `America/Recife`, `America/Regina`, `America/Resolute`, `America/Rio_Branco`, `America/Santarem`, `America/Santiago`, `America/Santo_Domingo`, `America/Sao_Paulo`, `America/Scoresbysund`, `America/Sitka`, `America/St_Barthelemy`, `America/St_Johns`, `America/St_Kitts`, `America/St_Lucia`, `America/St_Thomas`, `America/St_Vincent`, `America/Swift_Current`, `America/Tegucigalpa`, `America/Thule`, `America/Tijuana`, `America/Toronto`, `America/Tortola`, `America/Vancouver`, `America/Whitehorse`, `America/Winnipeg`, `America/Yakutat`, `Antarctica/Casey`, `Antarctica/Davis`, `Antarctica/DumontDUrville`, `Antarctica/Macquarie`, `Antarctica/Mawson`, `Antarctica/McMurdo`, `Antarctica/Palmer`, `Antarctica/Rothera`, `Antarctica/Syowa`, `Antarctica/Troll`, `Antarctica/Vostok`, `Arctic/Longyearbyen`, `Asia/Aden`, `Asia/Almaty`, `Asia/Amman`, `Asia/Anadyr`, `Asia/Aqtau`, `Asia/Aqtobe`, `Asia/Ashgabat`, `Asia/Atyrau`, `Asia/Baghdad`, `Asia/Bahrain`, `Asia/Baku`, `Asia/Bangkok`, `Asia/Barnaul`, `Asia/Beirut`, `Asia/Bishkek`, `Asia/Brunei`, `Asia/Chita`, `Asia/Colombo`, `Asia/Damascus`, `Asia/Dhaka`, `Asia/Dili`, `Asia/Dubai`, `Asia/Dushanbe`, `Asia/Famagusta`, `Asia/Gaza`, `Asia/Hebron`, `Asia/Ho_Chi_Minh`, `Asia/Hong_Kong`, `Asia/Hovd`, `Asia/Irkutsk`, `Asia/Jakarta`, `Asia/Jayapura`, `Asia/Jerusalem`, `Asia/Kabul`, `Asia/Kamchatka`, `Asia/Karachi`, `Asia/Kathmandu`, `Asia/Khandyga`, `Asia/Kolkata`, `Asia/Krasnoyarsk`, `Asia/Kuala_Lumpur`, `Asia/Kuching`, `Asia/Kuwait`, `Asia/Macau`, `Asia/Magadan`, `Asia/Makassar`, `Asia/Manila`, `Asia/Muscat`, `Asia/Nicosia`, `Asia/Novokuznetsk`, `Asia/Novosibirsk`, `Asia/Omsk`, `Asia/Oral`, `Asia/Phnom_Penh`, `Asia/Pontianak`, `Asia/Pyongyang`, `Asia/Qatar`, `Asia/Qostanay`, `Asia/Qyzylorda`, `Asia/Riyadh`, `Asia/Sakhalin`, `Asia/Samarkand`, `Asia/Seoul`, `Asia/Shanghai`, `Asia/Singapore`, `Asia/Srednekolymsk`, `Asia/Taipei`, `Asia/Tashkent`, `Asia/Tbilisi`, `Asia/Tehran`, `Asia/Thimphu`, `Asia/Tokyo`, `Asia/Tomsk`, `Asia/Ulaanbaatar`, `Asia/Urumqi`, `Asia/Ust-Nera`, `Asia/Vientiane`, `Asia/Vladivostok`, `Asia/Yakutsk`, `Asia/Yangon`, `Asia/Yekaterinburg`, `Asia/Yerevan`, `Atlantic/Azores`, `Atlantic/Bermuda`, `Atlantic/Canary`, `Atlantic/Cape_Verde`, `Atlantic/Faroe`, `Atlantic/Madeira`, `Atlantic/Reykjavik`, `Atlantic/South_Georgia`, `Atlantic/St_Helena`, `Atlantic/Stanley`, `Australia/Adelaide`, `Australia/Brisbane`, `Australia/Broken_Hill`, `Australia/Darwin`, `Australia/Eucla`, `Australia/Hobart`, `Australia/Lindeman`, `Australia/Lord_Howe`, `Australia/Melbourne`, `Australia/Perth`, `Australia/Sydney`, `Europe/Amsterdam`, `Europe/Andorra`, `Europe/Astrakhan`, `Europe/Athens`, `Europe/Belgrade`, `Europe/Berlin`, `Europe/Bratislava`, `Europe/Brussels`, `Europe/Bucharest`, `Europe/Budapest`, `Europe/Busingen`, `Europe/Chisinau`, `Europe/Copenhagen`, `Europe/Dublin`, `Europe/Gibraltar`, `Europe/Guernsey`, `Europe/Helsinki`, `Europe/Isle_of_Man`, `Europe/Istanbul`, `Europe/Jersey`, `Europe/Kaliningrad`, `Europe/Kirov`, `Europe/Kyiv`, `Europe/Lisbon`, `Europe/Ljubljana`, `Europe/London`, `Europe/Luxembourg`, `Europe/Madrid`, `Europe/Malta`, `Europe/Mariehamn`, `Europe/Minsk`, `Europe/Monaco`, `Europe/Moscow`, `Europe/Oslo`, `Europe/Paris`, `Europe/Podgorica`, `Europe/Prague`, `Europe/Riga`, `Europe/Rome`, `Europe/Samara`, `Europe/San_Marino`, `Europe/Sarajevo`, `Europe/Saratov`, `Europe/Simferopol`, `Europe/Skopje`, `Europe/Sofia`, `Europe/Stockholm`, `Europe/Tallinn`, `Europe/Tirane`, `Europe/Ulyanovsk`, `Europe/Vaduz`, `Europe/Vatican`, `Europe/Vienna`, `Europe/Vilnius`, `Europe/Volgograd`, `Europe/Warsaw`, `Europe/Zagreb`, `Europe/Zurich`, `Indian/Antananarivo`, `Indian/Chagos`, `Indian/Christmas`, `Indian/Cocos`, `Indian/Comoro`, `Indian/Kerguelen`, `Indian/Mahe`, `Indian/Maldives`, `Indian/Mauritius`, `Indian/Mayotte`, `Indian/Reunion`, `Pacific/Apia`, `Pacific/Auckland`, `Pacific/Bougainville`, `Pacific/Chatham`, `Pacific/Chuuk`, `Pacific/Easter`, `Pacific/Efate`, `Pacific/Fakaofo`, `Pacific/Fiji`, `Pacific/Funafuti`, `Pacific/Galapagos`, `Pacific/Gambier`, `Pacific/Guadalcanal`, `Pacific/Guam`, `Pacific/Honolulu`, `Pacific/Kanton`, `Pacific/Kiritimati`, `Pacific/Kosrae`, `Pacific/Kwajalein`, `Pacific/Majuro`, `Pacific/Marquesas`, `Pacific/Midway`, `Pacific/Nauru`, `Pacific/Niue`, `Pacific/Norfolk`, `Pacific/Noumea`, `Pacific/Pago_Pago`, `Pacific/Palau`, `Pacific/Pitcairn`, `Pacific/Pohnpei`, `Pacific/Port_Moresby`, `Pacific/Rarotonga`, `Pacific/Saipan`, `Pacific/Tahiti`, `Pacific/Tarawa`, `Pacific/Tongatapu`, `Pacific/Wake`, `Pacific/Wallis`, `UTC`\n\n
\n\n### Countries — `country_id` & `country_phonecode`\n\nPass **country_id** for the country field, and **phonecode** for `country_phonecode`.\n\n
\n253 countries — click to expand\n\n| country_id | Country | phonecode |\n|---|---|---|\n| 1 | Afghanistan | 93 |\n| 243 | Aland Islands | 358 |\n| 2 | Albania | 355 |\n| 3 | Algeria | 213 |\n| 4 | American Samoa | 1684 |\n| 5 | Andorra | 376 |\n| 6 | Angola | 244 |\n| 7 | Anguilla | 1264 |\n| 8 | Antarctica | 0 |\n| 9 | Antigua and Barbuda | 1268 |\n| 10 | Argentina | 54 |\n| 11 | Armenia | 374 |\n| 12 | Aruba | 297 |\n| 241 | Asia / Pacific Region | 0 |\n| 13 | Australia | 61 |\n| 14 | Austria | 43 |\n| 15 | Azerbaijan | 994 |\n| 16 | Bahamas | 1242 |\n| 17 | Bahrain | 973 |\n| 18 | Bangladesh | 880 |\n| 19 | Barbados | 1246 |\n| 20 | Belarus | 375 |\n| 21 | Belgium | 32 |\n| 22 | Belize | 501 |\n| 23 | Benin | 229 |\n| 24 | Bermuda | 1441 |\n| 25 | Bhutan | 975 |\n| 26 | Bolivia | 591 |\n| 244 | Bonaire, Sint Eustatius and Saba | 599 |\n| 27 | Bosnia and Herzegovina | 387 |\n| 28 | Botswana | 267 |\n| 29 | Bouvet Island | 0 |\n| 30 | Brazil | 55 |\n| 31 | British Indian Ocean Territory | 246 |\n| 32 | Brunei Darussalam | 673 |\n| 33 | Bulgaria | 359 |\n| 34 | Burkina Faso | 226 |\n| 35 | Burundi | 257 |\n| 36 | Cambodia | 855 |\n| 37 | Cameroon | 237 |\n| 38 | Canada | 1 |\n| 39 | Cape Verde | 238 |\n| 40 | Cayman Islands | 1345 |\n| 41 | Central African Republic | 236 |\n| 42 | Chad | 235 |\n| 43 | Chile | 56 |\n| 44 | China | 86 |\n| 45 | Christmas Island | 61 |\n| 46 | Cocos (Keeling) Islands | 672 |\n| 47 | Colombia | 57 |\n| 48 | Comoros | 269 |\n| 49 | Congo | 242 |\n| 50 | Congo, the Democratic Republic of the | 242 |\n| 51 | Cook Islands | 682 |\n| 52 | Costa Rica | 506 |\n| 53 | Cote D'Ivoire | 225 |\n| 54 | Croatia | 385 |\n| 55 | Cuba | 53 |\n| 245 | Curacao | 599 |\n| 56 | Cyprus | 357 |\n| 57 | Czech Republic | 420 |\n| 58 | Denmark | 45 |\n| 59 | Djibouti | 253 |\n| 60 | Dominica | 1767 |\n| 61 | Dominican Republic | 1809 |\n| 62 | Ecuador | 593 |\n| 63 | Egypt | 20 |\n| 64 | El Salvador | 503 |\n| 65 | Equatorial Guinea | 240 |\n| 66 | Eritrea | 291 |\n| 67 | Estonia | 372 |\n| 68 | Ethiopia | 251 |\n| 69 | Falkland Islands (Malvinas) | 500 |\n| 70 | Faroe Islands | 298 |\n| 71 | Fiji | 679 |\n| 72 | Finland | 358 |\n| 73 | France | 33 |\n| 74 | French Guiana | 594 |\n| 75 | French Polynesia | 689 |\n| 76 | French Southern Territories | 0 |\n| 77 | Gabon | 241 |\n| 78 | Gambia | 220 |\n| 79 | Georgia | 995 |\n| 80 | Germany | 49 |\n| 81 | Ghana | 233 |\n| 82 | Gibraltar | 350 |\n| 83 | Greece | 30 |\n| 84 | Greenland | 299 |\n| 85 | Grenada | 1473 |\n| 86 | Guadeloupe | 590 |\n| 87 | Guam | 1671 |\n| 88 | Guatemala | 502 |\n| 246 | Guernsey | 44 |\n| 89 | Guinea | 224 |\n| 90 | Guinea-Bissau | 245 |\n| 91 | Guyana | 592 |\n| 92 | Haiti | 509 |\n| 93 | Heard Island and Mcdonald Islands | 0 |\n| 94 | Holy See (Vatican City State) | 39 |\n| 95 | Honduras | 504 |\n| 96 | Hong Kong | 852 |\n| 97 | Hungary | 36 |\n| 98 | Iceland | 354 |\n| 99 | India | 91 |\n| 100 | Indonesia | 62 |\n| 101 | Iran, Islamic Republic of | 98 |\n| 102 | Iraq | 964 |\n| 103 | Ireland | 353 |\n| 247 | Isle of Man | 44 |\n| 104 | Israel | 972 |\n| 105 | Italy | 39 |\n| 106 | Jamaica | 1876 |\n| 107 | Japan | 81 |\n| 248 | Jersey | 44 |\n| 108 | Jordan | 962 |\n| 109 | Kazakhstan | 7 |\n| 110 | Kenya | 254 |\n| 111 | Kiribati | 686 |\n| 112 | Korea, Democratic People's Republic of | 850 |\n| 113 | Korea, Republic of | 82 |\n| 249 | Kosovo | 381 |\n| 114 | Kuwait | 965 |\n| 115 | Kyrgyzstan | 996 |\n| 116 | Lao People's Democratic Republic | 856 |\n| 117 | Latvia | 371 |\n| 118 | Lebanon | 961 |\n| 119 | Lesotho | 266 |\n| 120 | Liberia | 231 |\n| 121 | Libyan Arab Jamahiriya | 218 |\n| 122 | Liechtenstein | 423 |\n| 123 | Lithuania | 370 |\n| 124 | Luxembourg | 352 |\n| 125 | Macao | 853 |\n| 126 | Macedonia, the Former Yugoslav Republic of | 389 |\n| 127 | Madagascar | 261 |\n| 128 | Malawi | 265 |\n| 129 | Malaysia | 60 |\n| 130 | Maldives | 960 |\n| 131 | Mali | 223 |\n| 132 | Malta | 356 |\n| 133 | Marshall Islands | 692 |\n| 134 | Martinique | 596 |\n| 135 | Mauritania | 222 |\n| 136 | Mauritius | 230 |\n| 137 | Mayotte | 269 |\n| 138 | Mexico | 52 |\n| 139 | Micronesia, Federated States of | 691 |\n| 140 | Moldova, Republic of | 373 |\n| 141 | Monaco | 377 |\n| 142 | Mongolia | 976 |\n| 242 | Montenegro | 382 |\n| 143 | Montserrat | 1664 |\n| 144 | Morocco | 212 |\n| 145 | Mozambique | 258 |\n| 146 | Myanmar | 95 |\n| 147 | Namibia | 264 |\n| 148 | Nauru | 674 |\n| 149 | Nepal | 977 |\n| 150 | Netherlands | 31 |\n| 151 | Netherlands Antilles | 599 |\n| 152 | New Caledonia | 687 |\n| 153 | New Zealand | 64 |\n| 154 | Nicaragua | 505 |\n| 155 | Niger | 227 |\n| 156 | Nigeria | 234 |\n| 157 | Niue | 683 |\n| 158 | Norfolk Island | 672 |\n| 159 | Northern Mariana Islands | 1670 |\n| 160 | Norway | 47 |\n| 161 | Oman | 968 |\n| 162 | Pakistan | 92 |\n| 163 | Palau | 680 |\n| 164 | Palestinian Territory, Occupied | 970 |\n| 165 | Panama | 507 |\n| 166 | Papua New Guinea | 675 |\n| 167 | Paraguay | 595 |\n| 168 | Peru | 51 |\n| 169 | Philippines | 63 |\n| 170 | Pitcairn | 0 |\n| 171 | Poland | 48 |\n| 172 | Portugal | 351 |\n| 173 | Puerto Rico | 1787 |\n| 174 | Qatar | 974 |\n| 175 | Reunion | 262 |\n| 176 | Romania | 40 |\n| 177 | Russian Federation | 7 |\n| 178 | Rwanda | 250 |\n| 250 | Saint Barthelemy | 590 |\n| 179 | Saint Helena | 290 |\n| 180 | Saint Kitts and Nevis | 1869 |\n| 181 | Saint Lucia | 1758 |\n| 251 | Saint Martin | 590 |\n| 182 | Saint Pierre and Miquelon | 508 |\n| 183 | Saint Vincent and the Grenadines | 1784 |\n| 184 | Samoa | 684 |\n| 185 | San Marino | 378 |\n| 186 | Sao Tome and Principe | 239 |\n| 187 | Saudi Arabia | 966 |\n| 188 | Senegal | 221 |\n| 240 | Serbia | 381 |\n| 189 | Serbia and Montenegro | 381 |\n| 190 | Seychelles | 248 |\n| 191 | Sierra Leone | 232 |\n| 192 | Singapore | 65 |\n| 252 | Sint Maarten | 1 |\n| 193 | Slovakia | 421 |\n| 194 | Slovenia | 386 |\n| 195 | Solomon Islands | 677 |\n| 196 | Somalia | 252 |\n| 197 | South Africa | 27 |\n| 198 | South Georgia and the South Sandwich Islands | 0 |\n| 253 | South Sudan | 211 |\n| 199 | Spain | 34 |\n| 200 | Sri Lanka | 94 |\n| 201 | Sudan | 249 |\n| 202 | Suriname | 597 |\n| 203 | Svalbard and Jan Mayen | 47 |\n| 204 | Swaziland | 268 |\n| 205 | Sweden | 46 |\n| 206 | Switzerland | 41 |\n| 207 | Syrian Arab Republic | 963 |\n| 208 | Taiwan, Province of China | 886 |\n| 209 | Tajikistan | 992 |\n| 210 | Tanzania, United Republic of | 255 |\n| 211 | Thailand | 66 |\n| 212 | Timor-Leste | 670 |\n| 213 | Togo | 228 |\n| 214 | Tokelau | 690 |\n| 215 | Tonga | 676 |\n| 216 | Trinidad and Tobago | 1868 |\n| 217 | Tunisia | 216 |\n| 218 | Turkey | 90 |\n| 219 | Turkmenistan | 7370 |\n| 220 | Turks and Caicos Islands | 1649 |\n| 221 | Tuvalu | 688 |\n| 222 | Uganda | 256 |\n| 223 | Ukraine | 380 |\n| 224 | United Arab Emirates | 971 |\n| 225 | United Kingdom | 44 |\n| 226 | United States | 1 |\n| 227 | United States Minor Outlying Islands | 1 |\n| 228 | Uruguay | 598 |\n| 229 | Uzbekistan | 998 |\n| 230 | Vanuatu | 678 |\n| 231 | Venezuela | 58 |\n| 232 | Viet Nam | 84 |\n| 233 | Virgin Islands, British | 1284 |\n| 234 | Virgin Islands, U.s. | 1340 |\n| 235 | Wallis and Futuna | 681 |\n| 236 | Western Sahara | 212 |\n| 237 | Yemen | 967 |\n| 238 | Zambia | 260 |\n| 239 | Zimbabwe | 263 |\n\n
\n" }, "servers": [ { "url": "https://app.businesshrm.com/api/v1" } ], "security": [ { "bearerAuth": [] } ], "tags": [ { "name": "Attendance", "description": "Clock-in / clock-out records." }, { "name": "Break Logs", "description": "Manage break logs." }, { "name": "Break Types", "description": "Manage break types." }, { "name": "Task Comments", "description": "Manage task comments." }, { "name": "Company", "description": "" }, { "name": "Contacts", "description": "People and companies you do business with. Supports create, read, update, delete, list and **upsert** (create-or-update by email)." }, { "name": "Contact Categories", "description": "Manage contact categories." }, { "name": "Contact Sub-categories", "description": "Manage contact sub-categories." }, { "name": "Contracts", "description": "Manage contracts." }, { "name": "Contract Types", "description": "Manage contract types." }, { "name": "Currencies", "description": "Manage currencies." }, { "name": "Dashboard", "description": "" }, { "name": "Deals", "description": "CRM deals in your sales pipeline. Supports create, read, update, delete and list. A new deal defaults to your first pipeline/stage unless you pass lead_pipeline_id and pipeline_stage_id." }, { "name": "Departments", "description": "Manage departments." }, { "name": "Designations", "description": "Manage designations." }, { "name": "Employees", "description": "Your team members." }, { "name": "Estimates", "description": "Quotes/proposals issued to contacts." }, { "name": "Events", "description": "Manage events." }, { "name": "Expenses", "description": "Money your company spends." }, { "name": "Files", "description": "Manage files." }, { "name": "Holidays", "description": "Manage holidays." }, { "name": "Invoices", "description": "Bills issued to contacts." }, { "name": "Leaves", "description": "Time-off requests." }, { "name": "Leave Types", "description": "Manage leave types." }, { "name": "Loans", "description": "Employee loans — read-only. List and fetch loans with their approved amount, monthly installment, total payable, total paid and outstanding balance. Loans are created and approved through the in-app workflow, not the API. Filter by `user_id`, `status`, `loan_type_id`, etc. Add `?fields=repayments` to include the full repayment schedule." }, { "name": "Loan Repayments", "description": "Repayment schedule rows for loans — read-only. Each row is one installment with its due month, scheduled amount, paid amount and status (scheduled / deducted / paid / waived). Filter by `loan_id` to pull a single loan's schedule and see what is paid vs remaining." }, { "name": "Loan Types", "description": "Loan products (amount limits, repayment months, interest) — read-only reference data." }, { "name": "Task Notes", "description": "Manage task notes." }, { "name": "Notice Board", "description": "Manage notice board." }, { "name": "Payroll", "description": "Employee salary/payroll records. Supports create, read, update, delete and list." }, { "name": "Products", "description": "Products and services you sell." }, { "name": "Projects", "description": "Client and internal projects." }, { "name": "Project Categories", "description": "Manage project categories." }, { "name": "Sub-tasks", "description": "Manage sub-tasks." }, { "name": "Tasks", "description": "Work items, optionally attached to a project." }, { "name": "Task Categories", "description": "Manage task categories." }, { "name": "Task Boards", "description": "Manage task boards." }, { "name": "Taxes", "description": "Manage taxes." }, { "name": "Tickets", "description": "Support tickets." }, { "name": "Ticket Channels", "description": "Manage ticket channels." }, { "name": "Ticket Groups", "description": "Manage ticket groups." }, { "name": "Ticket Replies", "description": "Manage ticket replies." }, { "name": "Ticket Types", "description": "Manage ticket types." }, { "name": "Timesheets", "description": "Manage timesheets." }, { "name": "Activity Tracker", "description": "Manage activity tracker." }, { "name": "Messages", "description": "Manage messages." }, { "name": "Webhooks", "description": "Webhook triggers. A trigger links an entity + event (e.g. Task / completed) to a destination URL. When the event happens in your workspace, BusinessHRM POSTs the record to that destination. **First create a destination in the app under Settings → Webhooks, then create triggers here** referencing that destination's id." } ], "x-tagGroups": [ { "name": "Sales (CRM)", "tags": [ "Contacts", "Contact Categories", "Contact Sub-categories", "Deals" ] }, { "name": "Work", "tags": [ "Projects", "Project Categories", "Tasks", "Task Categories", "Task Boards", "Sub-tasks", "Task Comments", "Task Notes", "Files", "Timesheets", "Contracts", "Contract Types" ] }, { "name": "Finance", "tags": [ "Invoices", "Estimates", "Expenses", "Products", "Taxes", "Currencies" ] }, { "name": "HR", "tags": [ "Employees", "Departments", "Designations", "Attendance", "Leaves", "Leave Types", "Holidays", "Payroll", "Loans", "Loan Repayments", "Loan Types" ] }, { "name": "Time Tracking", "tags": [ "Activity Tracker", "Break Logs", "Break Types" ] }, { "name": "Support", "tags": [ "Tickets", "Ticket Replies", "Ticket Groups", "Ticket Channels", "Ticket Types", "Notice Board", "Events" ] }, { "name": "Add-ons", "tags": [ "Webhooks", "Messages" ] }, { "name": "Account & General", "tags": [ "Company", "Dashboard" ] } ], "paths": { "/attendance/setting": { "get": { "tags": [ "Attendance" ], "summary": "Attendance Setting (Attendance)", "description": "Performs the \"Attendance Setting\" action on a attendance.", "operationId": "get_attendance_setting", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Attendance" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "user_id": 1, "clock_in_date": "string", "clock_in_time": "2026-01-31 09:00:00", "clock_out_time": "2026-01-31 09:00:00", "working_from": "string", "late": "yes", "half_day": "yes", "added_by": 10, "company_id": 1 }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/attendance/today": { "get": { "tags": [ "Attendance" ], "summary": "Today (Attendance)", "description": "Performs the \"Today\" action on a attendance.", "operationId": "get_attendance_today", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Attendance" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "user_id": 1, "clock_in_date": "string", "clock_in_time": "2026-01-31 09:00:00", "clock_out_time": "2026-01-31 09:00:00", "working_from": "string", "late": "yes", "half_day": "yes", "added_by": 10, "company_id": 1 }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/attendance/clock-in": { "post": { "tags": [ "Attendance" ], "summary": "Clock In (Attendance)", "description": "Performs the \"Clock In\" action on a attendance.", "operationId": "post_attendance_clock-in", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Attendance" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "user_id": 1, "clock_in_date": "string", "clock_in_time": "2026-01-31 09:00:00", "clock_out_time": "2026-01-31 09:00:00", "working_from": "string", "late": "yes", "half_day": "yes", "added_by": 10, "company_id": 1 }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/attendance/clock-out/{attendance}": { "post": { "tags": [ "Attendance" ], "summary": "Clock Out (Attendance)", "description": "Performs the \"Clock Out\" action on a attendance.", "operationId": "post_attendance_clock-out_attendance", "parameters": [ { "name": "attendance", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The attendance (usually the numeric id)." } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Attendance" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "user_id": 1, "clock_in_date": "string", "clock_in_time": "2026-01-31 09:00:00", "clock_out_time": "2026-01-31 09:00:00", "working_from": "string", "late": "yes", "half_day": "yes", "added_by": 10, "company_id": 1 }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/attendance": { "get": { "tags": [ "Attendance" ], "summary": "List Attendance", "description": "Returns a paginated list of Attendance in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_attendance", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,user_id,clock_in_date", "description": "Available fields: `id`, `user_id`, `clock_in_date`, `clock_in_time`, `clock_out_time`, `working_from`, `late`, `half_day`, `added_by`, `company_id`. Comma-separated subset of the above to return, e.g. `id,user_id,clock_in_date`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`, `user_id`, `added_by`, `clock_in_time`, `clock_out_time`, `late`, `half_day`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Attendance" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "user_id": 1, "clock_in_date": "string", "clock_in_time": "2026-01-31 09:00:00", "clock_out_time": "2026-01-31 09:00:00", "working_from": "string", "late": "yes", "half_day": "yes", "added_by": 10, "company_id": 1 } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "post": { "tags": [ "Attendance" ], "summary": "Create a Attendance", "description": "Creates a new attendance. Send the body fields below — required ones are marked; optional ones fall back to their defaults.", "operationId": "post_attendance", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "user_id": { "type": "integer", "description": "Employee whose attendance this is. Get ids via GET /employee." }, "clock_in_time": { "type": "string", "description": "Clock-in date & time, \"YYYY-MM-DD HH:MM:SS\"." }, "clock_out_time": { "type": "string", "description": "Clock-out date & time, \"YYYY-MM-DD HH:MM:SS\" (optional; leave blank if still clocked in)." }, "working_from": { "type": "string", "description": "Where the employee worked, e.g. \"office\" or \"home\"." }, "late": { "type": "string", "description": "Whether the clock-in was late.", "enum": [ "yes", "no" ] }, "half_day": { "type": "string", "description": "Whether this is a half-day.", "enum": [ "yes", "no" ] } }, "required": [ "user_id", "clock_in_time" ], "example": { "user_id": 1, "clock_in_time": "2026-06-01 09:00:00", "clock_out_time": "2026-06-01 17:00:00", "working_from": "office" } }, "example": { "user_id": 1, "clock_in_time": "2026-06-01 09:00:00", "clock_out_time": "2026-06-01 17:00:00", "working_from": "office" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Attendance" }, "meta": { "type": "object" } } }, "example": { "message": "Resource created successfully", "data": { "id": 1, "user_id": 1, "clock_in_date": "string", "clock_in_time": "2026-01-31 09:00:00", "clock_out_time": "2026-01-31 09:00:00", "working_from": "string", "late": "yes", "half_day": "yes", "added_by": 10, "company_id": 1 }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/attendance/{attendance}": { "get": { "tags": [ "Attendance" ], "summary": "Get a Attendance", "description": "Fetches a single attendance by its id, including its detail fields.", "operationId": "get_attendance_attendance", "parameters": [ { "name": "attendance", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The attendance (usually the numeric id)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Attendance" } } }, "example": { "data": { "id": 1, "user_id": 1, "clock_in_date": "string", "clock_in_time": "2026-01-31 09:00:00", "clock_out_time": "2026-01-31 09:00:00", "working_from": "string", "late": "yes", "half_day": "yes", "added_by": 10, "company_id": 1 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "put": { "tags": [ "Attendance" ], "summary": "Update a Attendance", "description": "Updates an existing attendance by its id. Send only the fields you want to change; everything else stays as-is.", "operationId": "put_attendance_attendance", "parameters": [ { "name": "attendance", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The attendance (usually the numeric id)." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "user_id": { "type": "integer", "description": "Employee whose attendance this is. Get ids via GET /employee." }, "clock_in_time": { "type": "string", "description": "Clock-in date & time, \"YYYY-MM-DD HH:MM:SS\"." }, "clock_out_time": { "type": "string", "description": "Clock-out date & time, \"YYYY-MM-DD HH:MM:SS\" (optional; leave blank if still clocked in)." }, "working_from": { "type": "string", "description": "Where the employee worked, e.g. \"office\" or \"home\"." }, "late": { "type": "string", "description": "Whether the clock-in was late.", "enum": [ "yes", "no" ] }, "half_day": { "type": "string", "description": "Whether this is a half-day.", "enum": [ "yes", "no" ] } }, "example": { "user_id": 1, "clock_in_time": "2026-06-01 09:00:00", "clock_out_time": "2026-06-01 17:00:00", "working_from": "office" } }, "example": { "user_id": 1, "clock_in_time": "2026-06-01 09:00:00", "clock_out_time": "2026-06-01 17:00:00", "working_from": "office" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Attendance" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "user_id": 1, "clock_in_date": "string", "clock_in_time": "2026-01-31 09:00:00", "clock_out_time": "2026-01-31 09:00:00", "working_from": "string", "late": "yes", "half_day": "yes", "added_by": 10, "company_id": 1 }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "delete": { "tags": [ "Attendance" ], "summary": "Delete a Attendance", "description": "Permanently deletes a attendance by its id. This cannot be undone.", "operationId": "delete_attendance_attendance", "parameters": [ { "name": "attendance", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The attendance (usually the numeric id)." } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "example": { "message": "Resource deleted successfully", "meta": { "time": 0.03 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/break": { "get": { "tags": [ "Break Logs" ], "summary": "List Break Logs", "description": "Returns a paginated list of Break Logs in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_break", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,user_id,attendance_id", "description": "Available fields: `id`, `user_id`, `attendance_id`, `break_type_id`, `start_time`, `end_time`, `duration_minutes`, `is_over_limit`, `note`. Comma-separated subset of the above to return, e.g. `id,user_id,attendance_id`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`, `user_id`, `break_type_id`, `start_time`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Break" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "user_id": 1, "attendance_id": 1, "break_type_id": 1, "start_time": "2026-01-31 09:00:00", "end_time": "2026-01-31 09:00:00", "duration_minutes": 10, "is_over_limit": true, "note": "string" } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "post": { "tags": [ "Break Logs" ], "summary": "Create a Break Log", "description": "Creates a new break log. Send the body fields below — required ones are marked; optional ones fall back to their defaults.", "operationId": "post_break", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "user_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /employee." }, "attendance_id": { "type": "integer", "description": "Numeric id of the related attendance record." }, "break_type_id": { "type": "integer", "description": "Numeric id of the related break_type record." }, "start_time": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." }, "end_time": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." }, "duration_minutes": { "type": "integer" }, "is_over_limit": { "type": "boolean", "default": false, "description": "Yes/No flag — true or false (also accepts 1 or 0). Defaults to false if omitted." }, "note": { "type": "string" } }, "required": [ "user_id", "start_time" ], "example": { "user_id": 1, "attendance_id": 1, "break_type_id": 1, "start_time": "2026-01-31 09:00:00", "end_time": "2026-01-31 09:00:00", "duration_minutes": 10, "is_over_limit": true, "note": "string" } }, "example": { "user_id": 1, "attendance_id": 1, "break_type_id": 1, "start_time": "2026-01-31 09:00:00", "end_time": "2026-01-31 09:00:00", "duration_minutes": 10, "is_over_limit": true, "note": "string" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Break" }, "meta": { "type": "object" } } }, "example": { "message": "Resource created successfully", "data": { "id": 1, "user_id": 1, "attendance_id": 1, "break_type_id": 1, "start_time": "2026-01-31 09:00:00", "end_time": "2026-01-31 09:00:00", "duration_minutes": 10, "is_over_limit": true, "note": "string" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/break/{break}": { "get": { "tags": [ "Break Logs" ], "summary": "Get a Break Log", "description": "Fetches a single break log by its id, including its detail fields.", "operationId": "get_break_break", "parameters": [ { "name": "break", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The break (usually the numeric id)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Break" } } }, "example": { "data": { "id": 1, "user_id": 1, "attendance_id": 1, "break_type_id": 1, "start_time": "2026-01-31 09:00:00", "end_time": "2026-01-31 09:00:00", "duration_minutes": 10, "is_over_limit": true, "note": "string" } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "put": { "tags": [ "Break Logs" ], "summary": "Update a Break Log", "description": "Updates an existing break log by its id. Send only the fields you want to change; everything else stays as-is.", "operationId": "put_break_break", "parameters": [ { "name": "break", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The break (usually the numeric id)." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "user_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /employee." }, "attendance_id": { "type": "integer", "description": "Numeric id of the related attendance record." }, "break_type_id": { "type": "integer", "description": "Numeric id of the related break_type record." }, "start_time": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." }, "end_time": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." }, "duration_minutes": { "type": "integer" }, "is_over_limit": { "type": "boolean", "default": false, "description": "Yes/No flag — true or false (also accepts 1 or 0). Defaults to false if omitted." }, "note": { "type": "string" } }, "example": { "user_id": 1, "attendance_id": 1, "break_type_id": 1, "start_time": "2026-01-31 09:00:00", "end_time": "2026-01-31 09:00:00", "duration_minutes": 10, "is_over_limit": true, "note": "string" } }, "example": { "user_id": 1, "attendance_id": 1, "break_type_id": 1, "start_time": "2026-01-31 09:00:00", "end_time": "2026-01-31 09:00:00", "duration_minutes": 10, "is_over_limit": true, "note": "string" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Break" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "user_id": 1, "attendance_id": 1, "break_type_id": 1, "start_time": "2026-01-31 09:00:00", "end_time": "2026-01-31 09:00:00", "duration_minutes": 10, "is_over_limit": true, "note": "string" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "delete": { "tags": [ "Break Logs" ], "summary": "Delete a Break Log", "description": "Permanently deletes a break log by its id. This cannot be undone.", "operationId": "delete_break_break", "parameters": [ { "name": "break", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The break (usually the numeric id)." } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "example": { "message": "Resource deleted successfully", "meta": { "time": 0.03 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/break-type": { "get": { "tags": [ "Break Types" ], "summary": "List Break Types", "description": "Returns a paginated list of Break Types in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_break-type", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,name,time_limit", "description": "Available fields: `id`, `name`, `time_limit`, `is_paid`, `color`, `status`. Comma-separated subset of the above to return, e.g. `id,name,time_limit`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`, `name`, `status`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BreakType" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "name": "Example", "time_limit": 10, "is_paid": "yes", "color": "string", "status": "active" } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "post": { "tags": [ "Break Types" ], "summary": "Create a Break Type", "description": "Creates a new break type. Send the body fields below — required ones are marked; optional ones fall back to their defaults.", "operationId": "post_break-type", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "time_limit": { "type": "integer" }, "is_paid": { "type": "string", "enum": [ "yes", "no" ], "default": "no", "description": "One of: \"yes\", \"no\". Defaults to \"no\" if omitted." }, "color": { "type": "string", "default": "#1d82f5", "description": "Defaults to \"#1d82f5\" if omitted." }, "status": { "type": "string", "enum": [ "active", "inactive" ], "default": "active", "description": "One of: \"active\", \"inactive\". Defaults to \"active\" if omitted." } }, "required": [ "name" ], "example": { "name": "Example", "time_limit": 10, "is_paid": "yes", "color": "string", "status": "active" } }, "example": { "name": "Example", "time_limit": 10, "is_paid": "yes", "color": "string", "status": "active" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/BreakType" }, "meta": { "type": "object" } } }, "example": { "message": "Resource created successfully", "data": { "id": 1, "name": "Example", "time_limit": 10, "is_paid": "yes", "color": "string", "status": "active" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/break-type/{break_type}": { "get": { "tags": [ "Break Types" ], "summary": "Get a Break Type", "description": "Fetches a single break type by its id, including its detail fields.", "operationId": "get_break-type_break_type", "parameters": [ { "name": "break_type", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The break type (usually the numeric id)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BreakType" } } }, "example": { "data": { "id": 1, "name": "Example", "time_limit": 10, "is_paid": "yes", "color": "string", "status": "active" } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "put": { "tags": [ "Break Types" ], "summary": "Update a Break Type", "description": "Updates an existing break type by its id. Send only the fields you want to change; everything else stays as-is.", "operationId": "put_break-type_break_type", "parameters": [ { "name": "break_type", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The break type (usually the numeric id)." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "time_limit": { "type": "integer" }, "is_paid": { "type": "string", "enum": [ "yes", "no" ], "default": "no", "description": "One of: \"yes\", \"no\". Defaults to \"no\" if omitted." }, "color": { "type": "string", "default": "#1d82f5", "description": "Defaults to \"#1d82f5\" if omitted." }, "status": { "type": "string", "enum": [ "active", "inactive" ], "default": "active", "description": "One of: \"active\", \"inactive\". Defaults to \"active\" if omitted." } }, "example": { "name": "Example", "time_limit": 10, "is_paid": "yes", "color": "string", "status": "active" } }, "example": { "name": "Example", "time_limit": 10, "is_paid": "yes", "color": "string", "status": "active" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/BreakType" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "name": "Example", "time_limit": 10, "is_paid": "yes", "color": "string", "status": "active" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "delete": { "tags": [ "Break Types" ], "summary": "Delete a Break Type", "description": "Permanently deletes a break type by its id. This cannot be undone.", "operationId": "delete_break-type_break_type", "parameters": [ { "name": "break_type", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The break type (usually the numeric id)." } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "example": { "message": "Resource deleted successfully", "meta": { "time": 0.03 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/task/{task_id}/comment": { "post": { "tags": [ "Task Comments" ], "summary": "Create a Task Comment", "description": "Creates a new task comment. Send the body fields below — required ones are marked; optional ones fall back to their defaults.", "operationId": "post_task_task_id_comment", "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The task id (usually the numeric id)." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "comment": { "type": "string" }, "user_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /employee." }, "task_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /task." } }, "required": [ "comment", "user_id", "task_id" ], "example": { "comment": "string", "user_id": 1, "task_id": 1 } }, "example": { "comment": "string", "user_id": 1, "task_id": 1 } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Comment" }, "meta": { "type": "object" } } }, "example": { "message": "Resource created successfully", "data": { "id": 1, "comment": "string", "task_id": 1, "user_id": 1 }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/task/{task_id}/comment/{comment}": { "put": { "tags": [ "Task Comments" ], "summary": "Update a Task Comment", "description": "Updates an existing task comment by its id. Send only the fields you want to change; everything else stays as-is.", "operationId": "put_task_task_id_comment_comment", "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The task id (usually the numeric id)." }, { "name": "comment", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The comment (usually the numeric id)." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "comment": { "type": "string" }, "user_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /employee." }, "task_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /task." } }, "example": { "comment": "string", "user_id": 1, "task_id": 1 } }, "example": { "comment": "string", "user_id": 1, "task_id": 1 } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Comment" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "comment": "string", "task_id": 1, "user_id": 1 }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "delete": { "tags": [ "Task Comments" ], "summary": "Delete a Task Comment", "description": "Permanently deletes a task comment by its id. This cannot be undone.", "operationId": "delete_task_task_id_comment_comment", "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The task id (usually the numeric id)." }, { "name": "comment", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The comment (usually the numeric id)." } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "example": { "message": "Resource deleted successfully", "meta": { "time": 0.03 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/company": { "get": { "tags": [ "Company" ], "summary": "List Company", "description": "Returns a paginated list of Company in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_company", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,name", "description": "Comma-separated subset of the above to return, e.g. `id,name`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1 } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/contact/upsert": { "post": { "tags": [ "Contacts" ], "summary": "Upsert a Contact", "description": "Creates a contact, or updates the existing one if a record with the same email already exists. Use this when you don't want to track ids yourself.", "operationId": "post_contact_upsert", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Display name of the person or company." }, "email": { "type": "string", "description": "Unique email within your workspace. Used as the login and as the match key for upsert." }, "password": { "type": "string", "description": "Optional login password (min 6 chars). If omitted, a random one is generated. Stored securely; never returned." }, "mobile": { "type": "string", "description": "Phone number, digits only e.g. \"3001234567\"." }, "salutation": { "type": "string", "description": "Title. One of: mr, mrs, miss, dr, sir, madam.", "enum": [ "mr", "mrs", "miss", "dr", "sir", "madam" ] }, "gender": { "type": "string", "description": "One of: male, female, others.", "enum": [ "male", "female", "others" ] }, "locale": { "type": "string", "default": "en", "description": "Language code for the contact, e.g. \"en\". Default: \"en\"." }, "country_id": { "type": "integer", "description": "Country id (see the Countries reference / your workspace settings)." }, "country_phonecode": { "type": "string", "description": "Dialing code for the mobile number, e.g. \"92\"." }, "login": { "type": "string", "default": "disable", "description": "Whether this contact can log into the client portal. Defaults to \"disable\" — the contact gets no login access unless you set \"enable\". Default: \"disable\".", "enum": [ "enable", "disable" ] }, "email_notifications": { "type": "integer", "default": 1, "description": "Receive email notifications: 1 = yes, 0 = no. Default: 1.", "enum": [ 0, 1 ] }, "contact_tags": { "type": "array", "description": "Array of tag NAMES (strings), e.g. [\"VIP\",\"Newsletter\"]. On create/update/upsert this REPLACES the contact's entire tag list — tags not in this array are removed. Missing tags are created automatically; you never pass ids. To add or remove individual tags without resending the whole list, use POST or DELETE /contact/{id}/tags instead.", "items": { "type": "string" } }, "sendMail": { "type": "string", "default": "no", "description": "Whether to email the contact a welcome/login message. Set to \"yes\" to send it. Default: \"no\".", "enum": [ "no", "yes" ] }, "contact_detail": { "type": "object", "description": "Company, address, social and classification details. Every field is optional — send only the ones you have.", "properties": { "company_name": { "type": "string", "description": "Company / organisation name." }, "website": { "type": "string", "description": "Website URL, e.g. \"https://acme.com\"." }, "address": { "type": "string", "description": "Billing / primary address." }, "shipping_address": { "type": "string", "description": "Shipping address (if different)." }, "city": { "type": "string", "description": "City." }, "state": { "type": "string", "description": "State / province." }, "postal_code": { "type": "string", "description": "ZIP / postal code." }, "office": { "type": "string", "description": "Office phone number." }, "cell": { "type": "string", "description": "Alternate / cell phone number." }, "note": { "type": "string", "description": "Free-text note about the contact." }, "gst_number": { "type": "string", "description": "Tax / GST registration number." }, "tax_name": { "type": "string", "description": "Label for the tax number (e.g. \"VAT\", \"GST\")." }, "linkedin": { "type": "string", "description": "LinkedIn profile URL." }, "facebook": { "type": "string", "description": "Facebook profile URL." }, "twitter": { "type": "string", "description": "Twitter/X handle or URL." }, "skype": { "type": "string", "description": "Skype username." }, "contact_type": { "type": "string", "description": "Classification of the contact.", "enum": [ "lead", "prospect", "customer", "partner", "vendor", "subcontractor", "investor", "employee", "other" ] }, "source": { "type": "string", "description": "Where the contact came from, free text, e.g. \"Website\", \"Referral\"." }, "electronic_address": { "type": "string", "description": "E-invoice electronic address (e.g. PEPPOL ID)." }, "electronic_address_scheme": { "type": "string", "description": "E-invoice electronic address scheme." }, "category": { "type": "object", "description": "Assign a contact category. Pass its id (list them via GET /contact-category).", "properties": { "id": { "type": "integer", "description": "Contact category id." } } }, "sub_category": { "type": "object", "description": "Assign a sub-category (list them via GET /contact-sub-category).", "properties": { "id": { "type": "integer", "description": "Contact sub-category id." } } } } } }, "required": [ "name", "email" ], "example": { "name": "Acme Corporation", "email": "buyer@acme.com", "contact_detail": { "contact_type": "customer", "city": "Lahore" } } }, "example": { "name": "Acme Corporation", "email": "buyer@acme.com", "contact_detail": { "contact_type": "customer", "city": "Lahore" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Contact" }, "meta": { "type": "object" } } }, "example": { "message": "Resource upserted successfully", "data": { "id": 1, "name": "Example", "email": "name@example.com", "status": "active", "company_id": 1 }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/contact/{id}/tags": { "post": { "tags": [ "Contacts" ], "summary": "Add tags to a Contact", "description": "Adds one or more tags (by name) to a contact **without** removing existing tags. Tags are matched by name; any that do not exist yet are created automatically.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "example": 1, "description": "The contact id." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "tags" ], "properties": { "tags": { "type": "array", "items": { "type": "string" }, "description": "Tag names to add." } }, "example": { "tags": [ "VIP", "Newsletter" ] } }, "example": { "tags": [ "VIP", "Newsletter" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "message": "Tags added successfully", "data": { "id": 1, "tags": [ "VIP", "Newsletter" ] }, "meta": { "time": 0.03 } } } } } } }, "delete": { "tags": [ "Contacts" ], "summary": "Remove tags from a Contact", "description": "Removes one or more tags (by name) from a contact. The tags themselves are not deleted — they are just detached from this contact.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "example": 1, "description": "The contact id." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "tags" ], "properties": { "tags": { "type": "array", "items": { "type": "string" }, "description": "Tag names to remove." } }, "example": { "tags": [ "VIP" ] } }, "example": { "tags": [ "VIP" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "message": "Tags removed successfully", "data": { "id": 1, "tags": [] }, "meta": { "time": 0.03 } } } } } } } }, "/contact": { "get": { "tags": [ "Contacts" ], "summary": "List Contacts", "description": "Returns a paginated list of Contacts in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_contact", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,name,email", "description": "Available fields: `id`, `name`, `email`, `status`, `company_id`. Comma-separated subset of the above to return, e.g. `id,name,email`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`, `users.name`, `email`, `status`, `contact_details.category_id`, `contact_details.sub_category_id`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Contact" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "name": "Example", "email": "name@example.com", "status": "active", "company_id": 1 } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "post": { "tags": [ "Contacts" ], "summary": "Create a Contact", "description": "Creates a new contact. Send the body fields below — required ones are marked; optional ones fall back to their defaults.", "operationId": "post_contact", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Display name of the person or company." }, "email": { "type": "string", "description": "Unique email within your workspace. Used as the login and as the match key for upsert." }, "password": { "type": "string", "description": "Optional login password (min 6 chars). If omitted, a random one is generated. Stored securely; never returned." }, "mobile": { "type": "string", "description": "Phone number, digits only e.g. \"3001234567\"." }, "salutation": { "type": "string", "description": "Title. One of: mr, mrs, miss, dr, sir, madam.", "enum": [ "mr", "mrs", "miss", "dr", "sir", "madam" ] }, "gender": { "type": "string", "description": "One of: male, female, others.", "enum": [ "male", "female", "others" ] }, "locale": { "type": "string", "default": "en", "description": "Language code for the contact, e.g. \"en\". Default: \"en\"." }, "country_id": { "type": "integer", "description": "Country id (see the Countries reference / your workspace settings)." }, "country_phonecode": { "type": "string", "description": "Dialing code for the mobile number, e.g. \"92\"." }, "login": { "type": "string", "default": "disable", "description": "Whether this contact can log into the client portal. Defaults to \"disable\" — the contact gets no login access unless you set \"enable\". Default: \"disable\".", "enum": [ "enable", "disable" ] }, "email_notifications": { "type": "integer", "default": 1, "description": "Receive email notifications: 1 = yes, 0 = no. Default: 1.", "enum": [ 0, 1 ] }, "contact_tags": { "type": "array", "description": "Array of tag NAMES (strings), e.g. [\"VIP\",\"Newsletter\"]. On create/update/upsert this REPLACES the contact's entire tag list — tags not in this array are removed. Missing tags are created automatically; you never pass ids. To add or remove individual tags without resending the whole list, use POST or DELETE /contact/{id}/tags instead.", "items": { "type": "string" } }, "sendMail": { "type": "string", "default": "no", "description": "Whether to email the contact a welcome/login message. Set to \"yes\" to send it. Default: \"no\".", "enum": [ "no", "yes" ] }, "contact_detail": { "type": "object", "description": "Company, address, social and classification details. Every field is optional — send only the ones you have.", "properties": { "company_name": { "type": "string", "description": "Company / organisation name." }, "website": { "type": "string", "description": "Website URL, e.g. \"https://acme.com\"." }, "address": { "type": "string", "description": "Billing / primary address." }, "shipping_address": { "type": "string", "description": "Shipping address (if different)." }, "city": { "type": "string", "description": "City." }, "state": { "type": "string", "description": "State / province." }, "postal_code": { "type": "string", "description": "ZIP / postal code." }, "office": { "type": "string", "description": "Office phone number." }, "cell": { "type": "string", "description": "Alternate / cell phone number." }, "note": { "type": "string", "description": "Free-text note about the contact." }, "gst_number": { "type": "string", "description": "Tax / GST registration number." }, "tax_name": { "type": "string", "description": "Label for the tax number (e.g. \"VAT\", \"GST\")." }, "linkedin": { "type": "string", "description": "LinkedIn profile URL." }, "facebook": { "type": "string", "description": "Facebook profile URL." }, "twitter": { "type": "string", "description": "Twitter/X handle or URL." }, "skype": { "type": "string", "description": "Skype username." }, "contact_type": { "type": "string", "description": "Classification of the contact.", "enum": [ "lead", "prospect", "customer", "partner", "vendor", "subcontractor", "investor", "employee", "other" ] }, "source": { "type": "string", "description": "Where the contact came from, free text, e.g. \"Website\", \"Referral\"." }, "electronic_address": { "type": "string", "description": "E-invoice electronic address (e.g. PEPPOL ID)." }, "electronic_address_scheme": { "type": "string", "description": "E-invoice electronic address scheme." }, "category": { "type": "object", "description": "Assign a contact category. Pass its id (list them via GET /contact-category).", "properties": { "id": { "type": "integer", "description": "Contact category id." } } }, "sub_category": { "type": "object", "description": "Assign a sub-category (list them via GET /contact-sub-category).", "properties": { "id": { "type": "integer", "description": "Contact sub-category id." } } } } } }, "required": [ "name", "email" ], "example": { "name": "Acme Corporation", "email": "buyer@acme.com", "password": "S3curePass!", "mobile": "3001234567", "gender": "male", "sendMail": "no", "contact_tags": [ "VIP", "Newsletter" ], "contact_detail": { "company_name": "Acme Corporation", "website": "https://acme.com", "address": "123 Market St", "city": "Lahore", "state": "Punjab", "postal_code": "54000", "office": "+92-42-111-222-333", "contact_type": "customer", "source": "Website", "note": "Key account", "category": { "id": 1 }, "sub_category": { "id": 2 } } } }, "example": { "name": "Acme Corporation", "email": "buyer@acme.com", "password": "S3curePass!", "mobile": "3001234567", "gender": "male", "sendMail": "no", "contact_tags": [ "VIP", "Newsletter" ], "contact_detail": { "company_name": "Acme Corporation", "website": "https://acme.com", "address": "123 Market St", "city": "Lahore", "state": "Punjab", "postal_code": "54000", "office": "+92-42-111-222-333", "contact_type": "customer", "source": "Website", "note": "Key account", "category": { "id": 1 }, "sub_category": { "id": 2 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Contact" }, "meta": { "type": "object" } } }, "example": { "message": "Resource created successfully", "data": { "id": 1, "name": "Example", "email": "name@example.com", "status": "active", "company_id": 1 }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/contact/{contact}": { "get": { "tags": [ "Contacts" ], "summary": "Get a Contact", "description": "Fetches a single contact by its id, including its detail fields.", "operationId": "get_contact_contact", "parameters": [ { "name": "contact", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The contact (usually the numeric id)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Contact" } } }, "example": { "data": { "id": 1, "name": "Example", "email": "name@example.com", "status": "active", "company_id": 1 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "put": { "tags": [ "Contacts" ], "summary": "Update a Contact", "description": "Updates an existing contact by its id. Send only the fields you want to change; everything else stays as-is.", "operationId": "put_contact_contact", "parameters": [ { "name": "contact", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The contact (usually the numeric id)." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Display name of the person or company." }, "email": { "type": "string", "description": "Unique email within your workspace. Used as the login and as the match key for upsert." }, "password": { "type": "string", "description": "Optional login password (min 6 chars). If omitted, a random one is generated. Stored securely; never returned." }, "mobile": { "type": "string", "description": "Phone number, digits only e.g. \"3001234567\"." }, "salutation": { "type": "string", "description": "Title. One of: mr, mrs, miss, dr, sir, madam.", "enum": [ "mr", "mrs", "miss", "dr", "sir", "madam" ] }, "gender": { "type": "string", "description": "One of: male, female, others.", "enum": [ "male", "female", "others" ] }, "locale": { "type": "string", "default": "en", "description": "Language code for the contact, e.g. \"en\". Default: \"en\"." }, "country_id": { "type": "integer", "description": "Country id (see the Countries reference / your workspace settings)." }, "country_phonecode": { "type": "string", "description": "Dialing code for the mobile number, e.g. \"92\"." }, "login": { "type": "string", "default": "disable", "description": "Whether this contact can log into the client portal. Defaults to \"disable\" — the contact gets no login access unless you set \"enable\". Default: \"disable\".", "enum": [ "enable", "disable" ] }, "email_notifications": { "type": "integer", "default": 1, "description": "Receive email notifications: 1 = yes, 0 = no. Default: 1.", "enum": [ 0, 1 ] }, "contact_tags": { "type": "array", "description": "Array of tag NAMES (strings), e.g. [\"VIP\",\"Newsletter\"]. On create/update/upsert this REPLACES the contact's entire tag list — tags not in this array are removed. Missing tags are created automatically; you never pass ids. To add or remove individual tags without resending the whole list, use POST or DELETE /contact/{id}/tags instead.", "items": { "type": "string" } }, "sendMail": { "type": "string", "default": "no", "description": "Whether to email the contact a welcome/login message. Set to \"yes\" to send it. Default: \"no\".", "enum": [ "no", "yes" ] }, "contact_detail": { "type": "object", "description": "Company, address, social and classification details. Every field is optional — send only the ones you have.", "properties": { "company_name": { "type": "string", "description": "Company / organisation name." }, "website": { "type": "string", "description": "Website URL, e.g. \"https://acme.com\"." }, "address": { "type": "string", "description": "Billing / primary address." }, "shipping_address": { "type": "string", "description": "Shipping address (if different)." }, "city": { "type": "string", "description": "City." }, "state": { "type": "string", "description": "State / province." }, "postal_code": { "type": "string", "description": "ZIP / postal code." }, "office": { "type": "string", "description": "Office phone number." }, "cell": { "type": "string", "description": "Alternate / cell phone number." }, "note": { "type": "string", "description": "Free-text note about the contact." }, "gst_number": { "type": "string", "description": "Tax / GST registration number." }, "tax_name": { "type": "string", "description": "Label for the tax number (e.g. \"VAT\", \"GST\")." }, "linkedin": { "type": "string", "description": "LinkedIn profile URL." }, "facebook": { "type": "string", "description": "Facebook profile URL." }, "twitter": { "type": "string", "description": "Twitter/X handle or URL." }, "skype": { "type": "string", "description": "Skype username." }, "contact_type": { "type": "string", "description": "Classification of the contact.", "enum": [ "lead", "prospect", "customer", "partner", "vendor", "subcontractor", "investor", "employee", "other" ] }, "source": { "type": "string", "description": "Where the contact came from, free text, e.g. \"Website\", \"Referral\"." }, "electronic_address": { "type": "string", "description": "E-invoice electronic address (e.g. PEPPOL ID)." }, "electronic_address_scheme": { "type": "string", "description": "E-invoice electronic address scheme." }, "category": { "type": "object", "description": "Assign a contact category. Pass its id (list them via GET /contact-category).", "properties": { "id": { "type": "integer", "description": "Contact category id." } } }, "sub_category": { "type": "object", "description": "Assign a sub-category (list them via GET /contact-sub-category).", "properties": { "id": { "type": "integer", "description": "Contact sub-category id." } } } } } }, "example": { "name": "Acme Corporation (HQ)", "mobile": "3009998877", "contact_detail": { "city": "Karachi", "note": "Moved head office" } } }, "example": { "name": "Acme Corporation (HQ)", "mobile": "3009998877", "contact_detail": { "city": "Karachi", "note": "Moved head office" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Contact" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "name": "Example", "email": "name@example.com", "status": "active", "company_id": 1 }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "delete": { "tags": [ "Contacts" ], "summary": "Delete a Contact", "description": "Permanently deletes a contact by its id. This cannot be undone.", "operationId": "delete_contact_contact", "parameters": [ { "name": "contact", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The contact (usually the numeric id)." } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "example": { "message": "Resource deleted successfully", "meta": { "time": 0.03 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/contact-category": { "get": { "tags": [ "Contact Categories" ], "summary": "List Contact Categories", "description": "Returns a paginated list of Contact Categories in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_contact-category", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,category_name", "description": "Available fields: `id`, `category_name`. Comma-separated subset of the above to return, e.g. `id,category_name`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `category_name`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ContactCategory" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "category_name": "Example" } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "post": { "tags": [ "Contact Categories" ], "summary": "Create a Contact Category", "description": "Creates a new contact category. Send the body fields below — required ones are marked; optional ones fall back to their defaults.", "operationId": "post_contact-category", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "category_name": { "type": "string" } }, "required": [ "category_name" ], "example": { "category_name": "Example" } }, "example": { "category_name": "Example" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/ContactCategory" }, "meta": { "type": "object" } } }, "example": { "message": "Resource created successfully", "data": { "id": 1, "category_name": "Example" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/contact-category/{contact_category}": { "get": { "tags": [ "Contact Categories" ], "summary": "Get a Contact Category", "description": "Fetches a single contact category by its id, including its detail fields.", "operationId": "get_contact-category_contact_category", "parameters": [ { "name": "contact_category", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The contact category (usually the numeric id)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ContactCategory" } } }, "example": { "data": { "id": 1, "category_name": "Example" } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "put": { "tags": [ "Contact Categories" ], "summary": "Update a Contact Category", "description": "Updates an existing contact category by its id. Send only the fields you want to change; everything else stays as-is.", "operationId": "put_contact-category_contact_category", "parameters": [ { "name": "contact_category", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The contact category (usually the numeric id)." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "category_name": { "type": "string" } }, "example": { "category_name": "Example" } }, "example": { "category_name": "Example" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/ContactCategory" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "category_name": "Example" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "delete": { "tags": [ "Contact Categories" ], "summary": "Delete a Contact Category", "description": "Permanently deletes a contact category by its id. This cannot be undone.", "operationId": "delete_contact-category_contact_category", "parameters": [ { "name": "contact_category", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The contact category (usually the numeric id)." } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "example": { "message": "Resource deleted successfully", "meta": { "time": 0.03 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/contact-sub-category": { "get": { "tags": [ "Contact Sub-categories" ], "summary": "List Contact Sub-categories", "description": "Returns a paginated list of Contact Sub-categories in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_contact-sub-category", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,category_name,category_id", "description": "Available fields: `id`, `category_name`, `category_id`. Comma-separated subset of the above to return, e.g. `id,category_name,category_id`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `category_name`, `category_id`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ContactSubCategory" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "category_name": "Example", "category_id": 1 } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "post": { "tags": [ "Contact Sub-categories" ], "summary": "Create a Contact Sub-category", "description": "Creates a new contact sub-category. Send the body fields below — required ones are marked; optional ones fall back to their defaults.", "operationId": "post_contact-sub-category", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "category_name": { "type": "string" } }, "required": [ "category_name" ], "example": { "category_name": "Example" } }, "example": { "category_name": "Example" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/ContactSubCategory" }, "meta": { "type": "object" } } }, "example": { "message": "Resource created successfully", "data": { "id": 1, "category_name": "Example", "category_id": 1 }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/contact-sub-category/{contact_sub_category}": { "get": { "tags": [ "Contact Sub-categories" ], "summary": "Get a Contact Sub-category", "description": "Fetches a single contact sub-category by its id, including its detail fields.", "operationId": "get_contact-sub-category_contact_sub_category", "parameters": [ { "name": "contact_sub_category", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The contact sub category (usually the numeric id)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ContactSubCategory" } } }, "example": { "data": { "id": 1, "category_name": "Example", "category_id": 1 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "put": { "tags": [ "Contact Sub-categories" ], "summary": "Update a Contact Sub-category", "description": "Updates an existing contact sub-category by its id. Send only the fields you want to change; everything else stays as-is.", "operationId": "put_contact-sub-category_contact_sub_category", "parameters": [ { "name": "contact_sub_category", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The contact sub category (usually the numeric id)." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "category_name": { "type": "string" } }, "example": { "category_name": "Example" } }, "example": { "category_name": "Example" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/ContactSubCategory" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "category_name": "Example", "category_id": 1 }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "delete": { "tags": [ "Contact Sub-categories" ], "summary": "Delete a Contact Sub-category", "description": "Permanently deletes a contact sub-category by its id. This cannot be undone.", "operationId": "delete_contact-sub-category_contact_sub_category", "parameters": [ { "name": "contact_sub_category", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The contact sub category (usually the numeric id)." } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "example": { "message": "Resource deleted successfully", "meta": { "time": 0.03 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/contract": { "get": { "tags": [ "Contracts" ], "summary": "List Contracts", "description": "Returns a paginated list of Contracts in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_contract", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,subject,amount", "description": "Available fields: `id`, `subject`, `amount`, `start_date`. Comma-separated subset of the above to return, e.g. `id,subject,amount`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`, `subject`, `amount`, `start_date`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Contract" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "subject": "string", "amount": "string", "start_date": "2026-01-31" } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "post": { "tags": [ "Contracts" ], "summary": "Create a Contract", "description": "Creates a new contract. Send the body fields below — required ones are marked; optional ones fall back to their defaults.", "operationId": "post_contract", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contract_number": { "type": "string" }, "original_contract_number": { "type": "string" }, "contact_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /contact." }, "project_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /project." }, "subject": { "type": "string" }, "amount": { "type": "string" }, "original_amount": { "type": "number" }, "contract_type_id": { "type": "integer", "description": "Numeric id of the related contract_type record." }, "start_date": { "type": "string", "format": "date", "description": "Date in YYYY-MM-DD format." }, "original_start_date": { "type": "string", "format": "date", "description": "Date in YYYY-MM-DD format." }, "end_date": { "type": "string", "format": "date", "description": "Date in YYYY-MM-DD format." }, "original_end_date": { "type": "string", "format": "date", "description": "Date in YYYY-MM-DD format." }, "description": { "type": "string" }, "contract_name": { "type": "string" }, "alternate_address": { "type": "string" }, "contract_note": { "type": "string" }, "cell": { "type": "string" }, "office": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "country": { "type": "string" }, "postal_code": { "type": "string" }, "contract_detail": { "type": "string" }, "currency_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /currency." }, "event_id": { "type": "string", "description": "Numeric id of the related event record." }, "company_sign": { "type": "string" }, "sign_date": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." }, "sign_by": { "type": "integer" } }, "required": [ "contact_id", "subject", "amount", "original_amount", "start_date", "original_start_date" ], "example": { "contract_number": "string", "original_contract_number": "string", "contact_id": 1, "project_id": 1, "subject": "string", "amount": "string", "original_amount": 100, "contract_type_id": 1, "start_date": "2026-01-31", "original_start_date": "2026-01-31", "end_date": "2026-01-31", "original_end_date": "2026-01-31", "description": "string", "contract_name": "Example", "alternate_address": "string", "contract_note": "string", "cell": "string", "office": "string", "city": "string", "state": "string", "country": "string", "postal_code": "string", "contract_detail": "string", "currency_id": 1, "event_id": "string", "company_sign": "string", "sign_date": "2026-01-31 09:00:00", "sign_by": 10 } }, "example": { "contract_number": "string", "original_contract_number": "string", "contact_id": 1, "project_id": 1, "subject": "string", "amount": "string", "original_amount": 100, "contract_type_id": 1, "start_date": "2026-01-31", "original_start_date": "2026-01-31", "end_date": "2026-01-31", "original_end_date": "2026-01-31", "description": "string", "contract_name": "Example", "alternate_address": "string", "contract_note": "string", "cell": "string", "office": "string", "city": "string", "state": "string", "country": "string", "postal_code": "string", "contract_detail": "string", "currency_id": 1, "event_id": "string", "company_sign": "string", "sign_date": "2026-01-31 09:00:00", "sign_by": 10 } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Contract" }, "meta": { "type": "object" } } }, "example": { "message": "Resource created successfully", "data": { "id": 1, "subject": "string", "amount": "string", "start_date": "2026-01-31" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/contract/{contract}": { "get": { "tags": [ "Contracts" ], "summary": "Get a Contract", "description": "Fetches a single contract by its id, including its detail fields.", "operationId": "get_contract_contract", "parameters": [ { "name": "contract", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The contract (usually the numeric id)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Contract" } } }, "example": { "data": { "id": 1, "subject": "string", "amount": "string", "start_date": "2026-01-31" } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "put": { "tags": [ "Contracts" ], "summary": "Update a Contract", "description": "Updates an existing contract by its id. Send only the fields you want to change; everything else stays as-is.", "operationId": "put_contract_contract", "parameters": [ { "name": "contract", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The contract (usually the numeric id)." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "contract_number": { "type": "string" }, "original_contract_number": { "type": "string" }, "contact_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /contact." }, "project_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /project." }, "subject": { "type": "string" }, "amount": { "type": "string" }, "original_amount": { "type": "number" }, "contract_type_id": { "type": "integer", "description": "Numeric id of the related contract_type record." }, "start_date": { "type": "string", "format": "date", "description": "Date in YYYY-MM-DD format." }, "original_start_date": { "type": "string", "format": "date", "description": "Date in YYYY-MM-DD format." }, "end_date": { "type": "string", "format": "date", "description": "Date in YYYY-MM-DD format." }, "original_end_date": { "type": "string", "format": "date", "description": "Date in YYYY-MM-DD format." }, "description": { "type": "string" }, "contract_name": { "type": "string" }, "alternate_address": { "type": "string" }, "contract_note": { "type": "string" }, "cell": { "type": "string" }, "office": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "country": { "type": "string" }, "postal_code": { "type": "string" }, "contract_detail": { "type": "string" }, "currency_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /currency." }, "event_id": { "type": "string", "description": "Numeric id of the related event record." }, "company_sign": { "type": "string" }, "sign_date": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." }, "sign_by": { "type": "integer" } }, "example": { "contract_number": "string", "original_contract_number": "string", "contact_id": 1, "project_id": 1, "subject": "string", "amount": "string", "original_amount": 100, "contract_type_id": 1, "start_date": "2026-01-31", "original_start_date": "2026-01-31", "end_date": "2026-01-31", "original_end_date": "2026-01-31", "description": "string", "contract_name": "Example", "alternate_address": "string", "contract_note": "string", "cell": "string", "office": "string", "city": "string", "state": "string", "country": "string", "postal_code": "string", "contract_detail": "string", "currency_id": 1, "event_id": "string", "company_sign": "string", "sign_date": "2026-01-31 09:00:00", "sign_by": 10 } }, "example": { "contract_number": "string", "original_contract_number": "string", "contact_id": 1, "project_id": 1, "subject": "string", "amount": "string", "original_amount": 100, "contract_type_id": 1, "start_date": "2026-01-31", "original_start_date": "2026-01-31", "end_date": "2026-01-31", "original_end_date": "2026-01-31", "description": "string", "contract_name": "Example", "alternate_address": "string", "contract_note": "string", "cell": "string", "office": "string", "city": "string", "state": "string", "country": "string", "postal_code": "string", "contract_detail": "string", "currency_id": 1, "event_id": "string", "company_sign": "string", "sign_date": "2026-01-31 09:00:00", "sign_by": 10 } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Contract" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "subject": "string", "amount": "string", "start_date": "2026-01-31" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "delete": { "tags": [ "Contracts" ], "summary": "Delete a Contract", "description": "Permanently deletes a contract by its id. This cannot be undone.", "operationId": "delete_contract_contract", "parameters": [ { "name": "contract", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The contract (usually the numeric id)." } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "example": { "message": "Resource deleted successfully", "meta": { "time": 0.03 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/contract-type": { "get": { "tags": [ "Contract Types" ], "summary": "List Contract Types", "description": "Returns a paginated list of Contract Types in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_contract-type", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,name", "description": "Available fields: `id`, `name`. Comma-separated subset of the above to return, e.g. `id,name`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`, `name`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ContractType" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "name": "Example" } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "post": { "tags": [ "Contract Types" ], "summary": "Create a Contract Type", "description": "Creates a new contract type. Send the body fields below — required ones are marked; optional ones fall back to their defaults.", "operationId": "post_contract-type", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "example": { "name": "Example" } }, "example": { "name": "Example" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/ContractType" }, "meta": { "type": "object" } } }, "example": { "message": "Resource created successfully", "data": { "id": 1, "name": "Example" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/contract-type/{contract_type}": { "get": { "tags": [ "Contract Types" ], "summary": "Get a Contract Type", "description": "Fetches a single contract type by its id, including its detail fields.", "operationId": "get_contract-type_contract_type", "parameters": [ { "name": "contract_type", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The contract type (usually the numeric id)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ContractType" } } }, "example": { "data": { "id": 1, "name": "Example" } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "put": { "tags": [ "Contract Types" ], "summary": "Update a Contract Type", "description": "Updates an existing contract type by its id. Send only the fields you want to change; everything else stays as-is.", "operationId": "put_contract-type_contract_type", "parameters": [ { "name": "contract_type", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The contract type (usually the numeric id)." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" } }, "example": { "name": "Example" } }, "example": { "name": "Example" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/ContractType" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "name": "Example" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "delete": { "tags": [ "Contract Types" ], "summary": "Delete a Contract Type", "description": "Permanently deletes a contract type by its id. This cannot be undone.", "operationId": "delete_contract-type_contract_type", "parameters": [ { "name": "contract_type", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The contract type (usually the numeric id)." } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "example": { "message": "Resource deleted successfully", "meta": { "time": 0.03 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/currency": { "get": { "tags": [ "Currencies" ], "summary": "List Currencies", "description": "Returns a paginated list of Currencies in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_currency", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id", "description": "Available fields: `id`. Comma-separated subset of the above to return, e.g. `id`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Currency" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1 } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "post": { "tags": [ "Currencies" ], "summary": "Create a Currency", "description": "Creates a new currency. Send the body fields below — required ones are marked; optional ones fall back to their defaults.", "operationId": "post_currency", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "currency_name": { "type": "string" }, "currency_symbol": { "type": "string" }, "currency_code": { "type": "string" }, "exchange_rate": { "type": "number" }, "is_cryptocurrency": { "type": "string", "enum": [ "yes", "no" ], "default": "no", "description": "One of: \"yes\", \"no\". Defaults to \"no\" if omitted." }, "usd_price": { "type": "number" }, "no_of_decimal": { "type": "integer", "default": 2, "description": "Defaults to 2 if omitted." }, "thousand_separator": { "type": "string" }, "decimal_separator": { "type": "string" }, "currency_position": { "type": "string", "enum": [ "left", "right", "left_with_space", "right_with_space" ], "default": "left", "description": "One of: \"left\", \"right\", \"left_with_space\", \"right_with_space\". Defaults to \"left\" if omitted." } }, "required": [ "currency_name", "currency_code" ], "example": { "currency_name": "Example", "currency_symbol": "string", "currency_code": "string", "exchange_rate": 100, "is_cryptocurrency": "yes", "usd_price": 100, "no_of_decimal": 10, "thousand_separator": "string", "decimal_separator": "string", "currency_position": "left" } }, "example": { "currency_name": "Example", "currency_symbol": "string", "currency_code": "string", "exchange_rate": 100, "is_cryptocurrency": "yes", "usd_price": 100, "no_of_decimal": 10, "thousand_separator": "string", "decimal_separator": "string", "currency_position": "left" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Currency" }, "meta": { "type": "object" } } }, "example": { "message": "Resource created successfully", "data": { "id": 1 }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/currency/{currency}": { "get": { "tags": [ "Currencies" ], "summary": "Get a Currency", "description": "Fetches a single currency by its id, including its detail fields.", "operationId": "get_currency_currency", "parameters": [ { "name": "currency", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The currency (usually the numeric id)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Currency" } } }, "example": { "data": { "id": 1 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "put": { "tags": [ "Currencies" ], "summary": "Update a Currency", "description": "Updates an existing currency by its id. Send only the fields you want to change; everything else stays as-is.", "operationId": "put_currency_currency", "parameters": [ { "name": "currency", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The currency (usually the numeric id)." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "currency_name": { "type": "string" }, "currency_symbol": { "type": "string" }, "currency_code": { "type": "string" }, "exchange_rate": { "type": "number" }, "is_cryptocurrency": { "type": "string", "enum": [ "yes", "no" ], "default": "no", "description": "One of: \"yes\", \"no\". Defaults to \"no\" if omitted." }, "usd_price": { "type": "number" }, "no_of_decimal": { "type": "integer", "default": 2, "description": "Defaults to 2 if omitted." }, "thousand_separator": { "type": "string" }, "decimal_separator": { "type": "string" }, "currency_position": { "type": "string", "enum": [ "left", "right", "left_with_space", "right_with_space" ], "default": "left", "description": "One of: \"left\", \"right\", \"left_with_space\", \"right_with_space\". Defaults to \"left\" if omitted." } }, "example": { "currency_name": "Example", "currency_symbol": "string", "currency_code": "string", "exchange_rate": 100, "is_cryptocurrency": "yes", "usd_price": 100, "no_of_decimal": 10, "thousand_separator": "string", "decimal_separator": "string", "currency_position": "left" } }, "example": { "currency_name": "Example", "currency_symbol": "string", "currency_code": "string", "exchange_rate": 100, "is_cryptocurrency": "yes", "usd_price": 100, "no_of_decimal": 10, "thousand_separator": "string", "decimal_separator": "string", "currency_position": "left" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Currency" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1 }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "delete": { "tags": [ "Currencies" ], "summary": "Delete a Currency", "description": "Permanently deletes a currency by its id. This cannot be undone.", "operationId": "delete_currency_currency", "parameters": [ { "name": "currency", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The currency (usually the numeric id)." } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "example": { "message": "Resource deleted successfully", "meta": { "time": 0.03 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/dashboard": { "get": { "tags": [ "Dashboard" ], "summary": "List Dashboard", "description": "Returns a paginated list of Dashboard in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_dashboard", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,name", "description": "Comma-separated subset of the above to return, e.g. `id,name`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1 } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/dashboard/me": { "get": { "tags": [ "Dashboard" ], "summary": "My Dashboard (Dashboard)", "description": "Performs the \"My Dashboard\" action on a dashboard.", "operationId": "get_dashboard_me", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "type": "object" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1 }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/deal": { "get": { "tags": [ "Deals" ], "summary": "List Deals", "description": "Returns a paginated list of Deals in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_deal", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,name,value", "description": "Available fields: `id`, `name`, `value`, `contact_type`, `pipeline_stage_id`, `close_date`. Comma-separated subset of the above to return, e.g. `id,name,value`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`, `name`, `value`, `contact_type`, `contact_id`, `lead_id`, `lead_pipeline_id`, `pipeline_stage_id`, `agent_id`, `category_id`, `currency_id`, `close_date`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Deal" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "name": "Example", "value": 100, "contact_type": "string", "pipeline_stage_id": 1, "close_date": "2026-01-31" } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "post": { "tags": [ "Deals" ], "summary": "Create a Deal", "description": "Creates a new deal. Send the body fields below — required ones are marked; optional ones fall back to their defaults.", "operationId": "post_deal", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "column_priority": { "type": "integer", "default": 0, "description": "Defaults to 0 if omitted." }, "lead_pipeline_id": { "type": "integer", "description": "Numeric id of the related lead_pipeline record." }, "pipeline_stage_id": { "type": "integer", "description": "Numeric id of the related pipeline_stage record." }, "lead_id": { "type": "integer", "description": "Numeric id of the related lead record." }, "contact_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /contact." }, "contact_type": { "type": "string", "default": "lead", "description": "Defaults to \"lead\" if omitted." }, "close_date": { "type": "string", "format": "date", "description": "Date in YYYY-MM-DD format." }, "agent_id": { "type": "integer", "description": "Numeric id of the related agent record." }, "category_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /contact-category." }, "next_follow_up": { "type": "string", "enum": [ "yes", "no" ], "default": "yes", "description": "One of: \"yes\", \"no\". Defaults to \"yes\" if omitted." }, "value": { "type": "number", "default": 0, "description": "Defaults to 0 if omitted." }, "note": { "type": "string" }, "currency_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /currency." }, "deal_watcher": { "type": "integer" }, "create_contact": { "type": "string", "enum": [ "0", "1" ], "default": "0", "description": "One of: \"0\", \"1\". Defaults to \"0\" if omitted." } }, "example": { "name": "Example", "column_priority": 10, "lead_pipeline_id": 1, "pipeline_stage_id": 1, "lead_id": 1, "contact_id": 1, "contact_type": "string", "close_date": "2026-01-31", "agent_id": 1, "category_id": 1, "next_follow_up": "yes", "value": 100, "note": "string", "currency_id": 1, "deal_watcher": 10, "create_contact": "0" } }, "example": { "name": "Example", "column_priority": 10, "lead_pipeline_id": 1, "pipeline_stage_id": 1, "lead_id": 1, "contact_id": 1, "contact_type": "string", "close_date": "2026-01-31", "agent_id": 1, "category_id": 1, "next_follow_up": "yes", "value": 100, "note": "string", "currency_id": 1, "deal_watcher": 10, "create_contact": "0" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Deal" }, "meta": { "type": "object" } } }, "example": { "message": "Resource created successfully", "data": { "id": 1, "name": "Example", "value": 100, "contact_type": "string", "pipeline_stage_id": 1, "close_date": "2026-01-31" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/deal/{deal}": { "get": { "tags": [ "Deals" ], "summary": "Get a Deal", "description": "Fetches a single deal by its id, including its detail fields.", "operationId": "get_deal_deal", "parameters": [ { "name": "deal", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The deal (usually the numeric id)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Deal" } } }, "example": { "data": { "id": 1, "name": "Example", "value": 100, "contact_type": "string", "pipeline_stage_id": 1, "close_date": "2026-01-31" } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "put": { "tags": [ "Deals" ], "summary": "Update a Deal", "description": "Updates an existing deal by its id. Send only the fields you want to change; everything else stays as-is.", "operationId": "put_deal_deal", "parameters": [ { "name": "deal", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The deal (usually the numeric id)." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "column_priority": { "type": "integer", "default": 0, "description": "Defaults to 0 if omitted." }, "lead_pipeline_id": { "type": "integer", "description": "Numeric id of the related lead_pipeline record." }, "pipeline_stage_id": { "type": "integer", "description": "Numeric id of the related pipeline_stage record." }, "lead_id": { "type": "integer", "description": "Numeric id of the related lead record." }, "contact_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /contact." }, "contact_type": { "type": "string", "default": "lead", "description": "Defaults to \"lead\" if omitted." }, "close_date": { "type": "string", "format": "date", "description": "Date in YYYY-MM-DD format." }, "agent_id": { "type": "integer", "description": "Numeric id of the related agent record." }, "category_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /contact-category." }, "next_follow_up": { "type": "string", "enum": [ "yes", "no" ], "default": "yes", "description": "One of: \"yes\", \"no\". Defaults to \"yes\" if omitted." }, "value": { "type": "number", "default": 0, "description": "Defaults to 0 if omitted." }, "note": { "type": "string" }, "currency_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /currency." }, "deal_watcher": { "type": "integer" }, "create_contact": { "type": "string", "enum": [ "0", "1" ], "default": "0", "description": "One of: \"0\", \"1\". Defaults to \"0\" if omitted." } }, "example": { "name": "Example", "column_priority": 10, "lead_pipeline_id": 1, "pipeline_stage_id": 1, "lead_id": 1, "contact_id": 1, "contact_type": "string", "close_date": "2026-01-31", "agent_id": 1, "category_id": 1, "next_follow_up": "yes", "value": 100, "note": "string", "currency_id": 1, "deal_watcher": 10, "create_contact": "0" } }, "example": { "name": "Example", "column_priority": 10, "lead_pipeline_id": 1, "pipeline_stage_id": 1, "lead_id": 1, "contact_id": 1, "contact_type": "string", "close_date": "2026-01-31", "agent_id": 1, "category_id": 1, "next_follow_up": "yes", "value": 100, "note": "string", "currency_id": 1, "deal_watcher": 10, "create_contact": "0" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Deal" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "name": "Example", "value": 100, "contact_type": "string", "pipeline_stage_id": 1, "close_date": "2026-01-31" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "delete": { "tags": [ "Deals" ], "summary": "Delete a Deal", "description": "Permanently deletes a deal by its id. This cannot be undone.", "operationId": "delete_deal_deal", "parameters": [ { "name": "deal", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The deal (usually the numeric id)." } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "example": { "message": "Resource deleted successfully", "meta": { "time": 0.03 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/department": { "get": { "tags": [ "Departments" ], "summary": "List Departments", "description": "Returns a paginated list of Departments in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_department", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,team_name", "description": "Available fields: `id`, `team_name`. Comma-separated subset of the above to return, e.g. `id,team_name`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`, `team_name`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Department" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "team_name": "Example" } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "post": { "tags": [ "Departments" ], "summary": "Create a Department", "description": "Creates a new department. Send the body fields below — required ones are marked; optional ones fall back to their defaults.", "operationId": "post_department", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "team_name": { "type": "string" }, "discord_webhook": { "type": "string" } }, "required": [ "team_name" ], "example": { "team_name": "Example", "discord_webhook": "string" } }, "example": { "team_name": "Example", "discord_webhook": "string" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Department" }, "meta": { "type": "object" } } }, "example": { "message": "Resource created successfully", "data": { "id": 1, "team_name": "Example" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/department/{department}": { "get": { "tags": [ "Departments" ], "summary": "Get a Department", "description": "Fetches a single department by its id, including its detail fields.", "operationId": "get_department_department", "parameters": [ { "name": "department", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The department (usually the numeric id)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Department" } } }, "example": { "data": { "id": 1, "team_name": "Example" } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "put": { "tags": [ "Departments" ], "summary": "Update a Department", "description": "Updates an existing department by its id. Send only the fields you want to change; everything else stays as-is.", "operationId": "put_department_department", "parameters": [ { "name": "department", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The department (usually the numeric id)." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "team_name": { "type": "string" }, "discord_webhook": { "type": "string" } }, "example": { "team_name": "Example", "discord_webhook": "string" } }, "example": { "team_name": "Example", "discord_webhook": "string" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Department" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "team_name": "Example" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "delete": { "tags": [ "Departments" ], "summary": "Delete a Department", "description": "Permanently deletes a department by its id. This cannot be undone.", "operationId": "delete_department_department", "parameters": [ { "name": "department", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The department (usually the numeric id)." } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "example": { "message": "Resource deleted successfully", "meta": { "time": 0.03 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/designation": { "get": { "tags": [ "Designations" ], "summary": "List Designations", "description": "Returns a paginated list of Designations in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_designation", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,name", "description": "Available fields: `id`, `name`. Comma-separated subset of the above to return, e.g. `id,name`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`, `team_name`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Designation" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "name": "Example" } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "post": { "tags": [ "Designations" ], "summary": "Create a Designation", "description": "Creates a new designation. Send the body fields below — required ones are marked; optional ones fall back to their defaults.", "operationId": "post_designation", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "parent_id": { "type": "integer", "description": "Numeric id of the related parent record." } }, "required": [ "name" ], "example": { "name": "Example", "parent_id": 1 } }, "example": { "name": "Example", "parent_id": 1 } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Designation" }, "meta": { "type": "object" } } }, "example": { "message": "Resource created successfully", "data": { "id": 1, "name": "Example" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/designation/{designation}": { "get": { "tags": [ "Designations" ], "summary": "Get a Designation", "description": "Fetches a single designation by its id, including its detail fields.", "operationId": "get_designation_designation", "parameters": [ { "name": "designation", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The designation (usually the numeric id)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Designation" } } }, "example": { "data": { "id": 1, "name": "Example" } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "put": { "tags": [ "Designations" ], "summary": "Update a Designation", "description": "Updates an existing designation by its id. Send only the fields you want to change; everything else stays as-is.", "operationId": "put_designation_designation", "parameters": [ { "name": "designation", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The designation (usually the numeric id)." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "parent_id": { "type": "integer", "description": "Numeric id of the related parent record." } }, "example": { "name": "Example", "parent_id": 1 } }, "example": { "name": "Example", "parent_id": 1 } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Designation" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "name": "Example" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "delete": { "tags": [ "Designations" ], "summary": "Delete a Designation", "description": "Permanently deletes a designation by its id. This cannot be undone.", "operationId": "delete_designation_designation", "parameters": [ { "name": "designation", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The designation (usually the numeric id)." } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "example": { "message": "Resource deleted successfully", "meta": { "time": 0.03 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/employee/last-employee-id": { "get": { "tags": [ "Employees" ], "summary": "Last Employee I D (Employee)", "description": "Performs the \"Last Employee I D\" action on a employee.", "operationId": "get_employee_last-employee-id", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Employee" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "name": "Example", "email": "name@example.com" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/employee/me": { "get": { "tags": [ "Employees" ], "summary": "Me (Employee)", "description": "Performs the \"Me\" action on a employee.", "operationId": "get_employee_me", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Employee" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "name": "Example", "email": "name@example.com" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/employee": { "get": { "tags": [ "Employees" ], "summary": "List Employees", "description": "Returns a paginated list of Employees in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_employee", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,name,email", "description": "Available fields: `id`, `name`, `email`. Comma-separated subset of the above to return, e.g. `id,name,email`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`, `users.name`, `status`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Employee" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "name": "Example", "email": "name@example.com" } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "post": { "tags": [ "Employees" ], "summary": "Create a Employee", "description": "Creates a new employee. Send the body fields below — required ones are marked; optional ones fall back to their defaults.", "operationId": "post_employee", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The employee's full name." }, "email": { "type": "string", "description": "Unique login email. The employee signs in with this address. Required because an account is created." }, "password": { "type": "string", "description": "Login password (min 6 chars). OPTIONAL — if you omit it, the system generates a secure password and emails the employee their login details. If you provide one, that password is set and emailed to them. Stored securely; never returned." }, "salutation": { "type": "string", "description": "Title.", "enum": [ "mr", "mrs", "miss", "dr", "sir", "madam" ] }, "gender": { "type": "string", "description": "Gender.", "enum": [ "male", "female", "others" ] }, "mobile": { "type": "string", "description": "Phone number, digits only." }, "country_id": { "type": "integer", "description": "Country id — see the Countries table in Reference data." }, "country_phonecode": { "type": "string", "description": "Dialing code, e.g. \"92\"." }, "locale": { "type": "string", "default": "en", "description": "Language code, e.g. \"en\". Default: \"en\"." }, "login": { "type": "string", "default": "enable", "description": "Whether the employee can log in. Default: \"enable\".", "enum": [ "enable", "disable" ] }, "rtl": { "type": "boolean", "default": false, "description": "Right-to-left UI. Optional. Default: false." }, "dark_theme": { "type": "boolean", "default": false, "description": "Dark mode UI. Optional. Default: false." }, "employee_detail": { "type": "object", "description": "Employment details. All fields are optional.", "properties": { "employee_id": { "type": "string", "description": "Unique employee code, e.g. \"EMP-001\" (optional)." }, "joining_date": { "type": "string", "description": "Joining date in YYYY-MM-DD format (optional; defaults to today)." }, "last_date": { "type": "string", "description": "Last working day, YYYY-MM-DD (optional)." }, "department": { "type": "object", "description": "Department / team (optional). Get ids via GET /department.", "properties": { "id": { "type": "integer", "description": "Department id." } } }, "designation": { "type": "object", "description": "Designation / job title (optional). Get ids via GET /designation.", "properties": { "id": { "type": "integer", "description": "Designation id." } } }, "reporting_to": { "type": "object", "description": "Reporting manager (optional). Get ids via GET /employee.", "properties": { "id": { "type": "integer", "description": "Manager employee id." } } }, "hourly_rate": { "type": "number", "description": "Hourly rate (optional)." }, "address": { "type": "string", "description": "Home address (optional)." }, "about_me": { "type": "string", "description": "Short bio (optional)." } } } }, "required": [ "name", "email" ], "example": { "name": "Jane Doe", "email": "jane@acme.com", "password": "S3curePass!", "gender": "female", "mobile": "3001234567", "employee_detail": { "employee_id": "EMP-001", "joining_date": "2026-01-15", "department": { "id": 1 }, "designation": { "id": 1 }, "hourly_rate": 25 } } }, "example": { "name": "Jane Doe", "email": "jane@acme.com", "password": "S3curePass!", "gender": "female", "mobile": "3001234567", "employee_detail": { "employee_id": "EMP-001", "joining_date": "2026-01-15", "department": { "id": 1 }, "designation": { "id": 1 }, "hourly_rate": 25 } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Employee" }, "meta": { "type": "object" } } }, "example": { "message": "Resource created successfully", "data": { "id": 1, "name": "Example", "email": "name@example.com" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/employee/{employee}": { "get": { "tags": [ "Employees" ], "summary": "Get a Employee", "description": "Fetches a single employee by its id, including its detail fields.", "operationId": "get_employee_employee", "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The employee (usually the numeric id)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Employee" } } }, "example": { "data": { "id": 1, "name": "Example", "email": "name@example.com" } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "put": { "tags": [ "Employees" ], "summary": "Update a Employee", "description": "Updates an existing employee by its id. Send only the fields you want to change; everything else stays as-is.", "operationId": "put_employee_employee", "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The employee (usually the numeric id)." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The employee's full name." }, "email": { "type": "string", "description": "Unique login email. The employee signs in with this address. Required because an account is created." }, "password": { "type": "string", "description": "Login password (min 6 chars). OPTIONAL — if you omit it, the system generates a secure password and emails the employee their login details. If you provide one, that password is set and emailed to them. Stored securely; never returned." }, "salutation": { "type": "string", "description": "Title.", "enum": [ "mr", "mrs", "miss", "dr", "sir", "madam" ] }, "gender": { "type": "string", "description": "Gender.", "enum": [ "male", "female", "others" ] }, "mobile": { "type": "string", "description": "Phone number, digits only." }, "country_id": { "type": "integer", "description": "Country id — see the Countries table in Reference data." }, "country_phonecode": { "type": "string", "description": "Dialing code, e.g. \"92\"." }, "locale": { "type": "string", "default": "en", "description": "Language code, e.g. \"en\". Default: \"en\"." }, "login": { "type": "string", "default": "enable", "description": "Whether the employee can log in. Default: \"enable\".", "enum": [ "enable", "disable" ] }, "rtl": { "type": "boolean", "default": false, "description": "Right-to-left UI. Optional. Default: false." }, "dark_theme": { "type": "boolean", "default": false, "description": "Dark mode UI. Optional. Default: false." }, "employee_detail": { "type": "object", "description": "Employment details. All fields are optional.", "properties": { "employee_id": { "type": "string", "description": "Unique employee code, e.g. \"EMP-001\" (optional)." }, "joining_date": { "type": "string", "description": "Joining date in YYYY-MM-DD format (optional; defaults to today)." }, "last_date": { "type": "string", "description": "Last working day, YYYY-MM-DD (optional)." }, "department": { "type": "object", "description": "Department / team (optional). Get ids via GET /department.", "properties": { "id": { "type": "integer", "description": "Department id." } } }, "designation": { "type": "object", "description": "Designation / job title (optional). Get ids via GET /designation.", "properties": { "id": { "type": "integer", "description": "Designation id." } } }, "reporting_to": { "type": "object", "description": "Reporting manager (optional). Get ids via GET /employee.", "properties": { "id": { "type": "integer", "description": "Manager employee id." } } }, "hourly_rate": { "type": "number", "description": "Hourly rate (optional)." }, "address": { "type": "string", "description": "Home address (optional)." }, "about_me": { "type": "string", "description": "Short bio (optional)." } } } }, "example": { "name": "Jane Doe (Senior)", "employee_detail": { "designation": { "id": 2 } } } }, "example": { "name": "Jane Doe (Senior)", "employee_detail": { "designation": { "id": 2 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Employee" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "name": "Example", "email": "name@example.com" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "delete": { "tags": [ "Employees" ], "summary": "Delete a Employee", "description": "Permanently deletes a employee by its id. This cannot be undone.", "operationId": "delete_employee_employee", "parameters": [ { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The employee (usually the numeric id)." } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "example": { "message": "Resource deleted successfully", "meta": { "time": 0.03 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/estimate/send/{id}": { "get": { "tags": [ "Estimates" ], "summary": "Send Estimate (Estimate)", "description": "Performs the \"Send Estimate\" action on a estimate.", "operationId": "get_estimate_send_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id (usually the numeric id)." } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Estimate" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "estimate_number": "string", "total": 100, "status": "declined", "valid_till": "2026-01-31", "hash": "string", "pdf_download_url": "https://example.com" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/estimate": { "get": { "tags": [ "Estimates" ], "summary": "List Estimates", "description": "Returns a paginated list of Estimates in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_estimate", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,estimate_number,total", "description": "Available fields: `id`, `estimate_number`, `total`, `status`, `valid_till`, `hash`, `pdf_download_url`. Comma-separated subset of the above to return, e.g. `id,estimate_number,total`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`, `status`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Estimate" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "estimate_number": "string", "total": 100, "status": "declined", "valid_till": "2026-01-31", "hash": "string", "pdf_download_url": "https://example.com" } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "post": { "tags": [ "Estimates" ], "summary": "Create a Estimate", "description": "Creates a new estimate. Send the body fields below — required ones are marked; optional ones fall back to their defaults.", "operationId": "post_estimate", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contact_id": { "type": "integer", "description": "Contact the estimate is for. Get ids via GET /contact." }, "valid_till": { "type": "string", "description": "Date the estimate is valid until, YYYY-MM-DD." }, "currency_id": { "type": "integer", "description": "Currency id. Get ids via GET /currency." }, "sub_total": { "type": "number", "description": "Sum before tax/discount." }, "total": { "type": "number", "description": "Final estimate total." }, "discount": { "type": "number", "description": "Discount amount/percent (optional)." }, "discount_type": { "type": "string", "description": "How \"discount\" is applied.", "enum": [ "percent", "fixed" ] } }, "required": [ "contact_id", "valid_till", "currency_id", "sub_total", "total" ], "example": { "contact_id": 1, "valid_till": "2026-07-01", "currency_id": 1, "sub_total": 100, "total": 100 } }, "example": { "contact_id": 1, "valid_till": "2026-07-01", "currency_id": 1, "sub_total": 100, "total": 100 } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Estimate" }, "meta": { "type": "object" } } }, "example": { "message": "Resource created successfully", "data": { "id": 1, "estimate_number": "string", "total": 100, "status": "declined", "valid_till": "2026-01-31", "hash": "string", "pdf_download_url": "https://example.com" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/estimate/{estimate}": { "get": { "tags": [ "Estimates" ], "summary": "Get a Estimate", "description": "Fetches a single estimate by its id, including its detail fields.", "operationId": "get_estimate_estimate", "parameters": [ { "name": "estimate", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The estimate (usually the numeric id)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Estimate" } } }, "example": { "data": { "id": 1, "estimate_number": "string", "total": 100, "status": "declined", "valid_till": "2026-01-31", "hash": "string", "pdf_download_url": "https://example.com" } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "put": { "tags": [ "Estimates" ], "summary": "Update a Estimate", "description": "Updates an existing estimate by its id. Send only the fields you want to change; everything else stays as-is.", "operationId": "put_estimate_estimate", "parameters": [ { "name": "estimate", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The estimate (usually the numeric id)." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "contact_id": { "type": "integer", "description": "Contact the estimate is for. Get ids via GET /contact." }, "valid_till": { "type": "string", "description": "Date the estimate is valid until, YYYY-MM-DD." }, "currency_id": { "type": "integer", "description": "Currency id. Get ids via GET /currency." }, "sub_total": { "type": "number", "description": "Sum before tax/discount." }, "total": { "type": "number", "description": "Final estimate total." }, "discount": { "type": "number", "description": "Discount amount/percent (optional)." }, "discount_type": { "type": "string", "description": "How \"discount\" is applied.", "enum": [ "percent", "fixed" ] } }, "example": { "contact_id": 1, "valid_till": "2026-07-01", "currency_id": 1, "sub_total": 100, "total": 100 } }, "example": { "contact_id": 1, "valid_till": "2026-07-01", "currency_id": 1, "sub_total": 100, "total": 100 } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Estimate" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "estimate_number": "string", "total": 100, "status": "declined", "valid_till": "2026-01-31", "hash": "string", "pdf_download_url": "https://example.com" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "delete": { "tags": [ "Estimates" ], "summary": "Delete a Estimate", "description": "Permanently deletes a estimate by its id. This cannot be undone.", "operationId": "delete_estimate_estimate", "parameters": [ { "name": "estimate", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The estimate (usually the numeric id)." } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "example": { "message": "Resource deleted successfully", "meta": { "time": 0.03 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/event": { "get": { "tags": [ "Events" ], "summary": "List Events", "description": "Returns a paginated list of Events in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_event", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id", "description": "Available fields: `id`. Comma-separated subset of the above to return, e.g. `id`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Event" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1 } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "post": { "tags": [ "Events" ], "summary": "Create a Event", "description": "Creates a new event. Send the body fields below — required ones are marked; optional ones fall back to their defaults.", "operationId": "post_event", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "start_date_time": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." }, "end_date_time": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." }, "event_name": { "type": "string" }, "where": { "type": "string" }, "description": { "type": "string" } }, "required": [ "start_date_time", "end_date_time", "event_name", "where", "description" ], "example": { "start_date_time": "2026-01-31 09:00:00", "end_date_time": "2026-01-31 09:00:00", "event_name": "Example", "where": "string", "description": "string" } }, "example": { "start_date_time": "2026-01-31 09:00:00", "end_date_time": "2026-01-31 09:00:00", "event_name": "Example", "where": "string", "description": "string" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Event" }, "meta": { "type": "object" } } }, "example": { "message": "Resource created successfully", "data": { "id": 1 }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/event/{event}": { "get": { "tags": [ "Events" ], "summary": "Get a Event", "description": "Fetches a single event by its id, including its detail fields.", "operationId": "get_event_event", "parameters": [ { "name": "event", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The event (usually the numeric id)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Event" } } }, "example": { "data": { "id": 1 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "put": { "tags": [ "Events" ], "summary": "Update a Event", "description": "Updates an existing event by its id. Send only the fields you want to change; everything else stays as-is.", "operationId": "put_event_event", "parameters": [ { "name": "event", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The event (usually the numeric id)." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "start_date_time": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." }, "end_date_time": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." }, "event_name": { "type": "string" }, "where": { "type": "string" }, "description": { "type": "string" } }, "example": { "start_date_time": "2026-01-31 09:00:00", "end_date_time": "2026-01-31 09:00:00", "event_name": "Example", "where": "string", "description": "string" } }, "example": { "start_date_time": "2026-01-31 09:00:00", "end_date_time": "2026-01-31 09:00:00", "event_name": "Example", "where": "string", "description": "string" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Event" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1 }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "delete": { "tags": [ "Events" ], "summary": "Delete a Event", "description": "Permanently deletes a event by its id. This cannot be undone.", "operationId": "delete_event_event", "parameters": [ { "name": "event", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The event (usually the numeric id)." } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "example": { "message": "Resource deleted successfully", "meta": { "time": 0.03 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/me/calendar": { "get": { "tags": [ "Events" ], "summary": "Me (Event)", "description": "Performs the \"Me\" action on a event.", "operationId": "get_me_calendar", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Event" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1 }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/expense": { "get": { "tags": [ "Expenses" ], "summary": "List Expenses", "description": "Returns a paginated list of Expenses in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_expense", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,item_name,purchase_date", "description": "Available fields: `id`, `item_name`, `purchase_date`, `price`, `status`. Comma-separated subset of the above to return, e.g. `id,item_name,purchase_date`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`, `item_name`, `status`, `project_id`, `user_id`, `employee_name`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Expense" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "item_name": "Example", "purchase_date": "2026-01-31", "price": 100, "status": "pending" } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "post": { "tags": [ "Expenses" ], "summary": "Create a Expense", "description": "Creates a new expense. Send the body fields below — required ones are marked; optional ones fall back to their defaults.", "operationId": "post_expense", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "item_name": { "type": "string" }, "purchase_date": { "type": "string", "format": "date", "description": "Date in YYYY-MM-DD format." }, "purchase_from": { "type": "string" }, "price": { "type": "number" }, "currency_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /currency." }, "default_currency_id": { "type": "integer", "description": "Numeric id of the related default_currency record." }, "exchange_rate": { "type": "number" }, "project_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /project." }, "bill": { "type": "string" }, "user_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /employee." }, "status": { "type": "string", "enum": [ "pending", "approved", "rejected" ], "default": "pending", "description": "One of: \"pending\", \"approved\", \"rejected\". Defaults to \"pending\" if omitted." }, "can_claim": { "type": "boolean", "default": true, "description": "Yes/No flag — true or false (also accepts 1 or 0). Defaults to true if omitted." }, "category_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /contact-category." }, "expenses_recurring_id": { "type": "integer", "description": "Numeric id of the related expenses_recurring record." }, "created_by": { "type": "integer" }, "description": { "type": "string" }, "approver_id": { "type": "integer", "description": "Numeric id of the related approver record." }, "bank_account_id": { "type": "integer", "description": "Numeric id of the related bank_account record." } }, "required": [ "item_name", "purchase_date", "currency_id" ], "example": { "item_name": "Example", "purchase_date": "2026-01-31", "purchase_from": "string", "price": 100, "currency_id": 1, "default_currency_id": 1, "exchange_rate": 100, "project_id": 1, "bill": "string", "user_id": 1, "status": "pending", "can_claim": true, "category_id": 1, "expenses_recurring_id": 1, "created_by": 10, "description": "string", "approver_id": 1, "bank_account_id": 1 } }, "example": { "item_name": "Example", "purchase_date": "2026-01-31", "purchase_from": "string", "price": 100, "currency_id": 1, "default_currency_id": 1, "exchange_rate": 100, "project_id": 1, "bill": "string", "user_id": 1, "status": "pending", "can_claim": true, "category_id": 1, "expenses_recurring_id": 1, "created_by": 10, "description": "string", "approver_id": 1, "bank_account_id": 1 } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Expense" }, "meta": { "type": "object" } } }, "example": { "message": "Resource created successfully", "data": { "id": 1, "item_name": "Example", "purchase_date": "2026-01-31", "price": 100, "status": "pending" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/expense/{expense}": { "get": { "tags": [ "Expenses" ], "summary": "Get a Expense", "description": "Fetches a single expense by its id, including its detail fields.", "operationId": "get_expense_expense", "parameters": [ { "name": "expense", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The expense (usually the numeric id)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Expense" } } }, "example": { "data": { "id": 1, "item_name": "Example", "purchase_date": "2026-01-31", "price": 100, "status": "pending" } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "put": { "tags": [ "Expenses" ], "summary": "Update a Expense", "description": "Updates an existing expense by its id. Send only the fields you want to change; everything else stays as-is.", "operationId": "put_expense_expense", "parameters": [ { "name": "expense", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The expense (usually the numeric id)." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "item_name": { "type": "string" }, "purchase_date": { "type": "string", "format": "date", "description": "Date in YYYY-MM-DD format." }, "purchase_from": { "type": "string" }, "price": { "type": "number" }, "currency_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /currency." }, "default_currency_id": { "type": "integer", "description": "Numeric id of the related default_currency record." }, "exchange_rate": { "type": "number" }, "project_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /project." }, "bill": { "type": "string" }, "user_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /employee." }, "status": { "type": "string", "enum": [ "pending", "approved", "rejected" ], "default": "pending", "description": "One of: \"pending\", \"approved\", \"rejected\". Defaults to \"pending\" if omitted." }, "can_claim": { "type": "boolean", "default": true, "description": "Yes/No flag — true or false (also accepts 1 or 0). Defaults to true if omitted." }, "category_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /contact-category." }, "expenses_recurring_id": { "type": "integer", "description": "Numeric id of the related expenses_recurring record." }, "created_by": { "type": "integer" }, "description": { "type": "string" }, "approver_id": { "type": "integer", "description": "Numeric id of the related approver record." }, "bank_account_id": { "type": "integer", "description": "Numeric id of the related bank_account record." } }, "example": { "item_name": "Example", "purchase_date": "2026-01-31", "purchase_from": "string", "price": 100, "currency_id": 1, "default_currency_id": 1, "exchange_rate": 100, "project_id": 1, "bill": "string", "user_id": 1, "status": "pending", "can_claim": true, "category_id": 1, "expenses_recurring_id": 1, "created_by": 10, "description": "string", "approver_id": 1, "bank_account_id": 1 } }, "example": { "item_name": "Example", "purchase_date": "2026-01-31", "purchase_from": "string", "price": 100, "currency_id": 1, "default_currency_id": 1, "exchange_rate": 100, "project_id": 1, "bill": "string", "user_id": 1, "status": "pending", "can_claim": true, "category_id": 1, "expenses_recurring_id": 1, "created_by": 10, "description": "string", "approver_id": 1, "bank_account_id": 1 } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Expense" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "item_name": "Example", "purchase_date": "2026-01-31", "price": 100, "status": "pending" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "delete": { "tags": [ "Expenses" ], "summary": "Delete a Expense", "description": "Permanently deletes a expense by its id. This cannot be undone.", "operationId": "delete_expense_expense", "parameters": [ { "name": "expense", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The expense (usually the numeric id)." } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "example": { "message": "Resource deleted successfully", "meta": { "time": 0.03 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/file/{name}": { "get": { "tags": [ "Files" ], "summary": "Get a File", "description": "Fetches a single file by its id, including its detail fields.", "operationId": "get_file_name", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The name (usually the numeric id)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/File" } } }, "example": { "data": { "id": 1, "filename": "Example", "task_id": 1, "user_id": 1, "created_at": "2026-01-31 09:00:00" } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/file": { "post": { "tags": [ "Files" ], "summary": "Create a File", "description": "Creates a new file. Send the body fields below — required ones are marked; optional ones fall back to their defaults.", "operationId": "post_file", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "user_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /employee." }, "task_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /task." }, "filename": { "type": "string" }, "description": { "type": "string" }, "google_url": { "type": "string" }, "hashname": { "type": "string" }, "size": { "type": "string" }, "dropbox_link": { "type": "string" }, "external_link": { "type": "string" }, "external_link_name": { "type": "string" } }, "required": [ "user_id", "task_id", "filename" ], "example": { "user_id": 1, "task_id": 1, "filename": "Example", "description": "string", "google_url": "https://example.com", "hashname": "Example", "size": "string", "dropbox_link": "string", "external_link": "string", "external_link_name": "Example" } }, "example": { "user_id": 1, "task_id": 1, "filename": "Example", "description": "string", "google_url": "https://example.com", "hashname": "Example", "size": "string", "dropbox_link": "string", "external_link": "string", "external_link_name": "Example" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/File" }, "meta": { "type": "object" } } }, "example": { "message": "Resource created successfully", "data": { "id": 1, "filename": "Example", "task_id": 1, "user_id": 1, "created_at": "2026-01-31 09:00:00" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/task/{task_id}/file": { "get": { "tags": [ "Files" ], "summary": "List Files", "description": "Returns a paginated list of Files in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_task_task_id_file", "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The task id (usually the numeric id)." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,filename,task_id", "description": "Available fields: `id`, `filename`, `task_id`, `user_id`, `created_at`. Comma-separated subset of the above to return, e.g. `id,filename,task_id`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`, `task_id`, `user_id`, `created_at`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/File" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "filename": "Example", "task_id": 1, "user_id": 1, "created_at": "2026-01-31 09:00:00" } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "post": { "tags": [ "Files" ], "summary": "Create a File", "description": "Creates a new file. Send the body fields below — required ones are marked; optional ones fall back to their defaults.", "operationId": "post_task_task_id_file", "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The task id (usually the numeric id)." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "user_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /employee." }, "task_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /task." }, "filename": { "type": "string" }, "description": { "type": "string" }, "google_url": { "type": "string" }, "hashname": { "type": "string" }, "size": { "type": "string" }, "dropbox_link": { "type": "string" }, "external_link": { "type": "string" }, "external_link_name": { "type": "string" } }, "required": [ "user_id", "task_id", "filename" ], "example": { "user_id": 1, "task_id": 1, "filename": "Example", "description": "string", "google_url": "https://example.com", "hashname": "Example", "size": "string", "dropbox_link": "string", "external_link": "string", "external_link_name": "Example" } }, "example": { "user_id": 1, "task_id": 1, "filename": "Example", "description": "string", "google_url": "https://example.com", "hashname": "Example", "size": "string", "dropbox_link": "string", "external_link": "string", "external_link_name": "Example" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/File" }, "meta": { "type": "object" } } }, "example": { "message": "Resource created successfully", "data": { "id": 1, "filename": "Example", "task_id": 1, "user_id": 1, "created_at": "2026-01-31 09:00:00" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/task/{task_id}/file/{file}": { "put": { "tags": [ "Files" ], "summary": "Update a File", "description": "Updates an existing file by its id. Send only the fields you want to change; everything else stays as-is.", "operationId": "put_task_task_id_file_file", "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The task id (usually the numeric id)." }, { "name": "file", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The file (usually the numeric id)." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "user_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /employee." }, "task_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /task." }, "filename": { "type": "string" }, "description": { "type": "string" }, "google_url": { "type": "string" }, "hashname": { "type": "string" }, "size": { "type": "string" }, "dropbox_link": { "type": "string" }, "external_link": { "type": "string" }, "external_link_name": { "type": "string" } }, "example": { "user_id": 1, "task_id": 1, "filename": "Example", "description": "string", "google_url": "https://example.com", "hashname": "Example", "size": "string", "dropbox_link": "string", "external_link": "string", "external_link_name": "Example" } }, "example": { "user_id": 1, "task_id": 1, "filename": "Example", "description": "string", "google_url": "https://example.com", "hashname": "Example", "size": "string", "dropbox_link": "string", "external_link": "string", "external_link_name": "Example" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/File" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "filename": "Example", "task_id": 1, "user_id": 1, "created_at": "2026-01-31 09:00:00" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "delete": { "tags": [ "Files" ], "summary": "Delete a File", "description": "Permanently deletes a file by its id. This cannot be undone.", "operationId": "delete_task_task_id_file_file", "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The task id (usually the numeric id)." }, { "name": "file", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The file (usually the numeric id)." } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "example": { "message": "Resource deleted successfully", "meta": { "time": 0.03 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/holiday": { "get": { "tags": [ "Holidays" ], "summary": "List Holidays", "description": "Returns a paginated list of Holidays in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_holiday", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,date,occassion", "description": "Available fields: `id`, `date`, `occassion`. Comma-separated subset of the above to return, e.g. `id,date,occassion`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`, `date`, `occassion`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Holiday" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "date": "2026-01-31", "occassion": "string" } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "post": { "tags": [ "Holidays" ], "summary": "Create a Holiday", "description": "Creates a new holiday. Send the body fields below — required ones are marked; optional ones fall back to their defaults.", "operationId": "post_holiday", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date", "description": "Date in YYYY-MM-DD format." }, "occassion": { "type": "string" } }, "required": [ "date" ], "example": { "date": "2026-01-31", "occassion": "string" } }, "example": { "date": "2026-01-31", "occassion": "string" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Holiday" }, "meta": { "type": "object" } } }, "example": { "message": "Resource created successfully", "data": { "id": 1, "date": "2026-01-31", "occassion": "string" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/holiday/{holiday}": { "get": { "tags": [ "Holidays" ], "summary": "Get a Holiday", "description": "Fetches a single holiday by its id, including its detail fields.", "operationId": "get_holiday_holiday", "parameters": [ { "name": "holiday", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The holiday (usually the numeric id)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Holiday" } } }, "example": { "data": { "id": 1, "date": "2026-01-31", "occassion": "string" } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "put": { "tags": [ "Holidays" ], "summary": "Update a Holiday", "description": "Updates an existing holiday by its id. Send only the fields you want to change; everything else stays as-is.", "operationId": "put_holiday_holiday", "parameters": [ { "name": "holiday", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The holiday (usually the numeric id)." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date", "description": "Date in YYYY-MM-DD format." }, "occassion": { "type": "string" } }, "example": { "date": "2026-01-31", "occassion": "string" } }, "example": { "date": "2026-01-31", "occassion": "string" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Holiday" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "date": "2026-01-31", "occassion": "string" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "delete": { "tags": [ "Holidays" ], "summary": "Delete a Holiday", "description": "Permanently deletes a holiday by its id. This cannot be undone.", "operationId": "delete_holiday_holiday", "parameters": [ { "name": "holiday", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The holiday (usually the numeric id)." } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "example": { "message": "Resource deleted successfully", "meta": { "time": 0.03 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/invoice/send/{id}": { "get": { "tags": [ "Invoices" ], "summary": "Send Invoice (Invoice)", "description": "Performs the \"Send Invoice\" action on a invoice.", "operationId": "get_invoice_send_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id (usually the numeric id)." } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Invoice" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "invoice_number": "string", "total": 100, "status": "paid", "issue_date": "2026-01-31", "company_id": 1, "pdf_download_url": "https://example.com" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/invoice/payment-reminder/{id}": { "get": { "tags": [ "Invoices" ], "summary": "Remind For Payment (Invoice)", "description": "Performs the \"Remind For Payment\" action on a invoice.", "operationId": "get_invoice_payment-reminder_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id (usually the numeric id)." } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Invoice" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "invoice_number": "string", "total": 100, "status": "paid", "issue_date": "2026-01-31", "company_id": 1, "pdf_download_url": "https://example.com" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/invoice": { "get": { "tags": [ "Invoices" ], "summary": "List Invoices", "description": "Returns a paginated list of Invoices in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_invoice", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,invoice_number,total", "description": "Available fields: `id`, `invoice_number`, `total`, `status`, `issue_date`, `company_id`, `pdf_download_url`. Comma-separated subset of the above to return, e.g. `id,invoice_number,total`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`, `status`, `invoice_number`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "invoice_number": "string", "total": 100, "status": "paid", "issue_date": "2026-01-31", "company_id": 1, "pdf_download_url": "https://example.com" } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "post": { "tags": [ "Invoices" ], "summary": "Create a Invoice", "description": "Creates a new invoice. Send the body fields below — required ones are marked; optional ones fall back to their defaults.", "operationId": "post_invoice", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "invoice_number": { "type": "string", "description": "Unique invoice number, e.g. \"INV-001\"." }, "contact_id": { "type": "integer", "description": "Contact being billed (required unless project_id is given). Get ids via GET /contact." }, "project_id": { "type": "integer", "description": "Project to bill instead of a contact (optional). Get ids via GET /project." }, "issue_date": { "type": "string", "description": "Issue date, YYYY-MM-DD." }, "due_date": { "type": "string", "description": "Payment due date, YYYY-MM-DD." }, "currency_id": { "type": "integer", "description": "Currency id. Get ids via GET /currency." }, "sub_total": { "type": "number", "description": "Sum of line items before tax/discount." }, "total": { "type": "number", "description": "Final amount payable." }, "discount": { "type": "number", "description": "Discount amount or percent (see discount_type)." }, "discount_type": { "type": "string", "description": "How \"discount\" is applied.", "enum": [ "percent", "fixed" ] }, "recurring": { "type": "string", "default": "no", "description": "Whether this is a recurring invoice. If \"yes\", also send billing_frequency, billing_interval, billing_cycle. Default: \"no\".", "enum": [ "yes", "no" ] }, "note": { "type": "string", "description": "Note shown on the invoice (optional)." } }, "required": [ "invoice_number", "contact_id", "issue_date", "due_date", "currency_id", "sub_total", "total" ], "example": { "invoice_number": "INV-001", "contact_id": 1, "issue_date": "2026-06-01", "due_date": "2026-06-15", "currency_id": 1, "sub_total": 100, "total": 100 } }, "example": { "invoice_number": "INV-001", "contact_id": 1, "issue_date": "2026-06-01", "due_date": "2026-06-15", "currency_id": 1, "sub_total": 100, "total": 100 } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Invoice" }, "meta": { "type": "object" } } }, "example": { "message": "Resource created successfully", "data": { "id": 1, "invoice_number": "string", "total": 100, "status": "paid", "issue_date": "2026-01-31", "company_id": 1, "pdf_download_url": "https://example.com" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/invoice/{invoice}": { "get": { "tags": [ "Invoices" ], "summary": "Get a Invoice", "description": "Fetches a single invoice by its id, including its detail fields.", "operationId": "get_invoice_invoice", "parameters": [ { "name": "invoice", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The invoice (usually the numeric id)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Invoice" } } }, "example": { "data": { "id": 1, "invoice_number": "string", "total": 100, "status": "paid", "issue_date": "2026-01-31", "company_id": 1, "pdf_download_url": "https://example.com" } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "put": { "tags": [ "Invoices" ], "summary": "Update a Invoice", "description": "Updates an existing invoice by its id. Send only the fields you want to change; everything else stays as-is.", "operationId": "put_invoice_invoice", "parameters": [ { "name": "invoice", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The invoice (usually the numeric id)." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "invoice_number": { "type": "string", "description": "Unique invoice number, e.g. \"INV-001\"." }, "contact_id": { "type": "integer", "description": "Contact being billed (required unless project_id is given). Get ids via GET /contact." }, "project_id": { "type": "integer", "description": "Project to bill instead of a contact (optional). Get ids via GET /project." }, "issue_date": { "type": "string", "description": "Issue date, YYYY-MM-DD." }, "due_date": { "type": "string", "description": "Payment due date, YYYY-MM-DD." }, "currency_id": { "type": "integer", "description": "Currency id. Get ids via GET /currency." }, "sub_total": { "type": "number", "description": "Sum of line items before tax/discount." }, "total": { "type": "number", "description": "Final amount payable." }, "discount": { "type": "number", "description": "Discount amount or percent (see discount_type)." }, "discount_type": { "type": "string", "description": "How \"discount\" is applied.", "enum": [ "percent", "fixed" ] }, "recurring": { "type": "string", "default": "no", "description": "Whether this is a recurring invoice. If \"yes\", also send billing_frequency, billing_interval, billing_cycle. Default: \"no\".", "enum": [ "yes", "no" ] }, "note": { "type": "string", "description": "Note shown on the invoice (optional)." } }, "example": { "invoice_number": "INV-001", "contact_id": 1, "issue_date": "2026-06-01", "due_date": "2026-06-15", "currency_id": 1, "sub_total": 100, "total": 100 } }, "example": { "invoice_number": "INV-001", "contact_id": 1, "issue_date": "2026-06-01", "due_date": "2026-06-15", "currency_id": 1, "sub_total": 100, "total": 100 } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Invoice" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "invoice_number": "string", "total": 100, "status": "paid", "issue_date": "2026-01-31", "company_id": 1, "pdf_download_url": "https://example.com" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "delete": { "tags": [ "Invoices" ], "summary": "Delete a Invoice", "description": "Permanently deletes a invoice by its id. This cannot be undone.", "operationId": "delete_invoice_invoice", "parameters": [ { "name": "invoice", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The invoice (usually the numeric id)." } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "example": { "message": "Resource deleted successfully", "meta": { "time": 0.03 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/leave/by-date": { "get": { "tags": [ "Leaves" ], "summary": "By Date (Leaf)", "description": "Performs the \"By Date\" action on a leaf.", "operationId": "get_leave_by-date", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Leave" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "leave_type_id": 1, "leave_date": "2026-01-31", "reason": "string", "status": "approved" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/leave/leave-multiple": { "post": { "tags": [ "Leaves" ], "summary": "Multi Dates Leave Apply (Leaf)", "description": "Performs the \"Multi Dates Leave Apply\" action on a leaf.", "operationId": "post_leave_leave-multiple", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Leave" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "leave_type_id": 1, "leave_date": "2026-01-31", "reason": "string", "status": "approved" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/leave": { "get": { "tags": [ "Leaves" ], "summary": "List Leaves", "description": "Returns a paginated list of Leaves in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_leave", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,leave_type_id,leave_date", "description": "Available fields: `id`, `leave_type_id`, `leave_date`, `reason`, `status`. Comma-separated subset of the above to return, e.g. `id,leave_type_id,leave_date`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`, `status`, `user_id`, `leave_type_id`, `employee_name`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Leave" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "leave_type_id": 1, "leave_date": "2026-01-31", "reason": "string", "status": "approved" } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "post": { "tags": [ "Leaves" ], "summary": "Create a Leaf", "description": "Creates a new leaf. Send the body fields below — required ones are marked; optional ones fall back to their defaults.", "operationId": "post_leave", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "type": "object", "description": "Employee taking leave. Get ids via GET /employee.", "properties": { "id": { "type": "integer", "description": "Employee user id." } }, "required": [ "id" ] }, "type": { "type": "object", "description": "Leave type. Get ids via GET /leave-type.", "properties": { "id": { "type": "integer", "description": "Leave type id." } }, "required": [ "id" ] }, "leave_date": { "type": "string", "description": "The date of leave, YYYY-MM-DD." }, "duration": { "type": "string", "description": "Length of the leave for that day.", "enum": [ "full day", "half day" ] }, "reason": { "type": "string", "description": "Reason for the leave." }, "status": { "type": "string", "description": "Approval status. Admins can set \"approved\" directly.", "enum": [ "pending", "approved", "rejected" ] } }, "required": [ "user", "type", "leave_date", "duration", "reason", "status" ], "example": { "user": { "id": 1 }, "type": { "id": 1 }, "leave_date": "2026-06-25", "duration": "full day", "reason": "Family event", "status": "pending" } }, "example": { "user": { "id": 1 }, "type": { "id": 1 }, "leave_date": "2026-06-25", "duration": "full day", "reason": "Family event", "status": "pending" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Leave" }, "meta": { "type": "object" } } }, "example": { "message": "Resource created successfully", "data": { "id": 1, "leave_type_id": 1, "leave_date": "2026-01-31", "reason": "string", "status": "approved" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/leave/{leave}": { "get": { "tags": [ "Leaves" ], "summary": "Get a Leaf", "description": "Fetches a single leaf by its id, including its detail fields.", "operationId": "get_leave_leave", "parameters": [ { "name": "leave", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The leave (usually the numeric id)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Leave" } } }, "example": { "data": { "id": 1, "leave_type_id": 1, "leave_date": "2026-01-31", "reason": "string", "status": "approved" } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "put": { "tags": [ "Leaves" ], "summary": "Update a Leaf", "description": "Updates an existing leaf by its id. Send only the fields you want to change; everything else stays as-is.", "operationId": "put_leave_leave", "parameters": [ { "name": "leave", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The leave (usually the numeric id)." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "type": "object", "description": "Employee taking leave. Get ids via GET /employee.", "properties": { "id": { "type": "integer", "description": "Employee user id." } }, "required": [ "id" ] }, "type": { "type": "object", "description": "Leave type. Get ids via GET /leave-type.", "properties": { "id": { "type": "integer", "description": "Leave type id." } }, "required": [ "id" ] }, "leave_date": { "type": "string", "description": "The date of leave, YYYY-MM-DD." }, "duration": { "type": "string", "description": "Length of the leave for that day.", "enum": [ "full day", "half day" ] }, "reason": { "type": "string", "description": "Reason for the leave." }, "status": { "type": "string", "description": "Approval status. Admins can set \"approved\" directly.", "enum": [ "pending", "approved", "rejected" ] } }, "example": { "user": { "id": 1 }, "type": { "id": 1 }, "leave_date": "2026-06-25", "duration": "full day", "reason": "Family event", "status": "pending" } }, "example": { "user": { "id": 1 }, "type": { "id": 1 }, "leave_date": "2026-06-25", "duration": "full day", "reason": "Family event", "status": "pending" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Leave" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "leave_type_id": 1, "leave_date": "2026-01-31", "reason": "string", "status": "approved" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "delete": { "tags": [ "Leaves" ], "summary": "Delete a Leaf", "description": "Permanently deletes a leaf by its id. This cannot be undone.", "operationId": "delete_leave_leave", "parameters": [ { "name": "leave", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The leave (usually the numeric id)." } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "example": { "message": "Resource deleted successfully", "meta": { "time": 0.03 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/leave/apply": { "post": { "tags": [ "Leaves" ], "summary": "Apply (Leaf)", "description": "Performs the \"Apply\" action on a leaf.", "operationId": "post_leave_apply", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Leave" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "leave_type_id": 1, "leave_date": "2026-01-31", "reason": "string", "status": "approved" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/leave-type": { "get": { "tags": [ "Leave Types" ], "summary": "List Leave Types", "description": "Returns a paginated list of Leave Types in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_leave-type", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,type_name,company_id", "description": "Available fields: `id`, `type_name`, `company_id`. Comma-separated subset of the above to return, e.g. `id,type_name,company_id`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`, `type_name`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/LeaveType" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "type_name": "Example", "company_id": 1 } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "post": { "tags": [ "Leave Types" ], "summary": "Create a Leave Type", "description": "Creates a new leave type. Send the body fields below — required ones are marked; optional ones fall back to their defaults.", "operationId": "post_leave-type", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type_name": { "type": "string" }, "color": { "type": "string" }, "no_of_leaves": { "type": "number", "default": 5, "description": "Defaults to 5 if omitted." }, "paid": { "type": "boolean", "default": true, "description": "Yes/No flag — true or false (also accepts 1 or 0). Defaults to true if omitted." }, "monthly_limit": { "type": "number", "default": 0, "description": "Defaults to 0 if omitted." }, "effective_after": { "type": "integer" }, "effective_type": { "type": "string" }, "unused_leave": { "type": "string" }, "encashed": { "type": "boolean", "description": "Yes/No flag — true or false (also accepts 1 or 0)." }, "allowed_probation": { "type": "boolean", "description": "Yes/No flag — true or false (also accepts 1 or 0)." }, "allowed_notice": { "type": "boolean", "description": "Yes/No flag — true or false (also accepts 1 or 0)." }, "gender": { "type": "string" }, "marital_status": { "type": "string" }, "department": { "type": "string" }, "designation": { "type": "string" }, "role": { "type": "string" }, "leavetype": { "type": "string", "enum": [ "monthly", "yearly" ], "description": "One of: \"monthly\", \"yearly\"." }, "over_utilization": { "type": "string", "enum": [ "not_allowed", "allow_paid", "allow_unpaid" ], "default": "not_allowed", "description": "One of: \"not_allowed\", \"allow_paid\", \"allow_unpaid\". Defaults to \"not_allowed\" if omitted." } }, "required": [ "type_name", "color", "encashed", "allowed_probation", "allowed_notice" ], "example": { "type_name": "Example", "color": "string", "no_of_leaves": 100, "paid": true, "monthly_limit": 100, "effective_after": 10, "effective_type": "string", "unused_leave": "string", "encashed": true, "allowed_probation": true, "allowed_notice": true, "gender": "string", "marital_status": "string", "department": "string", "designation": "string", "role": "string", "leavetype": "monthly", "over_utilization": "not_allowed" } }, "example": { "type_name": "Example", "color": "string", "no_of_leaves": 100, "paid": true, "monthly_limit": 100, "effective_after": 10, "effective_type": "string", "unused_leave": "string", "encashed": true, "allowed_probation": true, "allowed_notice": true, "gender": "string", "marital_status": "string", "department": "string", "designation": "string", "role": "string", "leavetype": "monthly", "over_utilization": "not_allowed" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/LeaveType" }, "meta": { "type": "object" } } }, "example": { "message": "Resource created successfully", "data": { "id": 1, "type_name": "Example", "company_id": 1 }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/leave-type/{leave_type}": { "get": { "tags": [ "Leave Types" ], "summary": "Get a Leave Type", "description": "Fetches a single leave type by its id, including its detail fields.", "operationId": "get_leave-type_leave_type", "parameters": [ { "name": "leave_type", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The leave type (usually the numeric id)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LeaveType" } } }, "example": { "data": { "id": 1, "type_name": "Example", "company_id": 1 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "put": { "tags": [ "Leave Types" ], "summary": "Update a Leave Type", "description": "Updates an existing leave type by its id. Send only the fields you want to change; everything else stays as-is.", "operationId": "put_leave-type_leave_type", "parameters": [ { "name": "leave_type", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The leave type (usually the numeric id)." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "type_name": { "type": "string" }, "color": { "type": "string" }, "no_of_leaves": { "type": "number", "default": 5, "description": "Defaults to 5 if omitted." }, "paid": { "type": "boolean", "default": true, "description": "Yes/No flag — true or false (also accepts 1 or 0). Defaults to true if omitted." }, "monthly_limit": { "type": "number", "default": 0, "description": "Defaults to 0 if omitted." }, "effective_after": { "type": "integer" }, "effective_type": { "type": "string" }, "unused_leave": { "type": "string" }, "encashed": { "type": "boolean", "description": "Yes/No flag — true or false (also accepts 1 or 0)." }, "allowed_probation": { "type": "boolean", "description": "Yes/No flag — true or false (also accepts 1 or 0)." }, "allowed_notice": { "type": "boolean", "description": "Yes/No flag — true or false (also accepts 1 or 0)." }, "gender": { "type": "string" }, "marital_status": { "type": "string" }, "department": { "type": "string" }, "designation": { "type": "string" }, "role": { "type": "string" }, "leavetype": { "type": "string", "enum": [ "monthly", "yearly" ], "description": "One of: \"monthly\", \"yearly\"." }, "over_utilization": { "type": "string", "enum": [ "not_allowed", "allow_paid", "allow_unpaid" ], "default": "not_allowed", "description": "One of: \"not_allowed\", \"allow_paid\", \"allow_unpaid\". Defaults to \"not_allowed\" if omitted." } }, "example": { "type_name": "Example", "color": "string", "no_of_leaves": 100, "paid": true, "monthly_limit": 100, "effective_after": 10, "effective_type": "string", "unused_leave": "string", "encashed": true, "allowed_probation": true, "allowed_notice": true, "gender": "string", "marital_status": "string", "department": "string", "designation": "string", "role": "string", "leavetype": "monthly", "over_utilization": "not_allowed" } }, "example": { "type_name": "Example", "color": "string", "no_of_leaves": 100, "paid": true, "monthly_limit": 100, "effective_after": 10, "effective_type": "string", "unused_leave": "string", "encashed": true, "allowed_probation": true, "allowed_notice": true, "gender": "string", "marital_status": "string", "department": "string", "designation": "string", "role": "string", "leavetype": "monthly", "over_utilization": "not_allowed" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/LeaveType" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "type_name": "Example", "company_id": 1 }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "delete": { "tags": [ "Leave Types" ], "summary": "Delete a Leave Type", "description": "Permanently deletes a leave type by its id. This cannot be undone.", "operationId": "delete_leave-type_leave_type", "parameters": [ { "name": "leave_type", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The leave type (usually the numeric id)." } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "example": { "message": "Resource deleted successfully", "meta": { "time": 0.03 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/loan": { "get": { "tags": [ "Loans" ], "summary": "List Loans", "description": "Returns a paginated list of Loans in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_loan", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,code,user_id", "description": "Available fields: `id`, `code`, `user_id`, `loan_type_id`, `amount_requested`, `purpose`, `required_on`, `status`, `applied_on`, `employee_consent`, `approved_amount`, `approved_installments`, `interest_rate`, `deduction_type`, `deduction_value`, `monthly_installment`, `total_payable`, `outstanding_balance`, `total_paid`, `approver_id`, `issue_date`, `rejection_reason`, `created_at`, `updated_at`. Comma-separated subset of the above to return, e.g. `id,code,user_id`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`, `code`, `user_id`, `loan_type_id`, `status`, `deduction_type`, `approver_id`, `amount_requested`, `approved_amount`, `outstanding_balance`, `total_paid`, `issue_date`, `applied_on`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Loan" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "code": "string", "user_id": 1, "loan_type_id": 1, "amount_requested": 100, "purpose": "string", "required_on": "2026-01-31", "status": "pending", "applied_on": "2026-01-31 09:00:00", "employee_consent": true, "approved_amount": 100, "approved_installments": 10, "interest_rate": 100, "deduction_type": "installment", "deduction_value": 100, "monthly_installment": 100, "total_payable": 100, "outstanding_balance": 100, "total_paid": 100, "approver_id": 1, "issue_date": "2026-01-31", "rejection_reason": "string", "created_at": "2026-01-31 09:00:00", "updated_at": "2026-01-31 09:00:00" } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/loan/{loan}": { "get": { "tags": [ "Loans" ], "summary": "Get a Loan", "description": "Fetches a single loan by its id, including its detail fields.", "operationId": "get_loan_loan", "parameters": [ { "name": "loan", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The loan (usually the numeric id)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Loan" } } }, "example": { "data": { "id": 1, "code": "string", "user_id": 1, "loan_type_id": 1, "amount_requested": 100, "purpose": "string", "required_on": "2026-01-31", "status": "pending", "applied_on": "2026-01-31 09:00:00", "employee_consent": true, "approved_amount": 100, "approved_installments": 10, "interest_rate": 100, "deduction_type": "installment", "deduction_value": 100, "monthly_installment": 100, "total_payable": 100, "outstanding_balance": 100, "total_paid": 100, "approver_id": 1, "issue_date": "2026-01-31", "rejection_reason": "string", "created_at": "2026-01-31 09:00:00", "updated_at": "2026-01-31 09:00:00" } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/loan-repayment": { "get": { "tags": [ "Loan Repayments" ], "summary": "List Loan Repayments", "description": "Returns a paginated list of Loan Repayments in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_loan-repayment", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,loan_id,installment_no", "description": "Available fields: `id`, `loan_id`, `installment_no`, `due_month`, `scheduled_amount`, `paid_amount`, `salary_slip_id`, `status`, `paid_on`, `created_at`, `updated_at`. Comma-separated subset of the above to return, e.g. `id,loan_id,installment_no`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`, `loan_id`, `installment_no`, `due_month`, `status`, `salary_slip_id`, `paid_on`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/LoanRepayment" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "loan_id": 1, "installment_no": 10, "due_month": "string", "scheduled_amount": 100, "paid_amount": 100, "salary_slip_id": 1, "status": "scheduled", "paid_on": "2026-01-31", "created_at": "2026-01-31 09:00:00", "updated_at": "2026-01-31 09:00:00" } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/loan-repayment/{loan_repayment}": { "get": { "tags": [ "Loan Repayments" ], "summary": "Get a Loan Repayment", "description": "Fetches a single loan repayment by its id, including its detail fields.", "operationId": "get_loan-repayment_loan_repayment", "parameters": [ { "name": "loan_repayment", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The loan repayment (usually the numeric id)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LoanRepayment" } } }, "example": { "data": { "id": 1, "loan_id": 1, "installment_no": 10, "due_month": "string", "scheduled_amount": 100, "paid_amount": 100, "salary_slip_id": 1, "status": "scheduled", "paid_on": "2026-01-31", "created_at": "2026-01-31 09:00:00", "updated_at": "2026-01-31 09:00:00" } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/loan-type": { "get": { "tags": [ "Loan Types" ], "summary": "List Loan Types", "description": "Returns a paginated list of Loan Types in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_loan-type", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,name,purpose", "description": "Available fields: `id`, `name`, `purpose`, `description`, `amount_type`, `max_amount`, `min_basic_multiple`, `max_basic_multiple`, `repayment_months`, `interest_rate`, `min_service_months`, `status`, `created_at`, `updated_at`. Comma-separated subset of the above to return, e.g. `id,name,purpose`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`, `name`, `amount_type`, `status`, `repayment_months`, `interest_rate`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/LoanType" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "name": "Example", "purpose": "string", "description": "string", "amount_type": "fixed", "max_amount": 100, "min_basic_multiple": 100, "max_basic_multiple": 100, "repayment_months": 10, "interest_rate": 100, "min_service_months": 10, "status": "active", "created_at": "2026-01-31 09:00:00", "updated_at": "2026-01-31 09:00:00" } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/loan-type/{loan_type}": { "get": { "tags": [ "Loan Types" ], "summary": "Get a Loan Type", "description": "Fetches a single loan type by its id, including its detail fields.", "operationId": "get_loan-type_loan_type", "parameters": [ { "name": "loan_type", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The loan type (usually the numeric id)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LoanType" } } }, "example": { "data": { "id": 1, "name": "Example", "purpose": "string", "description": "string", "amount_type": "fixed", "max_amount": 100, "min_basic_multiple": 100, "max_basic_multiple": 100, "repayment_months": 10, "interest_rate": 100, "min_service_months": 10, "status": "active", "created_at": "2026-01-31 09:00:00", "updated_at": "2026-01-31 09:00:00" } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/task/{task_id}/note": { "post": { "tags": [ "Task Notes" ], "summary": "Create a Task Note", "description": "Creates a new task note. Send the body fields below — required ones are marked; optional ones fall back to their defaults.", "operationId": "post_task_task_id_note", "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The task id (usually the numeric id)." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "task_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /task." }, "user_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /employee." }, "note": { "type": "string" } }, "required": [ "task_id" ], "example": { "task_id": 1, "user_id": 1, "note": "string" } }, "example": { "task_id": 1, "user_id": 1, "note": "string" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Note" }, "meta": { "type": "object" } } }, "example": { "message": "Resource created successfully", "data": { "id": 1, "note": "string", "task_id": 1, "user_id": 1 }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/task/{task_id}/note/{note}": { "put": { "tags": [ "Task Notes" ], "summary": "Update a Task Note", "description": "Updates an existing task note by its id. Send only the fields you want to change; everything else stays as-is.", "operationId": "put_task_task_id_note_note", "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The task id (usually the numeric id)." }, { "name": "note", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The note (usually the numeric id)." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "task_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /task." }, "user_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /employee." }, "note": { "type": "string" } }, "example": { "task_id": 1, "user_id": 1, "note": "string" } }, "example": { "task_id": 1, "user_id": 1, "note": "string" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Note" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "note": "string", "task_id": 1, "user_id": 1 }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "delete": { "tags": [ "Task Notes" ], "summary": "Delete a Task Note", "description": "Permanently deletes a task note by its id. This cannot be undone.", "operationId": "delete_task_task_id_note_note", "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The task id (usually the numeric id)." }, { "name": "note", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The note (usually the numeric id)." } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "example": { "message": "Resource deleted successfully", "meta": { "time": 0.03 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/notice": { "get": { "tags": [ "Notice Board" ], "summary": "List Notice Board", "description": "Returns a paginated list of Notice Board in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_notice", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,heading", "description": "Available fields: `id`, `heading`. Comma-separated subset of the above to return, e.g. `id,heading`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`, `heading`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Notice" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "heading": "string" } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "post": { "tags": [ "Notice Board" ], "summary": "Create a Notice Board", "description": "Creates a new notice board. Send the body fields below — required ones are marked; optional ones fall back to their defaults.", "operationId": "post_notice", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "to": { "type": "string", "default": "employee", "description": "Defaults to \"employee\" if omitted." }, "heading": { "type": "string" }, "description": { "type": "string" }, "department_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /department." } }, "required": [ "heading" ], "example": { "to": "string", "heading": "string", "description": "string", "department_id": 1 } }, "example": { "to": "string", "heading": "string", "description": "string", "department_id": 1 } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Notice" }, "meta": { "type": "object" } } }, "example": { "message": "Resource created successfully", "data": { "id": 1, "heading": "string" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/notice/{notice}": { "get": { "tags": [ "Notice Board" ], "summary": "Get a Notice Board", "description": "Fetches a single notice board by its id, including its detail fields.", "operationId": "get_notice_notice", "parameters": [ { "name": "notice", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The notice (usually the numeric id)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Notice" } } }, "example": { "data": { "id": 1, "heading": "string" } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "put": { "tags": [ "Notice Board" ], "summary": "Update a Notice Board", "description": "Updates an existing notice board by its id. Send only the fields you want to change; everything else stays as-is.", "operationId": "put_notice_notice", "parameters": [ { "name": "notice", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The notice (usually the numeric id)." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "to": { "type": "string", "default": "employee", "description": "Defaults to \"employee\" if omitted." }, "heading": { "type": "string" }, "description": { "type": "string" }, "department_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /department." } }, "example": { "to": "string", "heading": "string", "description": "string", "department_id": 1 } }, "example": { "to": "string", "heading": "string", "description": "string", "department_id": 1 } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Notice" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "heading": "string" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "delete": { "tags": [ "Notice Board" ], "summary": "Delete a Notice Board", "description": "Permanently deletes a notice board by its id. This cannot be undone.", "operationId": "delete_notice_notice", "parameters": [ { "name": "notice", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The notice (usually the numeric id)." } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "example": { "message": "Resource deleted successfully", "meta": { "time": 0.03 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/payroll": { "get": { "tags": [ "Payroll" ], "summary": "List Payroll", "description": "Returns a paginated list of Payroll in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_payroll", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,user_id,currency_id", "description": "Available fields: `id`, `user_id`, `currency_id`, `company_id`, `month`, `year`, `basic_salary`, `paid_on`, `salary_json`, `extra_json`, `expense_claims`, `salary_payment_method_id`, `monthly_salary`, `gross_salary`, `total_deductions`, `salary_from`, `salary_to`, `salary_group_id`, `fixed_allowance`, `ytd_json`, `ytd_extra_json`, `ytd_expenses`, `ytd_fixed_allowance`, `additional_earning_json`, `ytd_additional_json`, `net_salary`, `status`. Comma-separated subset of the above to return, e.g. `id,user_id,currency_id`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`, `status`, `user_id`, `month`, `year`, `payroll_cycle_id`, `salary_from`, `salary_to`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Payroll" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "user_id": 1, "currency_id": 1, "company_id": 1, "month": "string", "year": "string", "basic_salary": "string", "paid_on": "2026-01-31", "salary_json": "string", "extra_json": "string", "expense_claims": "string", "salary_payment_method_id": 1, "monthly_salary": 100, "gross_salary": 100, "total_deductions": 100, "salary_from": "2026-01-31 09:00:00", "salary_to": "2026-01-31 09:00:00", "salary_group_id": 1, "fixed_allowance": 100, "ytd_json": "string", "ytd_extra_json": "string", "ytd_expenses": "string", "ytd_fixed_allowance": "string", "additional_earning_json": "string", "ytd_additional_json": "string", "net_salary": "string", "status": "generated" } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "post": { "tags": [ "Payroll" ], "summary": "Create a Payroll", "description": "Creates a new payroll. Send the body fields below — required ones are marked; optional ones fall back to their defaults.", "operationId": "post_payroll", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "currency_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /currency." }, "user_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /employee." }, "salary_group_id": { "type": "integer", "description": "Numeric id of the related salary_group record." }, "basic_salary": { "type": "string", "default": "0", "description": "Defaults to \"0\" if omitted." }, "net_salary": { "type": "string", "default": "0", "description": "Defaults to \"0\" if omitted." }, "month": { "type": "string" }, "year": { "type": "string" }, "paid_on": { "type": "string", "format": "date", "description": "Date in YYYY-MM-DD format." }, "status": { "type": "string", "enum": [ "generated", "review", "locked", "paid" ], "default": "generated", "description": "One of: \"generated\", \"review\", \"locked\", \"paid\". Defaults to \"generated\" if omitted." }, "salary_json": { "type": "string" }, "extra_json": { "type": "string" }, "expense_claims": { "type": "string", "default": "0", "description": "Defaults to \"0\" if omitted." }, "pay_days": { "type": "integer" }, "salary_payment_method_id": { "type": "integer", "description": "Numeric id of the related salary_payment_method record." }, "tds": { "type": "number" }, "monthly_salary": { "type": "number" }, "gross_salary": { "type": "number" }, "total_deductions": { "type": "number" }, "salary_from": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." }, "salary_to": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." }, "payroll_cycle_id": { "type": "integer", "description": "Numeric id of the related payroll_cycle record." }, "fixed_allowance": { "type": "number", "default": 0, "description": "Defaults to 0 if omitted." }, "expenses_created": { "type": "boolean", "default": false, "description": "Yes/No flag — true or false (also accepts 1 or 0). Defaults to false if omitted." }, "expense_id": { "type": "integer", "description": "Numeric id of the related expense record." }, "additional_earning_json": { "type": "string" } }, "required": [ "user_id", "month", "year", "pay_days", "tds", "monthly_salary", "gross_salary", "total_deductions" ], "example": { "currency_id": 1, "user_id": 1, "salary_group_id": 1, "basic_salary": "string", "net_salary": "string", "month": "string", "year": "string", "paid_on": "2026-01-31", "status": "generated", "salary_json": "string", "extra_json": "string", "expense_claims": "string", "pay_days": 10, "salary_payment_method_id": 1, "tds": 100, "monthly_salary": 100, "gross_salary": 100, "total_deductions": 100, "salary_from": "2026-01-31 09:00:00", "salary_to": "2026-01-31 09:00:00", "payroll_cycle_id": 1, "fixed_allowance": 100, "expenses_created": true, "expense_id": 1, "additional_earning_json": "string" } }, "example": { "currency_id": 1, "user_id": 1, "salary_group_id": 1, "basic_salary": "string", "net_salary": "string", "month": "string", "year": "string", "paid_on": "2026-01-31", "status": "generated", "salary_json": "string", "extra_json": "string", "expense_claims": "string", "pay_days": 10, "salary_payment_method_id": 1, "tds": 100, "monthly_salary": 100, "gross_salary": 100, "total_deductions": 100, "salary_from": "2026-01-31 09:00:00", "salary_to": "2026-01-31 09:00:00", "payroll_cycle_id": 1, "fixed_allowance": 100, "expenses_created": true, "expense_id": 1, "additional_earning_json": "string" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Payroll" }, "meta": { "type": "object" } } }, "example": { "message": "Resource created successfully", "data": { "id": 1, "user_id": 1, "currency_id": 1, "company_id": 1, "month": "string", "year": "string", "basic_salary": "string", "paid_on": "2026-01-31", "salary_json": "string", "extra_json": "string", "expense_claims": "string", "salary_payment_method_id": 1, "monthly_salary": 100, "gross_salary": 100, "total_deductions": 100, "salary_from": "2026-01-31 09:00:00", "salary_to": "2026-01-31 09:00:00", "salary_group_id": 1, "fixed_allowance": 100, "ytd_json": "string", "ytd_extra_json": "string", "ytd_expenses": "string", "ytd_fixed_allowance": "string", "additional_earning_json": "string", "ytd_additional_json": "string", "net_salary": "string", "status": "generated" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/payroll/{payroll}": { "get": { "tags": [ "Payroll" ], "summary": "Get a Payroll", "description": "Fetches a single payroll by its id, including its detail fields.", "operationId": "get_payroll_payroll", "parameters": [ { "name": "payroll", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The payroll (usually the numeric id)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Payroll" } } }, "example": { "data": { "id": 1, "user_id": 1, "currency_id": 1, "company_id": 1, "month": "string", "year": "string", "basic_salary": "string", "paid_on": "2026-01-31", "salary_json": "string", "extra_json": "string", "expense_claims": "string", "salary_payment_method_id": 1, "monthly_salary": 100, "gross_salary": 100, "total_deductions": 100, "salary_from": "2026-01-31 09:00:00", "salary_to": "2026-01-31 09:00:00", "salary_group_id": 1, "fixed_allowance": 100, "ytd_json": "string", "ytd_extra_json": "string", "ytd_expenses": "string", "ytd_fixed_allowance": "string", "additional_earning_json": "string", "ytd_additional_json": "string", "net_salary": "string", "status": "generated" } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "put": { "tags": [ "Payroll" ], "summary": "Update a Payroll", "description": "Updates an existing payroll by its id. Send only the fields you want to change; everything else stays as-is.", "operationId": "put_payroll_payroll", "parameters": [ { "name": "payroll", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The payroll (usually the numeric id)." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "currency_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /currency." }, "user_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /employee." }, "salary_group_id": { "type": "integer", "description": "Numeric id of the related salary_group record." }, "basic_salary": { "type": "string", "default": "0", "description": "Defaults to \"0\" if omitted." }, "net_salary": { "type": "string", "default": "0", "description": "Defaults to \"0\" if omitted." }, "month": { "type": "string" }, "year": { "type": "string" }, "paid_on": { "type": "string", "format": "date", "description": "Date in YYYY-MM-DD format." }, "status": { "type": "string", "enum": [ "generated", "review", "locked", "paid" ], "default": "generated", "description": "One of: \"generated\", \"review\", \"locked\", \"paid\". Defaults to \"generated\" if omitted." }, "salary_json": { "type": "string" }, "extra_json": { "type": "string" }, "expense_claims": { "type": "string", "default": "0", "description": "Defaults to \"0\" if omitted." }, "pay_days": { "type": "integer" }, "salary_payment_method_id": { "type": "integer", "description": "Numeric id of the related salary_payment_method record." }, "tds": { "type": "number" }, "monthly_salary": { "type": "number" }, "gross_salary": { "type": "number" }, "total_deductions": { "type": "number" }, "salary_from": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." }, "salary_to": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." }, "payroll_cycle_id": { "type": "integer", "description": "Numeric id of the related payroll_cycle record." }, "fixed_allowance": { "type": "number", "default": 0, "description": "Defaults to 0 if omitted." }, "expenses_created": { "type": "boolean", "default": false, "description": "Yes/No flag — true or false (also accepts 1 or 0). Defaults to false if omitted." }, "expense_id": { "type": "integer", "description": "Numeric id of the related expense record." }, "additional_earning_json": { "type": "string" } }, "example": { "currency_id": 1, "user_id": 1, "salary_group_id": 1, "basic_salary": "string", "net_salary": "string", "month": "string", "year": "string", "paid_on": "2026-01-31", "status": "generated", "salary_json": "string", "extra_json": "string", "expense_claims": "string", "pay_days": 10, "salary_payment_method_id": 1, "tds": 100, "monthly_salary": 100, "gross_salary": 100, "total_deductions": 100, "salary_from": "2026-01-31 09:00:00", "salary_to": "2026-01-31 09:00:00", "payroll_cycle_id": 1, "fixed_allowance": 100, "expenses_created": true, "expense_id": 1, "additional_earning_json": "string" } }, "example": { "currency_id": 1, "user_id": 1, "salary_group_id": 1, "basic_salary": "string", "net_salary": "string", "month": "string", "year": "string", "paid_on": "2026-01-31", "status": "generated", "salary_json": "string", "extra_json": "string", "expense_claims": "string", "pay_days": 10, "salary_payment_method_id": 1, "tds": 100, "monthly_salary": 100, "gross_salary": 100, "total_deductions": 100, "salary_from": "2026-01-31 09:00:00", "salary_to": "2026-01-31 09:00:00", "payroll_cycle_id": 1, "fixed_allowance": 100, "expenses_created": true, "expense_id": 1, "additional_earning_json": "string" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Payroll" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "user_id": 1, "currency_id": 1, "company_id": 1, "month": "string", "year": "string", "basic_salary": "string", "paid_on": "2026-01-31", "salary_json": "string", "extra_json": "string", "expense_claims": "string", "salary_payment_method_id": 1, "monthly_salary": 100, "gross_salary": 100, "total_deductions": 100, "salary_from": "2026-01-31 09:00:00", "salary_to": "2026-01-31 09:00:00", "salary_group_id": 1, "fixed_allowance": 100, "ytd_json": "string", "ytd_extra_json": "string", "ytd_expenses": "string", "ytd_fixed_allowance": "string", "additional_earning_json": "string", "ytd_additional_json": "string", "net_salary": "string", "status": "generated" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "delete": { "tags": [ "Payroll" ], "summary": "Delete a Payroll", "description": "Permanently deletes a payroll by its id. This cannot be undone.", "operationId": "delete_payroll_payroll", "parameters": [ { "name": "payroll", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The payroll (usually the numeric id)." } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "example": { "message": "Resource deleted successfully", "meta": { "time": 0.03 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/payroll-cycle": { "get": { "tags": [ "Payroll" ], "summary": "Get Cycle (Payroll)", "description": "Performs the \"Get Cycle\" action on a payroll.", "operationId": "get_payroll-cycle", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Payroll" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "user_id": 1, "currency_id": 1, "company_id": 1, "month": "string", "year": "string", "basic_salary": "string", "paid_on": "2026-01-31", "salary_json": "string", "extra_json": "string", "expense_claims": "string", "salary_payment_method_id": 1, "monthly_salary": 100, "gross_salary": 100, "total_deductions": 100, "salary_from": "2026-01-31 09:00:00", "salary_to": "2026-01-31 09:00:00", "salary_group_id": 1, "fixed_allowance": 100, "ytd_json": "string", "ytd_extra_json": "string", "ytd_expenses": "string", "ytd_fixed_allowance": "string", "additional_earning_json": "string", "ytd_additional_json": "string", "net_salary": "string", "status": "generated" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/payroll/cycle-data/{payrollCycleId}/{year}": { "get": { "tags": [ "Payroll" ], "summary": "Get Cycle Data (Payroll)", "description": "Performs the \"Get Cycle Data\" action on a payroll.", "operationId": "get_payroll_cycle-data_payrollCycleId_year", "parameters": [ { "name": "payrollCycleId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The payrollCycleId (usually the numeric id)." }, { "name": "year", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The year (usually the numeric id)." } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Payroll" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "user_id": 1, "currency_id": 1, "company_id": 1, "month": "string", "year": "string", "basic_salary": "string", "paid_on": "2026-01-31", "salary_json": "string", "extra_json": "string", "expense_claims": "string", "salary_payment_method_id": 1, "monthly_salary": 100, "gross_salary": 100, "total_deductions": 100, "salary_from": "2026-01-31 09:00:00", "salary_to": "2026-01-31 09:00:00", "salary_group_id": 1, "fixed_allowance": 100, "ytd_json": "string", "ytd_extra_json": "string", "ytd_expenses": "string", "ytd_fixed_allowance": "string", "additional_earning_json": "string", "ytd_additional_json": "string", "net_salary": "string", "status": "generated" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/product": { "get": { "tags": [ "Products" ], "summary": "List Products", "description": "Returns a paginated list of Products in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_product", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,name,description", "description": "Available fields: `id`, `name`, `description`, `price`, `taxes`. Comma-separated subset of the above to return, e.g. `id,name,description`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`, `name`, `description`, `price`, `taxes`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "name": "Example", "description": "string", "price": "string", "taxes": "string" } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "post": { "tags": [ "Products" ], "summary": "Create a Product", "description": "Creates a new product. Send the body fields below — required ones are marked; optional ones fall back to their defaults.", "operationId": "post_product", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Product or service name." }, "price": { "type": "number", "description": "Unit price." }, "description": { "type": "string", "description": "Product description." }, "purchase_allow": { "type": "boolean", "description": "Whether the product is available for purchase." }, "taxes": { "type": "string", "description": "JSON array of tax ids to apply, e.g. \"[1,2]\". Get ids via GET /tax." }, "unit_id": { "type": "integer", "description": "Unit of measure id (optional)." }, "hsn_sac_code": { "type": "string", "description": "HSN/SAC tax code (optional)." } }, "required": [ "name", "price", "description" ], "example": { "name": "Consulting Hour", "price": 75, "description": "One hour of consulting." } }, "example": { "name": "Consulting Hour", "price": 75, "description": "One hour of consulting." } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Product" }, "meta": { "type": "object" } } }, "example": { "message": "Resource created successfully", "data": { "id": 1, "name": "Example", "description": "string", "price": "string", "taxes": "string" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/product/{product}": { "get": { "tags": [ "Products" ], "summary": "Get a Product", "description": "Fetches a single product by its id, including its detail fields.", "operationId": "get_product_product", "parameters": [ { "name": "product", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The product (usually the numeric id)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Product" } } }, "example": { "data": { "id": 1, "name": "Example", "description": "string", "price": "string", "taxes": "string" } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "put": { "tags": [ "Products" ], "summary": "Update a Product", "description": "Updates an existing product by its id. Send only the fields you want to change; everything else stays as-is.", "operationId": "put_product_product", "parameters": [ { "name": "product", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The product (usually the numeric id)." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Product or service name." }, "price": { "type": "number", "description": "Unit price." }, "description": { "type": "string", "description": "Product description." }, "purchase_allow": { "type": "boolean", "description": "Whether the product is available for purchase." }, "taxes": { "type": "string", "description": "JSON array of tax ids to apply, e.g. \"[1,2]\". Get ids via GET /tax." }, "unit_id": { "type": "integer", "description": "Unit of measure id (optional)." }, "hsn_sac_code": { "type": "string", "description": "HSN/SAC tax code (optional)." } }, "example": { "name": "Consulting Hour", "price": 75, "description": "One hour of consulting." } }, "example": { "name": "Consulting Hour", "price": 75, "description": "One hour of consulting." } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Product" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "name": "Example", "description": "string", "price": "string", "taxes": "string" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "delete": { "tags": [ "Products" ], "summary": "Delete a Product", "description": "Permanently deletes a product by its id. This cannot be undone.", "operationId": "delete_product_product", "parameters": [ { "name": "product", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The product (usually the numeric id)." } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "example": { "message": "Resource deleted successfully", "meta": { "time": 0.03 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/project/me": { "get": { "tags": [ "Projects" ], "summary": "Me (Project)", "description": "Performs the \"Me\" action on a project.", "operationId": "get_project_me", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Project" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "project_name": "Example", "project_summary": "string", "start_date": "2026-01-31", "deadline": "2026-01-31", "status": "string", "contact_id": 1, "company_id": 1 }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/project/{project_id}/members": { "post": { "tags": [ "Projects" ], "summary": "Members (Project)", "description": "Performs the \"Members\" action on a project.", "operationId": "post_project_project_id_members", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The project id (usually the numeric id)." } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Project" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "project_name": "Example", "project_summary": "string", "start_date": "2026-01-31", "deadline": "2026-01-31", "status": "string", "contact_id": 1, "company_id": 1 }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/project/{project_id}/member/{id}": { "delete": { "tags": [ "Projects" ], "summary": "Member Remove (Project)", "description": "Performs the \"Member Remove\" action on a project.", "operationId": "delete_project_project_id_member_id", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The project id (usually the numeric id)." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id (usually the numeric id)." } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Project" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "project_name": "Example", "project_summary": "string", "start_date": "2026-01-31", "deadline": "2026-01-31", "status": "string", "contact_id": 1, "company_id": 1 }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/project": { "get": { "tags": [ "Projects" ], "summary": "List Projects", "description": "Returns a paginated list of Projects in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_project", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,project_name,project_summary", "description": "Available fields: `id`, `project_name`, `project_summary`, `start_date`, `deadline`, `status`, `contact_id`, `company_id`. Comma-separated subset of the above to return, e.g. `id,project_name,project_summary`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`, `project_name`, `start_date`, `deadline`, `status`, `contact_id`, `category_id`, `project_member_id`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Project" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "project_name": "Example", "project_summary": "string", "start_date": "2026-01-31", "deadline": "2026-01-31", "status": "string", "contact_id": 1, "company_id": 1 } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "post": { "tags": [ "Projects" ], "summary": "Create a Project", "description": "Creates a new project. Send the body fields below — required ones are marked; optional ones fall back to their defaults.", "operationId": "post_project", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "project_name": { "type": "string", "description": "Name of the project." }, "project_summary": { "type": "string", "description": "Short description of the project." }, "start_date": { "type": "string", "description": "Project start date, YYYY-MM-DD." }, "deadline": { "type": "string", "description": "Project deadline, YYYY-MM-DD (optional)." }, "status": { "type": "string", "default": "not started", "description": "Project status. Built-in values listed; custom statuses can be added in Settings → Project Settings. Default: \"not started\".", "enum": [ "not started", "in progress", "on hold", "finished" ] }, "contact_id": { "type": "integer", "description": "The client/contact this project belongs to. Get ids via GET /contact." }, "category_id": { "type": "integer", "description": "Project category id. Get ids via GET /project-category." }, "currency_id": { "type": "integer", "description": "Currency id for the budget. Get ids via GET /currency." }, "project_budget": { "type": "number", "description": "Total project budget (optional)." }, "hours_allocated": { "type": "number", "description": "Estimated hours allocated (optional)." }, "team_id": { "type": "integer", "description": "Department/team that owns the project. Get ids via GET /department." } }, "required": [ "project_name" ], "example": { "project_name": "Website Revamp", "start_date": "2026-06-01", "deadline": "2026-08-01", "status": "not started", "contact_id": 1, "project_summary": "Redesign the marketing website.", "project_budget": 5000 } }, "example": { "project_name": "Website Revamp", "start_date": "2026-06-01", "deadline": "2026-08-01", "status": "not started", "contact_id": 1, "project_summary": "Redesign the marketing website.", "project_budget": 5000 } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Project" }, "meta": { "type": "object" } } }, "example": { "message": "Resource created successfully", "data": { "id": 1, "project_name": "Example", "project_summary": "string", "start_date": "2026-01-31", "deadline": "2026-01-31", "status": "string", "contact_id": 1, "company_id": 1 }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/project/{project}": { "get": { "tags": [ "Projects" ], "summary": "Get a Project", "description": "Fetches a single project by its id, including its detail fields.", "operationId": "get_project_project", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The project (usually the numeric id)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Project" } } }, "example": { "data": { "id": 1, "project_name": "Example", "project_summary": "string", "start_date": "2026-01-31", "deadline": "2026-01-31", "status": "string", "contact_id": 1, "company_id": 1 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "put": { "tags": [ "Projects" ], "summary": "Update a Project", "description": "Updates an existing project by its id. Send only the fields you want to change; everything else stays as-is.", "operationId": "put_project_project", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The project (usually the numeric id)." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "project_name": { "type": "string", "description": "Name of the project." }, "project_summary": { "type": "string", "description": "Short description of the project." }, "start_date": { "type": "string", "description": "Project start date, YYYY-MM-DD." }, "deadline": { "type": "string", "description": "Project deadline, YYYY-MM-DD (optional)." }, "status": { "type": "string", "default": "not started", "description": "Project status. Built-in values listed; custom statuses can be added in Settings → Project Settings. Default: \"not started\".", "enum": [ "not started", "in progress", "on hold", "finished" ] }, "contact_id": { "type": "integer", "description": "The client/contact this project belongs to. Get ids via GET /contact." }, "category_id": { "type": "integer", "description": "Project category id. Get ids via GET /project-category." }, "currency_id": { "type": "integer", "description": "Currency id for the budget. Get ids via GET /currency." }, "project_budget": { "type": "number", "description": "Total project budget (optional)." }, "hours_allocated": { "type": "number", "description": "Estimated hours allocated (optional)." }, "team_id": { "type": "integer", "description": "Department/team that owns the project. Get ids via GET /department." } }, "example": { "status": "in progress" } }, "example": { "status": "in progress" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Project" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "project_name": "Example", "project_summary": "string", "start_date": "2026-01-31", "deadline": "2026-01-31", "status": "string", "contact_id": 1, "company_id": 1 }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "delete": { "tags": [ "Projects" ], "summary": "Delete a Project", "description": "Permanently deletes a project by its id. This cannot be undone.", "operationId": "delete_project_project", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The project (usually the numeric id)." } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "example": { "message": "Resource deleted successfully", "meta": { "time": 0.03 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/project-category": { "get": { "tags": [ "Project Categories" ], "summary": "List Project Categories", "description": "Returns a paginated list of Project Categories in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_project-category", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,category_name", "description": "Available fields: `id`, `category_name`. Comma-separated subset of the above to return, e.g. `id,category_name`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectCategory" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "category_name": "Example" } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "post": { "tags": [ "Project Categories" ], "summary": "Create a Project Category", "description": "Creates a new project category. Send the body fields below — required ones are marked; optional ones fall back to their defaults.", "operationId": "post_project-category", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "category_name": { "type": "string" } }, "required": [ "category_name" ], "example": { "category_name": "Example" } }, "example": { "category_name": "Example" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/ProjectCategory" }, "meta": { "type": "object" } } }, "example": { "message": "Resource created successfully", "data": { "id": 1, "category_name": "Example" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/project-category/{project_category}": { "get": { "tags": [ "Project Categories" ], "summary": "Get a Project Category", "description": "Fetches a single project category by its id, including its detail fields.", "operationId": "get_project-category_project_category", "parameters": [ { "name": "project_category", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The project category (usually the numeric id)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProjectCategory" } } }, "example": { "data": { "id": 1, "category_name": "Example" } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "put": { "tags": [ "Project Categories" ], "summary": "Update a Project Category", "description": "Updates an existing project category by its id. Send only the fields you want to change; everything else stays as-is.", "operationId": "put_project-category_project_category", "parameters": [ { "name": "project_category", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The project category (usually the numeric id)." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "category_name": { "type": "string" } }, "example": { "category_name": "Example" } }, "example": { "category_name": "Example" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/ProjectCategory" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "category_name": "Example" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "delete": { "tags": [ "Project Categories" ], "summary": "Delete a Project Category", "description": "Permanently deletes a project category by its id. This cannot be undone.", "operationId": "delete_project-category_project_category", "parameters": [ { "name": "project_category", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The project category (usually the numeric id)." } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "example": { "message": "Resource deleted successfully", "meta": { "time": 0.03 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/task/{task_id}/subtask": { "get": { "tags": [ "Sub-tasks" ], "summary": "List Sub-tasks", "description": "Returns a paginated list of Sub-tasks in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_task_task_id_subtask", "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The task id (usually the numeric id)." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,title,due_date", "description": "Available fields: `id`, `title`, `due_date`, `status`. Comma-separated subset of the above to return, e.g. `id,title,due_date`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`, `title`, `status`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Subtask" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "title": "string", "due_date": "2026-01-31 09:00:00", "status": "incomplete" } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "post": { "tags": [ "Sub-tasks" ], "summary": "Create a Sub-task", "description": "Creates a new sub-task. Send the body fields below — required ones are marked; optional ones fall back to their defaults.", "operationId": "post_task_task_id_subtask", "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The task id (usually the numeric id)." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "task_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /task." }, "title": { "type": "string" }, "due_date": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." }, "start_date": { "type": "string", "format": "date", "description": "Date in YYYY-MM-DD format." }, "status": { "type": "string", "enum": [ "incomplete", "complete" ], "default": "incomplete", "description": "One of: \"incomplete\", \"complete\". Defaults to \"incomplete\" if omitted." }, "assigned_to": { "type": "integer" }, "description": { "type": "string" } }, "required": [ "task_id", "title" ], "example": { "task_id": 1, "title": "string", "due_date": "2026-01-31 09:00:00", "start_date": "2026-01-31", "status": "incomplete", "assigned_to": 10, "description": "string" } }, "example": { "task_id": 1, "title": "string", "due_date": "2026-01-31 09:00:00", "start_date": "2026-01-31", "status": "incomplete", "assigned_to": 10, "description": "string" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Subtask" }, "meta": { "type": "object" } } }, "example": { "message": "Resource created successfully", "data": { "id": 1, "title": "string", "due_date": "2026-01-31 09:00:00", "status": "incomplete" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/task/{task_id}/subtask/{subtask}": { "get": { "tags": [ "Sub-tasks" ], "summary": "Get a Sub-task", "description": "Fetches a single sub-task by its id, including its detail fields.", "operationId": "get_task_task_id_subtask_subtask", "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The task id (usually the numeric id)." }, { "name": "subtask", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The subtask (usually the numeric id)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Subtask" } } }, "example": { "data": { "id": 1, "title": "string", "due_date": "2026-01-31 09:00:00", "status": "incomplete" } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "put": { "tags": [ "Sub-tasks" ], "summary": "Update a Sub-task", "description": "Updates an existing sub-task by its id. Send only the fields you want to change; everything else stays as-is.", "operationId": "put_task_task_id_subtask_subtask", "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The task id (usually the numeric id)." }, { "name": "subtask", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The subtask (usually the numeric id)." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "task_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /task." }, "title": { "type": "string" }, "due_date": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." }, "start_date": { "type": "string", "format": "date", "description": "Date in YYYY-MM-DD format." }, "status": { "type": "string", "enum": [ "incomplete", "complete" ], "default": "incomplete", "description": "One of: \"incomplete\", \"complete\". Defaults to \"incomplete\" if omitted." }, "assigned_to": { "type": "integer" }, "description": { "type": "string" } }, "example": { "task_id": 1, "title": "string", "due_date": "2026-01-31 09:00:00", "start_date": "2026-01-31", "status": "incomplete", "assigned_to": 10, "description": "string" } }, "example": { "task_id": 1, "title": "string", "due_date": "2026-01-31 09:00:00", "start_date": "2026-01-31", "status": "incomplete", "assigned_to": 10, "description": "string" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Subtask" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "title": "string", "due_date": "2026-01-31 09:00:00", "status": "incomplete" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "delete": { "tags": [ "Sub-tasks" ], "summary": "Delete a Sub-task", "description": "Permanently deletes a sub-task by its id. This cannot be undone.", "operationId": "delete_task_task_id_subtask_subtask", "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The task id (usually the numeric id)." }, { "name": "subtask", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The subtask (usually the numeric id)." } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "example": { "message": "Resource deleted successfully", "meta": { "time": 0.03 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/task/me": { "get": { "tags": [ "Tasks" ], "summary": "Me (Task)", "description": "Performs the \"Me\" action on a task.", "operationId": "get_task_me", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Task" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "heading": "string", "start_date": "2026-01-31 09:00:00", "priority": "low", "due_date": "2026-01-31 09:00:00", "is_private": true, "status": "incomplete" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/task/remind/{id}": { "get": { "tags": [ "Tasks" ], "summary": "Remind (Task)", "description": "Performs the \"Remind\" action on a task.", "operationId": "get_task_remind_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id (usually the numeric id)." } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Task" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "heading": "string", "start_date": "2026-01-31 09:00:00", "priority": "low", "due_date": "2026-01-31 09:00:00", "is_private": true, "status": "incomplete" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/task": { "get": { "tags": [ "Tasks" ], "summary": "List Tasks", "description": "Returns a paginated list of Tasks in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_task", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,heading,start_date", "description": "Available fields: `id`, `heading`, `start_date`, `priority`, `due_date`, `is_private`, `status`. Comma-separated subset of the above to return, e.g. `id,heading,start_date`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`, `tasks.id`, `heading`, `project_id`, `board_column_id`, `task_category_id`, `task_user_id`, `project_client_id`, `created_by`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Task" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "heading": "string", "start_date": "2026-01-31 09:00:00", "priority": "low", "due_date": "2026-01-31 09:00:00", "is_private": true, "status": "incomplete" } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "post": { "tags": [ "Tasks" ], "summary": "Create a Task", "description": "Creates a new task. Send the body fields below — required ones are marked; optional ones fall back to their defaults.", "operationId": "post_task", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "heading": { "type": "string", "description": "The task title." }, "description": { "type": "string", "description": "Detailed description / notes (optional)." }, "priority": { "type": "string", "description": "Task priority.", "enum": [ "low", "medium", "high" ] }, "status": { "type": "string", "description": "Task status.", "enum": [ "incomplete", "completed" ] }, "due_date": { "type": "string", "description": "Due date, YYYY-MM-DD." }, "start_date": { "type": "string", "description": "Start date, YYYY-MM-DD (optional)." }, "task_users": { "type": "array", "description": "Assignees — array of user objects, e.g. [{\"id\":1}]. Get ids via GET /employee.", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Assignee user id." } } } }, "project": { "type": "object", "description": "Project to attach the task to (optional). Get ids via GET /project.", "properties": { "id": { "type": "integer", "description": "Project id." } } }, "category": { "type": "object", "description": "Task category (optional). Get ids via GET /task-category.", "properties": { "id": { "type": "integer", "description": "Task category id." } } }, "is_private": { "type": "boolean", "description": "If true, only assignees can see the task." } }, "required": [ "heading", "priority", "status", "due_date", "task_users" ], "example": { "heading": "Design the landing page", "priority": "medium", "due_date": "2026-07-01", "status": "incomplete", "task_users": [ { "id": 1 } ], "project": { "id": 1 } } }, "example": { "heading": "Design the landing page", "priority": "medium", "due_date": "2026-07-01", "status": "incomplete", "task_users": [ { "id": 1 } ], "project": { "id": 1 } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Task" }, "meta": { "type": "object" } } }, "example": { "message": "Resource created successfully", "data": { "id": 1, "heading": "string", "start_date": "2026-01-31 09:00:00", "priority": "low", "due_date": "2026-01-31 09:00:00", "is_private": true, "status": "incomplete" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/task/{task}": { "get": { "tags": [ "Tasks" ], "summary": "Get a Task", "description": "Fetches a single task by its id, including its detail fields.", "operationId": "get_task_task", "parameters": [ { "name": "task", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The task (usually the numeric id)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Task" } } }, "example": { "data": { "id": 1, "heading": "string", "start_date": "2026-01-31 09:00:00", "priority": "low", "due_date": "2026-01-31 09:00:00", "is_private": true, "status": "incomplete" } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "put": { "tags": [ "Tasks" ], "summary": "Update a Task", "description": "Updates an existing task by its id. Send only the fields you want to change; everything else stays as-is.", "operationId": "put_task_task", "parameters": [ { "name": "task", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The task (usually the numeric id)." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "heading": { "type": "string", "description": "The task title." }, "description": { "type": "string", "description": "Detailed description / notes (optional)." }, "priority": { "type": "string", "description": "Task priority.", "enum": [ "low", "medium", "high" ] }, "status": { "type": "string", "description": "Task status.", "enum": [ "incomplete", "completed" ] }, "due_date": { "type": "string", "description": "Due date, YYYY-MM-DD." }, "start_date": { "type": "string", "description": "Start date, YYYY-MM-DD (optional)." }, "task_users": { "type": "array", "description": "Assignees — array of user objects, e.g. [{\"id\":1}]. Get ids via GET /employee.", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Assignee user id." } } } }, "project": { "type": "object", "description": "Project to attach the task to (optional). Get ids via GET /project.", "properties": { "id": { "type": "integer", "description": "Project id." } } }, "category": { "type": "object", "description": "Task category (optional). Get ids via GET /task-category.", "properties": { "id": { "type": "integer", "description": "Task category id." } } }, "is_private": { "type": "boolean", "description": "If true, only assignees can see the task." } }, "example": { "status": "completed" } }, "example": { "status": "completed" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Task" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "heading": "string", "start_date": "2026-01-31 09:00:00", "priority": "low", "due_date": "2026-01-31 09:00:00", "is_private": true, "status": "incomplete" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "delete": { "tags": [ "Tasks" ], "summary": "Delete a Task", "description": "Permanently deletes a task by its id. This cannot be undone.", "operationId": "delete_task_task", "parameters": [ { "name": "task", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The task (usually the numeric id)." } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "example": { "message": "Resource deleted successfully", "meta": { "time": 0.03 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/task-category": { "get": { "tags": [ "Task Categories" ], "summary": "List Task Categories", "description": "Returns a paginated list of Task Categories in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_task-category", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,title", "description": "Available fields: `id`, `title`. Comma-separated subset of the above to return, e.g. `id,title`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`, `title`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TaskCategory" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "title": "string" } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "post": { "tags": [ "Task Categories" ], "summary": "Create a Task Category", "description": "Creates a new task category. Send the body fields below — required ones are marked; optional ones fall back to their defaults.", "operationId": "post_task-category", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "category_name": { "type": "string" } }, "required": [ "category_name" ], "example": { "category_name": "Example" } }, "example": { "category_name": "Example" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/TaskCategory" }, "meta": { "type": "object" } } }, "example": { "message": "Resource created successfully", "data": { "id": 1, "title": "string" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/task-category/{task_category}": { "get": { "tags": [ "Task Categories" ], "summary": "Get a Task Category", "description": "Fetches a single task category by its id, including its detail fields.", "operationId": "get_task-category_task_category", "parameters": [ { "name": "task_category", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The task category (usually the numeric id)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TaskCategory" } } }, "example": { "data": { "id": 1, "title": "string" } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "put": { "tags": [ "Task Categories" ], "summary": "Update a Task Category", "description": "Updates an existing task category by its id. Send only the fields you want to change; everything else stays as-is.", "operationId": "put_task-category_task_category", "parameters": [ { "name": "task_category", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The task category (usually the numeric id)." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "category_name": { "type": "string" } }, "example": { "category_name": "Example" } }, "example": { "category_name": "Example" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/TaskCategory" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "title": "string" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "delete": { "tags": [ "Task Categories" ], "summary": "Delete a Task Category", "description": "Permanently deletes a task category by its id. This cannot be undone.", "operationId": "delete_task-category_task_category", "parameters": [ { "name": "task_category", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The task category (usually the numeric id)." } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "example": { "message": "Resource deleted successfully", "meta": { "time": 0.03 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/taskboard-columns": { "get": { "tags": [ "Task Boards" ], "summary": "List Task Boards", "description": "Returns a paginated list of Task Boards in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_taskboard-columns", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,column_name,slug", "description": "Available fields: `id`, `column_name`, `slug`, `label_color`, `priority`. Comma-separated subset of the above to return, e.g. `id,column_name,slug`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`, `column_name`, `slug`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TaskboardColumns" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "column_name": "Example", "slug": "string", "label_color": "string", "priority": 10 } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "post": { "tags": [ "Task Boards" ], "summary": "Create a Task Board", "description": "Creates a new task board. Send the body fields below — required ones are marked; optional ones fall back to their defaults.", "operationId": "post_taskboard-columns", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "column_name": { "type": "string" }, "slug": { "type": "string" }, "label_color": { "type": "string" }, "priority": { "type": "integer" }, "task_board_id": { "type": "integer", "description": "Numeric id of the related task_board record." } }, "required": [ "column_name", "label_color", "priority" ], "example": { "column_name": "Example", "slug": "string", "label_color": "string", "priority": 10, "task_board_id": 1 } }, "example": { "column_name": "Example", "slug": "string", "label_color": "string", "priority": 10, "task_board_id": 1 } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/TaskboardColumns" }, "meta": { "type": "object" } } }, "example": { "message": "Resource created successfully", "data": { "id": 1, "column_name": "Example", "slug": "string", "label_color": "string", "priority": 10 }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/taskboard-columns/{taskboard_column}": { "get": { "tags": [ "Task Boards" ], "summary": "Get a Task Board", "description": "Fetches a single task board by its id, including its detail fields.", "operationId": "get_taskboard-columns_taskboard_column", "parameters": [ { "name": "taskboard_column", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The taskboard column (usually the numeric id)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TaskboardColumns" } } }, "example": { "data": { "id": 1, "column_name": "Example", "slug": "string", "label_color": "string", "priority": 10 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "put": { "tags": [ "Task Boards" ], "summary": "Update a Task Board", "description": "Updates an existing task board by its id. Send only the fields you want to change; everything else stays as-is.", "operationId": "put_taskboard-columns_taskboard_column", "parameters": [ { "name": "taskboard_column", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The taskboard column (usually the numeric id)." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "column_name": { "type": "string" }, "slug": { "type": "string" }, "label_color": { "type": "string" }, "priority": { "type": "integer" }, "task_board_id": { "type": "integer", "description": "Numeric id of the related task_board record." } }, "example": { "column_name": "Example", "slug": "string", "label_color": "string", "priority": 10, "task_board_id": 1 } }, "example": { "column_name": "Example", "slug": "string", "label_color": "string", "priority": 10, "task_board_id": 1 } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/TaskboardColumns" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "column_name": "Example", "slug": "string", "label_color": "string", "priority": 10 }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "delete": { "tags": [ "Task Boards" ], "summary": "Delete a Task Board", "description": "Permanently deletes a task board by its id. This cannot be undone.", "operationId": "delete_taskboard-columns_taskboard_column", "parameters": [ { "name": "taskboard_column", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The taskboard column (usually the numeric id)." } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "example": { "message": "Resource deleted successfully", "meta": { "time": 0.03 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/tax": { "get": { "tags": [ "Taxes" ], "summary": "List Taxes", "description": "Returns a paginated list of Taxes in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_tax", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,tax_name,rate_percent", "description": "Available fields: `id`, `tax_name`, `rate_percent`. Comma-separated subset of the above to return, e.g. `id,tax_name,rate_percent`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`, `tax_name`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Tax" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "tax_name": "Example", "rate_percent": "string" } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/ticket/me": { "get": { "tags": [ "Tickets" ], "summary": "Me (Ticket)", "description": "Performs the \"Me\" action on a ticket.", "operationId": "get_ticket_me", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Ticket" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "subject": "string", "status": "open", "priority": "low" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/ticket": { "get": { "tags": [ "Tickets" ], "summary": "List Tickets", "description": "Returns a paginated list of Tickets in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_ticket", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,subject,status", "description": "Available fields: `id`, `subject`, `status`, `priority`. Comma-separated subset of the above to return, e.g. `id,subject,status`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`, `subject`, `status`, `agent_id`, `user_id`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Ticket" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "subject": "string", "status": "open", "priority": "low" } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "post": { "tags": [ "Tickets" ], "summary": "Create a Ticket", "description": "Creates a new ticket. Send the body fields below — required ones are marked; optional ones fall back to their defaults.", "operationId": "post_ticket", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "user_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /employee." }, "subject": { "type": "string" }, "status": { "type": "string", "enum": [ "open", "pending", "resolved", "closed" ], "default": "open", "description": "One of: \"open\", \"pending\", \"resolved\", \"closed\". Defaults to \"open\" if omitted." }, "priority": { "type": "string", "enum": [ "low", "medium", "high", "urgent" ], "default": "medium", "description": "One of: \"low\", \"medium\", \"high\", \"urgent\". Defaults to \"medium\" if omitted." }, "agent_id": { "type": "integer", "description": "Numeric id of the related agent record." }, "channel_id": { "type": "integer", "description": "Numeric id of the related channel record." }, "type_id": { "type": "integer", "description": "Numeric id of the related type record." } }, "required": [ "user_id", "subject" ], "example": { "user_id": 1, "subject": "string", "status": "open", "priority": "low", "agent_id": 1, "channel_id": 1, "type_id": 1 } }, "example": { "user_id": 1, "subject": "string", "status": "open", "priority": "low", "agent_id": 1, "channel_id": 1, "type_id": 1 } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Ticket" }, "meta": { "type": "object" } } }, "example": { "message": "Resource created successfully", "data": { "id": 1, "subject": "string", "status": "open", "priority": "low" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/ticket/{ticket}": { "get": { "tags": [ "Tickets" ], "summary": "Get a Ticket", "description": "Fetches a single ticket by its id, including its detail fields.", "operationId": "get_ticket_ticket", "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The ticket (usually the numeric id)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Ticket" } } }, "example": { "data": { "id": 1, "subject": "string", "status": "open", "priority": "low" } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "put": { "tags": [ "Tickets" ], "summary": "Update a Ticket", "description": "Updates an existing ticket by its id. Send only the fields you want to change; everything else stays as-is.", "operationId": "put_ticket_ticket", "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The ticket (usually the numeric id)." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "user_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /employee." }, "subject": { "type": "string" }, "status": { "type": "string", "enum": [ "open", "pending", "resolved", "closed" ], "default": "open", "description": "One of: \"open\", \"pending\", \"resolved\", \"closed\". Defaults to \"open\" if omitted." }, "priority": { "type": "string", "enum": [ "low", "medium", "high", "urgent" ], "default": "medium", "description": "One of: \"low\", \"medium\", \"high\", \"urgent\". Defaults to \"medium\" if omitted." }, "agent_id": { "type": "integer", "description": "Numeric id of the related agent record." }, "channel_id": { "type": "integer", "description": "Numeric id of the related channel record." }, "type_id": { "type": "integer", "description": "Numeric id of the related type record." } }, "example": { "user_id": 1, "subject": "string", "status": "open", "priority": "low", "agent_id": 1, "channel_id": 1, "type_id": 1 } }, "example": { "user_id": 1, "subject": "string", "status": "open", "priority": "low", "agent_id": 1, "channel_id": 1, "type_id": 1 } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Ticket" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "subject": "string", "status": "open", "priority": "low" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "delete": { "tags": [ "Tickets" ], "summary": "Delete a Ticket", "description": "Permanently deletes a ticket by its id. This cannot be undone.", "operationId": "delete_ticket_ticket", "parameters": [ { "name": "ticket", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The ticket (usually the numeric id)." } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "example": { "message": "Resource deleted successfully", "meta": { "time": 0.03 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/ticket-channel": { "get": { "tags": [ "Ticket Channels" ], "summary": "List Ticket Channels", "description": "Returns a paginated list of Ticket Channels in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_ticket-channel", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,channel_name", "description": "Available fields: `id`, `channel_name`. Comma-separated subset of the above to return, e.g. `id,channel_name`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`, `channel_name`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TicketChannel" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "channel_name": "Example" } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/ticket-group": { "get": { "tags": [ "Ticket Groups" ], "summary": "List Ticket Groups", "description": "Returns a paginated list of Ticket Groups in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_ticket-group", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,group_name", "description": "Available fields: `id`, `group_name`. Comma-separated subset of the above to return, e.g. `id,group_name`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`, `group_name`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TicketGroup" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "group_name": "Example" } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/ticket-reply-file": { "post": { "tags": [ "Ticket Replies" ], "summary": "Ticket Reply File (Ticket Reply)", "description": "Performs the \"Ticket Reply File\" action on a ticket reply.", "operationId": "post_ticket-reply-file", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/TicketReply" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "message": "string", "created_at": "2026-01-31 09:00:00" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/ticket-reply": { "get": { "tags": [ "Ticket Replies" ], "summary": "List Ticket Replies", "description": "Returns a paginated list of Ticket Replies in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_ticket-reply", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,message,created_at", "description": "Available fields: `id`, `message`, `created_at`. Comma-separated subset of the above to return, e.g. `id,message,created_at`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`, `message`, `ticket_id`, `user_id`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TicketReply" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "message": "string", "created_at": "2026-01-31 09:00:00" } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "post": { "tags": [ "Ticket Replies" ], "summary": "Create a Ticket Reply", "description": "Creates a new ticket reply. Send the body fields below — required ones are marked; optional ones fall back to their defaults.", "operationId": "post_ticket-reply", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ticket_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /ticket." }, "user_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /employee." }, "message": { "type": "string" } }, "required": [ "ticket_id", "user_id" ], "example": { "ticket_id": 1, "user_id": 1, "message": "string" } }, "example": { "ticket_id": 1, "user_id": 1, "message": "string" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/TicketReply" }, "meta": { "type": "object" } } }, "example": { "message": "Resource created successfully", "data": { "id": 1, "message": "string", "created_at": "2026-01-31 09:00:00" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/ticket-reply/{ticket_reply}": { "get": { "tags": [ "Ticket Replies" ], "summary": "Get a Ticket Reply", "description": "Fetches a single ticket reply by its id, including its detail fields.", "operationId": "get_ticket-reply_ticket_reply", "parameters": [ { "name": "ticket_reply", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The ticket reply (usually the numeric id)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TicketReply" } } }, "example": { "data": { "id": 1, "message": "string", "created_at": "2026-01-31 09:00:00" } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "put": { "tags": [ "Ticket Replies" ], "summary": "Update a Ticket Reply", "description": "Updates an existing ticket reply by its id. Send only the fields you want to change; everything else stays as-is.", "operationId": "put_ticket-reply_ticket_reply", "parameters": [ { "name": "ticket_reply", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The ticket reply (usually the numeric id)." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "ticket_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /ticket." }, "user_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /employee." }, "message": { "type": "string" } }, "example": { "ticket_id": 1, "user_id": 1, "message": "string" } }, "example": { "ticket_id": 1, "user_id": 1, "message": "string" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/TicketReply" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "message": "string", "created_at": "2026-01-31 09:00:00" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "delete": { "tags": [ "Ticket Replies" ], "summary": "Delete a Ticket Reply", "description": "Permanently deletes a ticket reply by its id. This cannot be undone.", "operationId": "delete_ticket-reply_ticket_reply", "parameters": [ { "name": "ticket_reply", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The ticket reply (usually the numeric id)." } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "example": { "message": "Resource deleted successfully", "meta": { "time": 0.03 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/ticket-type": { "get": { "tags": [ "Ticket Types" ], "summary": "List Ticket Types", "description": "Returns a paginated list of Ticket Types in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_ticket-type", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,type", "description": "Available fields: `id`, `type`. Comma-separated subset of the above to return, e.g. `id,type`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`, `type`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TicketType" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "type": "string" } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/task/{task_id}/timelog": { "get": { "tags": [ "Timesheets" ], "summary": "List Timesheets", "description": "Returns a paginated list of Timesheets in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_task_task_id_timelog", "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The task id (usually the numeric id)." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,start_time,end_time", "description": "Available fields: `id`, `start_time`, `end_time`, `memo`, `task_id`. Comma-separated subset of the above to return, e.g. `id,start_time,end_time`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`, `project_id`, `task_id`, `start_time`, `end_time`, `user_id`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Timelog" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "start_time": "2026-01-31 09:00:00", "end_time": "2026-01-31 09:00:00", "memo": "string", "task_id": 1 } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/timelog/me": { "get": { "tags": [ "Timesheets" ], "summary": "Me (Timesheet)", "description": "Performs the \"Me\" action on a timesheet.", "operationId": "get_timelog_me", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Timelog" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "start_time": "2026-01-31 09:00:00", "end_time": "2026-01-31 09:00:00", "memo": "string", "task_id": 1 }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/timelog": { "get": { "tags": [ "Timesheets" ], "summary": "List Timesheets", "description": "Returns a paginated list of Timesheets in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_timelog", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,start_time,end_time", "description": "Available fields: `id`, `start_time`, `end_time`, `memo`, `task_id`. Comma-separated subset of the above to return, e.g. `id,start_time,end_time`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`, `project_id`, `task_id`, `start_time`, `end_time`, `user_id`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Timelog" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "start_time": "2026-01-31 09:00:00", "end_time": "2026-01-31 09:00:00", "memo": "string", "task_id": 1 } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "post": { "tags": [ "Timesheets" ], "summary": "Create a Timesheet", "description": "Creates a new timesheet. Send the body fields below — required ones are marked; optional ones fall back to their defaults.", "operationId": "post_timelog", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "project_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /project." }, "task_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /task." }, "user_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /employee." }, "start_time": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." }, "end_time": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." }, "memo": { "type": "string" }, "total_hours": { "type": "string" }, "total_minutes": { "type": "string" }, "edited_by_user": { "type": "integer" }, "hourly_rate": { "type": "integer" }, "earnings": { "type": "number" }, "approved": { "type": "boolean", "default": true, "description": "Yes/No flag — true or false (also accepts 1 or 0). Defaults to true if omitted." }, "approved_by": { "type": "integer" }, "invoice_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /invoice." }, "total_break_minutes": { "type": "string" }, "weekly_timesheet_id": { "type": "integer", "description": "Numeric id of the related weekly_timesheet record." }, "rejected": { "type": "boolean", "default": false, "description": "Yes/No flag — true or false (also accepts 1 or 0). Defaults to false if omitted." }, "rejected_by": { "type": "integer" }, "rejected_at": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." }, "reject_reason": { "type": "string" } }, "required": [ "user_id", "start_time", "hourly_rate", "earnings" ], "example": { "project_id": 1, "task_id": 1, "user_id": 1, "start_time": "2026-01-31 09:00:00", "end_time": "2026-01-31 09:00:00", "memo": "string", "total_hours": "string", "total_minutes": "string", "edited_by_user": 10, "hourly_rate": 10, "earnings": 100, "approved": true, "approved_by": 10, "invoice_id": 1, "total_break_minutes": "string", "weekly_timesheet_id": 1, "rejected": true, "rejected_by": 10, "rejected_at": "2026-01-31 09:00:00", "reject_reason": "string" } }, "example": { "project_id": 1, "task_id": 1, "user_id": 1, "start_time": "2026-01-31 09:00:00", "end_time": "2026-01-31 09:00:00", "memo": "string", "total_hours": "string", "total_minutes": "string", "edited_by_user": 10, "hourly_rate": 10, "earnings": 100, "approved": true, "approved_by": 10, "invoice_id": 1, "total_break_minutes": "string", "weekly_timesheet_id": 1, "rejected": true, "rejected_by": 10, "rejected_at": "2026-01-31 09:00:00", "reject_reason": "string" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Timelog" }, "meta": { "type": "object" } } }, "example": { "message": "Resource created successfully", "data": { "id": 1, "start_time": "2026-01-31 09:00:00", "end_time": "2026-01-31 09:00:00", "memo": "string", "task_id": 1 }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/timelog/{timelog}": { "put": { "tags": [ "Timesheets" ], "summary": "Update a Timesheet", "description": "Updates an existing timesheet by its id. Send only the fields you want to change; everything else stays as-is.", "operationId": "put_timelog_timelog", "parameters": [ { "name": "timelog", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The timelog (usually the numeric id)." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "project_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /project." }, "task_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /task." }, "user_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /employee." }, "start_time": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." }, "end_time": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." }, "memo": { "type": "string" }, "total_hours": { "type": "string" }, "total_minutes": { "type": "string" }, "edited_by_user": { "type": "integer" }, "hourly_rate": { "type": "integer" }, "earnings": { "type": "number" }, "approved": { "type": "boolean", "default": true, "description": "Yes/No flag — true or false (also accepts 1 or 0). Defaults to true if omitted." }, "approved_by": { "type": "integer" }, "invoice_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /invoice." }, "total_break_minutes": { "type": "string" }, "weekly_timesheet_id": { "type": "integer", "description": "Numeric id of the related weekly_timesheet record." }, "rejected": { "type": "boolean", "default": false, "description": "Yes/No flag — true or false (also accepts 1 or 0). Defaults to false if omitted." }, "rejected_by": { "type": "integer" }, "rejected_at": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." }, "reject_reason": { "type": "string" } }, "example": { "project_id": 1, "task_id": 1, "user_id": 1, "start_time": "2026-01-31 09:00:00", "end_time": "2026-01-31 09:00:00", "memo": "string", "total_hours": "string", "total_minutes": "string", "edited_by_user": 10, "hourly_rate": 10, "earnings": 100, "approved": true, "approved_by": 10, "invoice_id": 1, "total_break_minutes": "string", "weekly_timesheet_id": 1, "rejected": true, "rejected_by": 10, "rejected_at": "2026-01-31 09:00:00", "reject_reason": "string" } }, "example": { "project_id": 1, "task_id": 1, "user_id": 1, "start_time": "2026-01-31 09:00:00", "end_time": "2026-01-31 09:00:00", "memo": "string", "total_hours": "string", "total_minutes": "string", "edited_by_user": 10, "hourly_rate": 10, "earnings": 100, "approved": true, "approved_by": 10, "invoice_id": 1, "total_break_minutes": "string", "weekly_timesheet_id": 1, "rejected": true, "rejected_by": 10, "rejected_at": "2026-01-31 09:00:00", "reject_reason": "string" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Timelog" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "start_time": "2026-01-31 09:00:00", "end_time": "2026-01-31 09:00:00", "memo": "string", "task_id": 1 }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/tracker-activity": { "get": { "tags": [ "Activity Tracker" ], "summary": "List Activity Tracker", "description": "Returns a paginated list of Activity Tracker in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_tracker-activity", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,user_id,project_time_log_id", "description": "Available fields: `id`, `user_id`, `project_time_log_id`, `interval_start`, `interval_end`, `mouse_clicks`, `key_presses`, `activity_percent`, `is_idle`. Comma-separated subset of the above to return, e.g. `id,user_id,project_time_log_id`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`, `user_id`, `interval_start`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TrackerActivity" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "user_id": 1, "project_time_log_id": 1, "interval_start": "2026-01-31 09:00:00", "interval_end": "2026-01-31 09:00:00", "mouse_clicks": 10, "key_presses": 10, "activity_percent": 10, "is_idle": true } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/tracker-activity/{tracker_activity}": { "get": { "tags": [ "Activity Tracker" ], "summary": "Get a Activity Tracker", "description": "Fetches a single activity tracker by its id, including its detail fields.", "operationId": "get_tracker-activity_tracker_activity", "parameters": [ { "name": "tracker_activity", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The tracker activity (usually the numeric id)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TrackerActivity" } } }, "example": { "data": { "id": 1, "user_id": 1, "project_time_log_id": 1, "interval_start": "2026-01-31 09:00:00", "interval_end": "2026-01-31 09:00:00", "mouse_clicks": 10, "key_presses": 10, "activity_percent": 10, "is_idle": true } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/userchat/message-setting": { "get": { "tags": [ "Messages" ], "summary": "Message Setting (Message)", "description": "Performs the \"Message Setting\" action on a message.", "operationId": "get_userchat_message-setting", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Userchat" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "from": 10, "to": 10, "message_seen": "yes", "user_one": 10, "user_id": 1, "message": "string" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/userchat/user-list": { "get": { "tags": [ "Messages" ], "summary": "User List (Message)", "description": "Performs the \"User List\" action on a message.", "operationId": "get_userchat_user-list", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Userchat" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "from": 10, "to": 10, "message_seen": "yes", "user_one": 10, "user_id": 1, "message": "string" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/userchat/messages/{userid}": { "get": { "tags": [ "Messages" ], "summary": "Get Messages (Message)", "description": "Performs the \"Get Messages\" action on a message.", "operationId": "get_userchat_messages_userid", "parameters": [ { "name": "userid", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The userid (usually the numeric id)." } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Userchat" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "from": 10, "to": 10, "message_seen": "yes", "user_one": 10, "user_id": 1, "message": "string" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/userchat": { "get": { "tags": [ "Messages" ], "summary": "List Messages", "description": "Returns a paginated list of Messages in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_userchat", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,from,to", "description": "Available fields: `id`, `from`, `to`, `message_seen`, `user_one`, `user_id`, `message`. Comma-separated subset of the above to return, e.g. `id,from,to`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`, `from`, `to`, `message_seen`, `user_one`, `user_id`, `message`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Userchat" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "from": 10, "to": 10, "message_seen": "yes", "user_one": 10, "user_id": 1, "message": "string" } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "post": { "tags": [ "Messages" ], "summary": "Create a Message", "description": "Creates a new message. Send the body fields below — required ones are marked; optional ones fall back to their defaults.", "operationId": "post_userchat", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "to": { "type": "integer", "description": "Recipient user id — the team member you are sending the message to. Get ids via GET /employee or GET /user." }, "message": { "type": "string", "description": "The message text to send." }, "message_seen": { "type": "string", "default": "no", "description": "Read status of the message. \"no\" = unread, \"yes\" = read. You normally leave this as the default; it is updated automatically when the recipient opens the chat. Default: \"no\".", "enum": [ "yes", "no" ] } }, "required": [ "to", "message" ], "example": { "to": 1, "message": "Hi, are we still on for the 3pm call?" } }, "example": { "to": 1, "message": "Hi, are we still on for the 3pm call?" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Userchat" }, "meta": { "type": "object" } } }, "example": { "message": "Resource created successfully", "data": { "id": 1, "from": 10, "to": 10, "message_seen": "yes", "user_one": 10, "user_id": 1, "message": "string" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/userchat/{userchat}": { "get": { "tags": [ "Messages" ], "summary": "Get a Message", "description": "Fetches a single message by its id, including its detail fields.", "operationId": "get_userchat_userchat", "parameters": [ { "name": "userchat", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The userchat (usually the numeric id)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Userchat" } } }, "example": { "data": { "id": 1, "from": 10, "to": 10, "message_seen": "yes", "user_one": 10, "user_id": 1, "message": "string" } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "put": { "tags": [ "Messages" ], "summary": "Update a Message", "description": "Updates an existing message by its id. Send only the fields you want to change; everything else stays as-is.", "operationId": "put_userchat_userchat", "parameters": [ { "name": "userchat", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The userchat (usually the numeric id)." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "to": { "type": "integer", "description": "Recipient user id — the team member you are sending the message to. Get ids via GET /employee or GET /user." }, "message": { "type": "string", "description": "The message text to send." }, "message_seen": { "type": "string", "default": "no", "description": "Read status of the message. \"no\" = unread, \"yes\" = read. You normally leave this as the default; it is updated automatically when the recipient opens the chat. Default: \"no\".", "enum": [ "yes", "no" ] } }, "example": { "to": 1, "message": "Hi, are we still on for the 3pm call?" } }, "example": { "to": 1, "message": "Hi, are we still on for the 3pm call?" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Userchat" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "from": 10, "to": 10, "message_seen": "yes", "user_one": 10, "user_id": 1, "message": "string" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "delete": { "tags": [ "Messages" ], "summary": "Delete a Message", "description": "Permanently deletes a message by its id. This cannot be undone.", "operationId": "delete_userchat_userchat", "parameters": [ { "name": "userchat", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The userchat (usually the numeric id)." } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "example": { "message": "Resource deleted successfully", "meta": { "time": 0.03 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/webhook": { "get": { "tags": [ "Webhooks" ], "summary": "List Webhooks", "description": "Returns a paginated list of Webhooks in your workspace. Use the query parameters below to page, sort, pick fields and filter the results.", "operationId": "get_webhook", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "maximum": 1000 }, "example": 20, "description": "How many records to return (max 1000)." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 }, "example": 0, "description": "How many records to skip (for paging)." }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "example": "id,webhooks_setting_id,entity", "description": "Available fields: `id`, `webhooks_setting_id`, `entity`, `event`. Comma-separated subset of the above to return, e.g. `id,webhooks_setting_id,entity`." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "example": "-id", "description": "Sort by any field above. Prefix with `-` for descending, e.g. `-id`." }, { "name": "filters", "in": "query", "schema": { "type": "string" }, "example": "(id gt 0)", "description": "Filterable fields: `id`, `entity`, `event`. Filter syntax: `(field operator value)`, e.g. `(status eq \"active\")` or `(name lk \"%acme%\")`. Combine with `and`/`or`. See the Filtering guide." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook" } }, "meta": { "type": "object", "properties": { "paging": { "type": "object", "properties": { "total": { "type": "integer" }, "links": { "type": "object", "properties": { "next": { "type": "string" } } } } }, "time": { "type": "number" } } } } }, "example": { "data": [ { "id": 1, "webhooks_setting_id": 1, "entity": "string", "event": "string" } ], "meta": { "paging": { "total": 1, "links": { "next": null } }, "time": 0.02 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "post": { "tags": [ "Webhooks" ], "summary": "Create a Webhook", "description": "Creates a new webhook. Send the body fields below — required ones are marked; optional ones fall back to their defaults.", "operationId": "post_webhook", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "entity": { "type": "string", "description": "The record type to watch.", "enum": [ "Contact", "Lead", "Deal", "Project", "Task", "Invoice", "Proposal", "Employee", "Leave", "Attendance", "ActivityReport" ] }, "event": { "type": "string", "description": "The event that fires the webhook. Valid events depend on the entity: Contact / Lead / Employee → created, updated, deleted. Deal → created, updated, deleted, won, lost. Project / Task → created, updated, deleted, completed. Invoice → created, updated, deleted, paid, partially_paid. Proposal → created, updated, deleted, accepted, declined. Leave → created (= applied), approved, rejected. Attendance → check_in, check_out, break_start, break_end. ActivityReport → daily_report." }, "webhooks_setting_id": { "type": "integer", "description": "The destination to deliver to (a webhook URL / Slack / Discord target). Create destinations in the app under Settings → Webhooks, then pass that destination's id here." } }, "required": [ "entity", "event", "webhooks_setting_id" ], "example": { "entity": "Task", "event": "completed", "webhooks_setting_id": 1 } }, "example": { "entity": "Task", "event": "completed", "webhooks_setting_id": 1 } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Webhook" }, "meta": { "type": "object" } } }, "example": { "message": "Resource created successfully", "data": { "id": 1, "webhooks_setting_id": 1, "entity": "string", "event": "string" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } }, "/webhook/{webhook}": { "get": { "tags": [ "Webhooks" ], "summary": "Get a Webhook", "description": "Fetches a single webhook by its id, including its detail fields.", "operationId": "get_webhook_webhook", "parameters": [ { "name": "webhook", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The webhook (usually the numeric id)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Webhook" } } }, "example": { "data": { "id": 1, "webhooks_setting_id": 1, "entity": "string", "event": "string" } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "put": { "tags": [ "Webhooks" ], "summary": "Update a Webhook", "description": "Updates an existing webhook by its id. Send only the fields you want to change; everything else stays as-is.", "operationId": "put_webhook_webhook", "parameters": [ { "name": "webhook", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The webhook (usually the numeric id)." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "entity": { "type": "string", "description": "The record type to watch.", "enum": [ "Contact", "Lead", "Deal", "Project", "Task", "Invoice", "Proposal", "Employee", "Leave", "Attendance", "ActivityReport" ] }, "event": { "type": "string", "description": "The event that fires the webhook. Valid events depend on the entity: Contact / Lead / Employee → created, updated, deleted. Deal → created, updated, deleted, won, lost. Project / Task → created, updated, deleted, completed. Invoice → created, updated, deleted, paid, partially_paid. Proposal → created, updated, deleted, accepted, declined. Leave → created (= applied), approved, rejected. Attendance → check_in, check_out, break_start, break_end. ActivityReport → daily_report." }, "webhooks_setting_id": { "type": "integer", "description": "The destination to deliver to (a webhook URL / Slack / Discord target). Create destinations in the app under Settings → Webhooks, then pass that destination's id here." } }, "example": { "entity": "Task", "event": "completed", "webhooks_setting_id": 1 } }, "example": { "entity": "Task", "event": "completed", "webhooks_setting_id": 1 } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/Webhook" }, "meta": { "type": "object" } } }, "example": { "message": "Resource updated successfully", "data": { "id": 1, "webhooks_setting_id": 1, "entity": "string", "event": "string" }, "meta": { "time": 0.05 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } }, "delete": { "tags": [ "Webhooks" ], "summary": "Delete a Webhook", "description": "Permanently deletes a webhook by its id. This cannot be undone.", "operationId": "delete_webhook_webhook", "parameters": [ { "name": "webhook", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The webhook (usually the numeric id)." } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "example": { "message": "Resource deleted successfully", "meta": { "time": 0.03 } } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "example": { "message": "Not authenticated to perform this request", "error": { "code": 401 } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "example": { "message": "The email field is required.", "error": { "code": 422 } } } } } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "Your API key from Settings → API Keys, sent as `Authorization: Bearer YOUR_API_KEY`." } }, "schemas": { "Attendance": { "type": "object", "properties": { "id": { "type": "integer" }, "user_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /employee." }, "clock_in_date": { "type": "string" }, "clock_in_time": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." }, "clock_out_time": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." }, "working_from": { "type": "string", "default": "office", "description": "Defaults to \"office\" if omitted." }, "late": { "type": "string", "enum": [ "yes", "no" ], "default": "no", "description": "One of: \"yes\", \"no\". Defaults to \"no\" if omitted." }, "half_day": { "type": "string", "enum": [ "yes", "no" ], "description": "One of: \"yes\", \"no\"." }, "added_by": { "type": "integer" }, "company_id": { "type": "integer", "description": "Numeric id of the related company record." } } }, "Break": { "type": "object", "properties": { "id": { "type": "integer" }, "user_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /employee." }, "attendance_id": { "type": "integer", "description": "Numeric id of the related attendance record." }, "break_type_id": { "type": "integer", "description": "Numeric id of the related break_type record." }, "start_time": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." }, "end_time": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." }, "duration_minutes": { "type": "integer" }, "is_over_limit": { "type": "boolean", "default": false, "description": "Yes/No flag — true or false (also accepts 1 or 0). Defaults to false if omitted." }, "note": { "type": "string" } } }, "BreakType": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "time_limit": { "type": "integer" }, "is_paid": { "type": "string", "enum": [ "yes", "no" ], "default": "no", "description": "One of: \"yes\", \"no\". Defaults to \"no\" if omitted." }, "color": { "type": "string", "default": "#1d82f5", "description": "Defaults to \"#1d82f5\" if omitted." }, "status": { "type": "string", "enum": [ "active", "inactive" ], "default": "active", "description": "One of: \"active\", \"inactive\". Defaults to \"active\" if omitted." } } }, "Comment": { "type": "object", "properties": { "id": { "type": "integer" }, "comment": { "type": "string" }, "task_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /task." }, "user_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /employee." } } }, "Contact": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "email": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "deactive" ], "default": "active", "description": "One of: \"active\", \"deactive\". Defaults to \"active\" if omitted." }, "company_id": { "type": "integer", "description": "Numeric id of the related company record." } } }, "ContactCategory": { "type": "object", "properties": { "id": { "type": "integer" }, "category_name": { "type": "string" } } }, "ContactSubCategory": { "type": "object", "properties": { "id": { "type": "integer" }, "category_name": { "type": "string" }, "category_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /contact-category." } } }, "Contract": { "type": "object", "properties": { "id": { "type": "integer" }, "subject": { "type": "string" }, "amount": { "type": "string" }, "start_date": { "type": "string", "format": "date", "description": "Date in YYYY-MM-DD format." } } }, "ContractType": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } }, "Currency": { "type": "object", "properties": { "id": { "type": "integer" } } }, "Deal": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "value": { "type": "number", "default": 0, "description": "Defaults to 0 if omitted." }, "contact_type": { "type": "string", "default": "lead", "description": "Defaults to \"lead\" if omitted." }, "pipeline_stage_id": { "type": "integer", "description": "Numeric id of the related pipeline_stage record." }, "close_date": { "type": "string", "format": "date", "description": "Date in YYYY-MM-DD format." } } }, "Department": { "type": "object", "properties": { "id": { "type": "integer" }, "team_name": { "type": "string" } } }, "Designation": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } }, "Employee": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "email": { "type": "string" } } }, "Estimate": { "type": "object", "properties": { "id": { "type": "integer" }, "estimate_number": { "type": "string" }, "total": { "type": "number" }, "status": { "type": "string", "enum": [ "declined", "accepted", "waiting", "sent", "draft", "canceled" ], "default": "waiting", "description": "One of: \"declined\", \"accepted\", \"waiting\", \"sent\", \"draft\", \"canceled\". Defaults to \"waiting\" if omitted." }, "valid_till": { "type": "string", "format": "date", "description": "Date in YYYY-MM-DD format." }, "hash": { "type": "string" }, "pdf_download_url": { "type": "string" } } }, "Event": { "type": "object", "properties": { "id": { "type": "integer" } } }, "Expense": { "type": "object", "properties": { "id": { "type": "integer" }, "item_name": { "type": "string" }, "purchase_date": { "type": "string", "format": "date", "description": "Date in YYYY-MM-DD format." }, "price": { "type": "number" }, "status": { "type": "string", "enum": [ "pending", "approved", "rejected" ], "default": "pending", "description": "One of: \"pending\", \"approved\", \"rejected\". Defaults to \"pending\" if omitted." } } }, "File": { "type": "object", "properties": { "id": { "type": "integer" }, "filename": { "type": "string" }, "task_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /task." }, "user_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /employee." }, "created_at": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." } } }, "Holiday": { "type": "object", "properties": { "id": { "type": "integer" }, "date": { "type": "string", "format": "date", "description": "Date in YYYY-MM-DD format." }, "occassion": { "type": "string" } } }, "Invoice": { "type": "object", "properties": { "id": { "type": "integer" }, "invoice_number": { "type": "string" }, "total": { "type": "number" }, "status": { "type": "string", "enum": [ "paid", "unpaid", "partial", "canceled", "draft", "pending-confirmation" ], "default": "unpaid", "description": "One of: \"paid\", \"unpaid\", \"partial\", \"canceled\", \"draft\", \"pending-confirmation\". Defaults to \"unpaid\" if omitted." }, "issue_date": { "type": "string", "format": "date", "description": "Date in YYYY-MM-DD format." }, "company_id": { "type": "integer", "description": "Numeric id of the related company record." }, "pdf_download_url": { "type": "string" } } }, "Leave": { "type": "object", "properties": { "id": { "type": "integer" }, "leave_type_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /leave-type." }, "leave_date": { "type": "string", "format": "date", "description": "Date in YYYY-MM-DD format." }, "reason": { "type": "string" }, "status": { "type": "string", "enum": [ "approved", "pending", "rejected" ], "description": "One of: \"approved\", \"pending\", \"rejected\"." } } }, "LeaveType": { "type": "object", "properties": { "id": { "type": "integer" }, "type_name": { "type": "string" }, "company_id": { "type": "integer", "description": "Numeric id of the related company record." } } }, "Loan": { "type": "object", "properties": { "id": { "type": "integer" }, "code": { "type": "string" }, "user_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /employee." }, "loan_type_id": { "type": "integer", "description": "Numeric id of the related loan_type record." }, "amount_requested": { "type": "number", "default": 0, "description": "Defaults to 0 if omitted." }, "purpose": { "type": "string" }, "required_on": { "type": "string", "format": "date", "description": "Date in YYYY-MM-DD format." }, "status": { "type": "string", "enum": [ "pending", "approved", "rejected", "completed", "cancelled" ], "default": "pending", "description": "One of: \"pending\", \"approved\", \"rejected\", \"completed\", \"cancelled\". Defaults to \"pending\" if omitted." }, "applied_on": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." }, "employee_consent": { "type": "boolean", "default": false, "description": "Yes/No flag — true or false (also accepts 1 or 0). Defaults to false if omitted." }, "approved_amount": { "type": "number" }, "approved_installments": { "type": "integer" }, "interest_rate": { "type": "number", "default": 0, "description": "Defaults to 0 if omitted." }, "deduction_type": { "type": "string", "enum": [ "installment", "fixed", "percentage" ], "default": "installment", "description": "One of: \"installment\", \"fixed\", \"percentage\". Defaults to \"installment\" if omitted." }, "deduction_value": { "type": "number" }, "monthly_installment": { "type": "number" }, "total_payable": { "type": "number" }, "outstanding_balance": { "type": "number" }, "total_paid": { "type": "number", "default": 0, "description": "Defaults to 0 if omitted." }, "approver_id": { "type": "integer", "description": "Numeric id of the related approver record." }, "issue_date": { "type": "string", "format": "date", "description": "Date in YYYY-MM-DD format." }, "rejection_reason": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." } } }, "LoanRepayment": { "type": "object", "properties": { "id": { "type": "integer" }, "loan_id": { "type": "integer", "description": "Numeric id of the related loan record." }, "installment_no": { "type": "integer", "default": 1, "description": "Defaults to 1 if omitted." }, "due_month": { "type": "string" }, "scheduled_amount": { "type": "number", "default": 0, "description": "Defaults to 0 if omitted." }, "paid_amount": { "type": "number", "default": 0, "description": "Defaults to 0 if omitted." }, "salary_slip_id": { "type": "integer", "description": "Numeric id of the related salary_slip record." }, "status": { "type": "string", "enum": [ "scheduled", "deducted", "paid", "waived" ], "default": "scheduled", "description": "One of: \"scheduled\", \"deducted\", \"paid\", \"waived\". Defaults to \"scheduled\" if omitted." }, "paid_on": { "type": "string", "format": "date", "description": "Date in YYYY-MM-DD format." }, "created_at": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." } } }, "LoanType": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "purpose": { "type": "string" }, "description": { "type": "string" }, "amount_type": { "type": "string", "enum": [ "fixed", "basic_multiple" ], "default": "basic_multiple", "description": "One of: \"fixed\", \"basic_multiple\". Defaults to \"basic_multiple\" if omitted." }, "max_amount": { "type": "number" }, "min_basic_multiple": { "type": "number" }, "max_basic_multiple": { "type": "number" }, "repayment_months": { "type": "integer", "default": 6, "description": "Defaults to 6 if omitted." }, "interest_rate": { "type": "number", "default": 0, "description": "Defaults to 0 if omitted." }, "min_service_months": { "type": "integer" }, "status": { "type": "string", "enum": [ "active", "inactive" ], "default": "active", "description": "One of: \"active\", \"inactive\". Defaults to \"active\" if omitted." }, "created_at": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." } } }, "Note": { "type": "object", "properties": { "id": { "type": "integer" }, "note": { "type": "string" }, "task_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /task." }, "user_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /employee." } } }, "Notice": { "type": "object", "properties": { "id": { "type": "integer" }, "heading": { "type": "string" } } }, "Payroll": { "type": "object", "properties": { "id": { "type": "integer" }, "user_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /employee." }, "currency_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /currency." }, "company_id": { "type": "integer", "description": "Numeric id of the related company record." }, "month": { "type": "string" }, "year": { "type": "string" }, "basic_salary": { "type": "string", "default": "0", "description": "Defaults to \"0\" if omitted." }, "paid_on": { "type": "string", "format": "date", "description": "Date in YYYY-MM-DD format." }, "salary_json": { "type": "string" }, "extra_json": { "type": "string" }, "expense_claims": { "type": "string", "default": "0", "description": "Defaults to \"0\" if omitted." }, "salary_payment_method_id": { "type": "integer", "description": "Numeric id of the related salary_payment_method record." }, "monthly_salary": { "type": "number" }, "gross_salary": { "type": "number" }, "total_deductions": { "type": "number" }, "salary_from": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." }, "salary_to": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." }, "salary_group_id": { "type": "integer", "description": "Numeric id of the related salary_group record." }, "fixed_allowance": { "type": "number", "default": 0, "description": "Defaults to 0 if omitted." }, "ytd_json": { "type": "string" }, "ytd_extra_json": { "type": "string" }, "ytd_expenses": { "type": "string" }, "ytd_fixed_allowance": { "type": "string" }, "additional_earning_json": { "type": "string" }, "ytd_additional_json": { "type": "string" }, "net_salary": { "type": "string", "default": "0", "description": "Defaults to \"0\" if omitted." }, "status": { "type": "string", "enum": [ "generated", "review", "locked", "paid" ], "default": "generated", "description": "One of: \"generated\", \"review\", \"locked\", \"paid\". Defaults to \"generated\" if omitted." } } }, "Product": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string" }, "price": { "type": "string" }, "taxes": { "type": "string" } } }, "Project": { "type": "object", "properties": { "id": { "type": "integer" }, "project_name": { "type": "string" }, "project_summary": { "type": "string" }, "start_date": { "type": "string", "format": "date", "description": "Date in YYYY-MM-DD format." }, "deadline": { "type": "string", "format": "date", "description": "Date in YYYY-MM-DD format." }, "status": { "type": "string", "default": "in progress", "description": "Defaults to \"in progress\" if omitted." }, "contact_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /contact." }, "company_id": { "type": "integer", "description": "Numeric id of the related company record." } } }, "ProjectCategory": { "type": "object", "properties": { "id": { "type": "integer" }, "category_name": { "type": "string" } } }, "Subtask": { "type": "object", "properties": { "id": { "type": "integer" }, "title": { "type": "string" }, "due_date": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." }, "status": { "type": "string", "enum": [ "incomplete", "complete" ], "default": "incomplete", "description": "One of: \"incomplete\", \"complete\". Defaults to \"incomplete\" if omitted." } } }, "Task": { "type": "object", "properties": { "id": { "type": "integer" }, "heading": { "type": "string" }, "start_date": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." }, "priority": { "type": "string", "enum": [ "low", "medium", "high" ], "default": "medium", "description": "One of: \"low\", \"medium\", \"high\". Defaults to \"medium\" if omitted." }, "due_date": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." }, "is_private": { "type": "boolean", "default": false, "description": "Yes/No flag — true or false (also accepts 1 or 0). Defaults to false if omitted." }, "status": { "type": "string", "enum": [ "incomplete", "completed" ], "default": "incomplete", "description": "One of: \"incomplete\", \"completed\". Defaults to \"incomplete\" if omitted." } } }, "TaskCategory": { "type": "object", "properties": { "id": { "type": "integer" }, "title": { "type": "string" } } }, "TaskboardColumns": { "type": "object", "properties": { "id": { "type": "integer" }, "column_name": { "type": "string" }, "slug": { "type": "string" }, "label_color": { "type": "string" }, "priority": { "type": "integer" } } }, "Tax": { "type": "object", "properties": { "id": { "type": "integer" }, "tax_name": { "type": "string" }, "rate_percent": { "type": "string" } } }, "Ticket": { "type": "object", "properties": { "id": { "type": "integer" }, "subject": { "type": "string" }, "status": { "type": "string", "enum": [ "open", "pending", "resolved", "closed" ], "default": "open", "description": "One of: \"open\", \"pending\", \"resolved\", \"closed\". Defaults to \"open\" if omitted." }, "priority": { "type": "string", "enum": [ "low", "medium", "high", "urgent" ], "default": "medium", "description": "One of: \"low\", \"medium\", \"high\", \"urgent\". Defaults to \"medium\" if omitted." } } }, "TicketChannel": { "type": "object", "properties": { "id": { "type": "integer" }, "channel_name": { "type": "string" } } }, "TicketGroup": { "type": "object", "properties": { "id": { "type": "integer" }, "group_name": { "type": "string" } } }, "TicketReply": { "type": "object", "properties": { "id": { "type": "integer" }, "message": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." } } }, "TicketType": { "type": "object", "properties": { "id": { "type": "integer" }, "type": { "type": "string" } } }, "Timelog": { "type": "object", "properties": { "id": { "type": "integer" }, "start_time": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." }, "end_time": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." }, "memo": { "type": "string" }, "task_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /task." } } }, "TrackerActivity": { "type": "object", "properties": { "id": { "type": "integer" }, "user_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /employee." }, "project_time_log_id": { "type": "integer", "description": "Numeric id of the related project_time_log record." }, "interval_start": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." }, "interval_end": { "type": "string", "format": "date-time", "description": "Date & time in \"YYYY-MM-DD HH:MM:SS\" format." }, "mouse_clicks": { "type": "integer", "default": 0, "description": "Defaults to 0 if omitted." }, "key_presses": { "type": "integer", "default": 0, "description": "Defaults to 0 if omitted." }, "activity_percent": { "type": "integer", "default": 0, "description": "Defaults to 0 if omitted." }, "is_idle": { "type": "boolean", "default": false, "description": "Yes/No flag — true or false (also accepts 1 or 0). Defaults to false if omitted." } } }, "Userchat": { "type": "object", "properties": { "id": { "type": "integer" }, "from": { "type": "integer" }, "to": { "type": "integer" }, "message_seen": { "type": "string", "enum": [ "yes", "no" ], "default": "no", "description": "One of: \"yes\", \"no\". Defaults to \"no\" if omitted." }, "user_one": { "type": "integer" }, "user_id": { "type": "integer", "description": "Provide the id of the related record — list valid ids via GET /employee." }, "message": { "type": "string" } } }, "Webhook": { "type": "object", "properties": { "id": { "type": "integer" }, "webhooks_setting_id": { "type": "integer", "description": "Numeric id of the related webhooks_setting record." }, "entity": { "type": "string" }, "event": { "type": "string" } } } } } }