{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/app.corcava.com" } ], "info": { "name": "Corcava Public API Documentation", "_postman_id": "0e6370c3-8650-4b07-9ae8-67ba03ce667e", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Bill Rates", "description": "\nAPIs for managing user bill rates within projects.\n\nBill rates represent the hourly rate for a user on a specific project, effective from a given start date.\nEach user can have multiple bill rates over time, but only one active rate at any given time.", "item": [ { "name": "Display a paginated list of bill rates for a user in a project.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/projects\/:project_id\/users\/:user_id\/bill-rates", "query": [ { "key": "per_page", "value": "50", "description": "Number of results per page. Maximum: 100.", "disabled": false }, { "key": "sort", "value": "started_at", "description": "Column used for sorting.", "disabled": false }, { "key": "direction", "value": "desc", "description": "Sort direction. Allowed: asc, desc.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/projects\/:project_id\/users\/:user_id\/bill-rates?per_page=50&sort=started_at&direction=desc", "variable": [ { "id": "project_id", "key": "project_id", "value": "1", "description": "The ID of the project." }, { "id": "user_id", "key": "user_id", "value": "1", "description": "The ID of the user." }, { "id": "project", "key": "project", "value": "1", "description": "The ID of the project." }, { "id": "user", "key": "user", "value": "42", "description": "The ID of the user." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"project_id\": 1,\n \"user_id\": 42,\n \"rate\": 85.50,\n \"started_at\": \"2024-01-01T00:00:00.000000Z\",\n \"created_at\": \"2023-12-15T10:30:00.000000Z\",\n \"updated_at\": \"2023-12-15T10:30:00.000000Z\",\n \"status\": \"current\"\n },\n {\n \"id\": 2,\n \"project_id\": 1,\n \"user_id\": 42,\n \"rate\": 75.00,\n \"started_at\": \"2023-07-01T00:00:00.000000Z\",\n \"created_at\": \"2023-06-20T14:15:00.000000Z\",\n \"updated_at\": \"2023-06-20T14:15:00.000000Z\",\n \"status\": \"past\"\n }\n ],\n \"links\": {\n \"first\": \"https:\/\/example.com\/api\/v1\/projects\/1\/users\/42\/bill-rates?page=1\",\n \"last\": \"https:\/\/example.com\/api\/v1\/projects\/1\/users\/42\/bill-rates?page=2\",\n \"prev\": null,\n \"next\": \"https:\/\/example.com\/api\/v1\/projects\/1\/users\/42\/bill-rates?page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 2,\n \"path\": \"https:\/\/example.com\/api\/v1\/projects\/1\/users\/42\/bill-rates\",\n \"per_page\": 30,\n \"to\": 30,\n \"total\": 45\n }\n}", "name": "success" }, { "header": [], "code": 403, "body": "{\"message\": \"This action is unauthorized.\"}", "name": "unauthorized" } ] }, { "name": "Create a new bill rate for a user in a project.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/projects\/:project_id\/users\/:user_id\/bill-rates", "query": [], "raw": "{{baseUrl}}\/api\/v1\/projects\/:project_id\/users\/:user_id\/bill-rates", "variable": [ { "id": "project_id", "key": "project_id", "value": "1", "description": "The ID of the project." }, { "id": "user_id", "key": "user_id", "value": "1", "description": "The ID of the user." }, { "id": "project", "key": "project", "value": "1", "description": "The ID of the project." }, { "id": "user", "key": "user", "value": "42", "description": "The ID of the user." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"started_at\":\"2024-01-01\",\"rate\":\"85.50\"}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"id\": 3,\n \"project_id\": 1,\n \"user_id\": 42,\n \"rate\": 85.50,\n \"started_at\": \"2024-01-01T00:00:00.000000Z\",\n \"created_at\": \"2023-12-20T09:45:00.000000Z\",\n \"updated_at\": \"2023-12-20T09:45:00.000000Z\",\n \"status\": \"future\"\n}", "name": "success" }, { "header": [], "code": 403, "body": "{\"message\": \"This action is unauthorized.\"}", "name": "unauthorized" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"started_at\": [\"The start date already exists for this user.\"]\n }\n}", "name": "duplicate_date" } ] }, { "name": "Update a bill rate.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/projects\/:project_id\/users\/:user_id\/bill-rates\/:billRate_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/projects\/:project_id\/users\/:user_id\/bill-rates\/:billRate_id", "variable": [ { "id": "project_id", "key": "project_id", "value": "1", "description": "The ID of the project." }, { "id": "user_id", "key": "user_id", "value": "1", "description": "The ID of the user." }, { "id": "billRate_id", "key": "billRate_id", "value": "1", "description": "The ID of the billRate." }, { "id": "project", "key": "project", "value": "1", "description": "The ID of the project." }, { "id": "user", "key": "user", "value": "42", "description": "The ID of the user." }, { "id": "billRate", "key": "billRate", "value": "3", "description": "The ID of the bill rate." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"started_at\":\"2024-02-01\",\"rate\":\"90.00\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 3,\n \"project_id\": 1,\n \"user_id\": 42,\n \"rate\": 90.00,\n \"started_at\": \"2024-02-01T00:00:00.000000Z\",\n \"created_at\": \"2023-12-20T09:45:00.000000Z\",\n \"updated_at\": \"2023-12-25T11:20:00.000000Z\",\n \"status\": \"future\"\n}", "name": "success" }, { "header": [], "code": 403, "body": "{\"message\": \"This action is unauthorized.\"}", "name": "unauthorized" }, { "header": [], "code": 404, "body": "{\"message\": \"Bill rate not found for this user\"}", "name": "not_found" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"started_at\": [\"The start date already exists for this user.\"]\n }\n}", "name": "duplicate_date" } ] }, { "name": "Delete a bill rate.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/projects\/:project_id\/users\/:user_id\/bill-rates\/:billRate_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/projects\/:project_id\/users\/:user_id\/bill-rates\/:billRate_id", "variable": [ { "id": "project_id", "key": "project_id", "value": "1", "description": "The ID of the project." }, { "id": "user_id", "key": "user_id", "value": "1", "description": "The ID of the user." }, { "id": "billRate_id", "key": "billRate_id", "value": "1", "description": "The ID of the billRate." }, { "id": "project", "key": "project", "value": "1", "description": "The ID of the project." }, { "id": "user", "key": "user", "value": "42", "description": "The ID of the user." }, { "id": "billRate", "key": "billRate", "value": "3", "description": "The ID of the bill rate." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "null", "name": "success" }, { "header": [], "code": 403, "body": "{\"message\": \"This action is unauthorized.\"}", "name": "unauthorized" }, { "header": [], "code": 404, "body": "{\"message\": \"Bill rate not found for this user\"}", "name": "not_found" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"error\": [\"Current and past bill rate cannot be deleted\"]\n }\n}", "name": "cannot_delete" } ] } ] }, { "name": "Boards", "description": "\nAPIs for managing project boards.\n\nBoards group tasks inside a project. Use these endpoints to list, create, update, and delete project boards within your team.", "item": [ { "name": "Display a paginated list of project boards.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/boards", "query": [ { "key": "search", "value": "Marketing", "description": "Filter boards by partial match in the board title.", "disabled": false }, { "key": "project_id", "value": "5", "description": "Filter boards that belong to the given project id.", "disabled": false }, { "key": "per_page", "value": "50", "description": "Number of results per page. Maximum: 100.", "disabled": false }, { "key": "sort", "value": "created_at", "description": "Column used for sorting. Allowed: id, title, created_at, updated_at.", "disabled": false }, { "key": "direction", "value": "desc", "description": "Sort direction. Allowed: asc, desc.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/boards?search=Marketing&project_id=5&per_page=50&sort=created_at&direction=desc" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 10,\n \"title\": \"Marketing pipeline\",\n \"description\": \"High level marketing workflow.\",\n \"project_id\": 3,\n \"user_id\": 14,\n \"team_id\": 8,\n \"created_at\": \"2025-01-10T12:30:00.000000Z\",\n \"updated_at\": \"2025-01-10T12:30:00.000000Z\",\n \"deleted_at\": null\n }\n ],\n \"links\": {\n \"first\": \"https:\/\/example.com\/api\/v1\/boards?page=1\",\n \"last\": \"https:\/\/example.com\/api\/v1\/boards?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"path\": \"https:\/\/example.com\/api\/v1\/boards\",\n \"per_page\": 30,\n \"to\": 1,\n \"total\": 1\n }\n}", "name": "success" } ] }, { "name": "Create a new project board.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/boards", "query": [], "raw": "{{baseUrl}}\/api\/v1\/boards" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"Marketing pipeline\",\"description\":\"High level marketing workflow.\",\"project_id\":3}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"id\": 10,\n \"title\": \"Marketing pipeline\",\n \"description\": \"High level marketing workflow.\",\n \"project_id\": 3,\n \"user_id\": 14,\n \"team_id\": 8,\n \"created_at\": \"2025-01-10T12:30:00.000000Z\",\n \"updated_at\": \"2025-01-10T12:30:00.000000Z\",\n \"deleted_at\": null\n}", "name": "success" }, { "header": [], "code": 422, "body": "{\"message\": \"Project not found\"}", "name": "validation_error" } ] }, { "name": "Display a single board.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/boards\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/boards\/:id", "variable": [ { "id": "id", "key": "id", "value": "10", "description": "Board id." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 10,\n \"title\": \"Marketing pipeline\",\n \"description\": \"High level marketing workflow.\",\n \"project_id\": 3,\n \"user_id\": 14,\n \"team_id\": 8,\n \"created_at\": \"2025-01-10T12:30:00.000000Z\",\n \"updated_at\": \"2025-01-10T12:30:00.000000Z\",\n \"deleted_at\": null\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" } ] }, { "name": "Update a board.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/boards\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/boards\/:id", "variable": [ { "id": "id", "key": "id", "value": "10", "description": "Board id." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"Marketing pipeline\",\"description\":\"High level marketing workflow.\",\"project_id\":3}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 10,\n \"title\": \"Marketing pipeline\",\n \"description\": \"High level marketing workflow.\",\n \"project_id\": 3,\n \"user_id\": 14,\n \"team_id\": 8,\n \"created_at\": \"2025-01-10T12:30:00.000000Z\",\n \"updated_at\": \"2025-01-10T16:45:00.000000Z\",\n \"deleted_at\": null\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" } ] }, { "name": "Delete a board.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/boards\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/boards\/:id", "variable": [ { "id": "id", "key": "id", "value": "10", "description": "Board id." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "null", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" } ] }, { "name": "Export board activity with time tracking data.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/boards\/:id\/export-activity", "query": [ { "key": "start_date", "value": "2025-01-01", "description": "Start date for the export range (YYYY-MM-DD).", "disabled": false }, { "key": "end_date", "value": "2025-01-31", "description": "End date for the export range (YYYY-MM-DD).", "disabled": false }, { "key": "group_by", "value": "member", "description": "Grouping option: 'member' or 'task'.", "disabled": false }, { "key": "time_format", "value": "hms", "description": "Time format: 'seconds' (integer) or 'hms' (HH:MM:SS string). Defaults to 'seconds'.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/boards\/:id\/export-activity?start_date=2025-01-01&end_date=2025-01-31&group_by=member&time_format=hms", "variable": [ { "id": "id", "key": "id", "value": "10", "description": "Board id." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"start_date\":\"2026-09-15T03:18:22\",\"end_date\":\"2052-10-08\",\"group_by\":\"task\",\"time_format\":\"seconds\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"john doe\": [\n {\"task\": \"Marketing campaign\", \"time\": 7200},\n {\"task\": \"Website redesign\", \"time\": 3600}\n ],\n \"jane smith\": [\n {\"task\": \"Marketing campaign\", \"time\": 5400}\n ]\n}", "name": "grouped_by_member_seconds" }, { "header": [], "code": 200, "body": "{\n \"Marketing campaign\": [\n {\"member\": \"john doe\", \"time\": \"02:00:00\"},\n {\"member\": \"jane smith\", \"time\": \"01:30:00\"}\n ],\n \"Website redesign\": [\n {\"member\": \"john doe\", \"time\": \"01:00:00\"}\n ]\n}", "name": "grouped_by_task_hms" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" }, { "header": [], "code": 422, "body": "{\"message\": \"Invalid parameters\"}", "name": "validation_error" } ] }, { "name": "List columns for a board.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/boards\/:board_id\/columns", "query": [], "raw": "{{baseUrl}}\/api\/v1\/boards\/:board_id\/columns", "variable": [ { "id": "board_id", "key": "board_id", "value": "10", "description": "Board id." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"To Do\",\n \"is_todo\": true,\n \"is_done\": false,\n \"project_board_id\": 10,\n \"team_id\": 1,\n \"order\": 0\n },\n {\n \"id\": 2,\n \"name\": \"In Progress\",\n \"is_todo\": false,\n \"is_done\": false,\n \"project_board_id\": 10,\n \"team_id\": 1,\n \"order\": 1\n }\n ]\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Board not found\"}", "name": "not_found" } ] }, { "name": "Create a new column in a board.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/boards\/:board_id\/columns", "query": [], "raw": "{{baseUrl}}\/api\/v1\/boards\/:board_id\/columns", "variable": [ { "id": "board_id", "key": "board_id", "value": "10", "description": "Board id." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"To Do\",\"is_todo\":true,\"is_done\":false,\"order\":0}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"data\": {\n \"id\": 5,\n \"name\": \"To Do\",\n \"is_todo\": true,\n \"is_done\": false,\n \"project_board_id\": 10,\n \"team_id\": 1,\n \"order\": 0\n }\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Board not found\"}", "name": "not_found" } ] }, { "name": "Update a column.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/boards\/:board_id\/columns\/:column_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/boards\/:board_id\/columns\/:column_id", "variable": [ { "id": "board_id", "key": "board_id", "value": "10", "description": "Board id." }, { "id": "column_id", "key": "column_id", "value": "5", "description": "Column id." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"In Progress\",\"is_todo\":false,\"is_done\":false,\"order\":1}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 5,\n \"name\": \"In Progress\",\n \"is_todo\": false,\n \"is_done\": false,\n \"project_board_id\": 10,\n \"team_id\": 1,\n \"order\": 1\n }\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Column not found\"}", "name": "not_found" } ] }, { "name": "Delete a column.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/boards\/:board_id\/columns\/:column_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/boards\/:board_id\/columns\/:column_id", "variable": [ { "id": "board_id", "key": "board_id", "value": "10", "description": "Board id." }, { "id": "column_id", "key": "column_id", "value": "5", "description": "Column id." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "null", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Column not found\"}", "name": "not_found" }, { "header": [], "code": 422, "body": "{\"message\": \"Cannot delete column with tasks. Move or delete tasks first.\"}", "name": "has_tasks" } ] } ] }, { "name": "CRM Emails", "description": "\nOne-to-one CRM email drafts and send for contacts (Gmail).", "item": [ { "name": "List CRM emails (drafts or sent).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/emails", "query": [ { "key": "status", "value": "draft", "description": "Filter by status: draft, sent, failed, queued.", "disabled": false }, { "key": "contact_id", "value": "15", "description": "Filter by contact id.", "disabled": false }, { "key": "per_page", "value": "20", "description": "Results per page (max 50).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/emails?status=draft&contact_id=15&per_page=20" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "X-Inertia" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "set-cookie", "value": "XSRF-TOKEN=eyJpdiI6Ill1NmpLRlo4VFo0YXNFRy9GUjlpcnc9PSIsInZhbHVlIjoidTFmd09aWkI3czZYNFI4OWFpZ3VqQWtUcEVUMFo1d1VGR2doOG1oWUd1bjRnUXEvUUZUd245dzFDdUlKY3JOU0dMaFIwVERVamcybTdYaFRrNzRneElYZXZqTzdpMlQyY3RvNUpQSFQ4d2xUQ3RES1lqYnVBOVppMVVzZlZKYUEiLCJtYWMiOiI3MGFmNzhiY2IxMjc0YmI1ZDc0YzhkZGMxYWFhNGUxZjRlZTdjZjQyZmM2OTE2OTdjZTY2N2Y4MTE2MjMzMzZhIiwidGFnIjoiIn0%3D; expires=Thu, 17 Sep 2026 03:18:23 GMT; Max-Age=172800; path=\/; secure; samesite=lax; corcava_session=eyJpdiI6IkRVaDc0T1JaTk42bnlDOU1YN0dHNEE9PSIsInZhbHVlIjoiSEVUUmFwT3ZwNVduWmdjUGloc1NKcFJCcFc4MjQzdWppYjlSc3Y3d2sva3IzUDRNTGtuYlRpME9SbllhU2NRZFROUHBWZ2h3SXE1M1FLMXc0dW00VGNiNTNtWXc3UXdpYkNORVdiQkFQN0FoSnJDd3BhN3NQZWFVTGI4ZG83SGUiLCJtYWMiOiJmZTBlMjM3OGU0ZGU3MGZmZDA3MGI3MTBkNTM1ODQyYzg5Yzc4YTMwMTk3ZmU5MTIxMmJhMGRjM2IwYWUzMmRlIiwidGFnIjoiIn0%3D; expires=Thu, 17 Sep 2026 03:18:23 GMT; Max-Age=172800; path=\/; secure; httponly; samesite=lax" } ], "code": 401, "body": "{\"message\":\"Invalid API Key\"}", "name": "" } ] }, { "name": "Show a CRM email.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/emails\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/emails\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the email." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "X-Inertia" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "set-cookie", "value": "XSRF-TOKEN=eyJpdiI6ImZYMENsalJDMlduejZjM2xzbzJDdFE9PSIsInZhbHVlIjoidUNaT2JFM2FqVmFWR3kzZE5lR1pSR1A3V3FhYUNxK1E1T0JWWUovZ3lTYS9oTkVkbDNJZXdsWkIrTEkyVnExZjhqQklGZ1FjcTFBNm5nWXVPc3cwR2pLZmpZWTNxRFE3akhkMG44NEtFak5UYUxkNFljSjV2R2pSUjczZzZVd2MiLCJtYWMiOiJlNjM4ODVkNjA2ZjI5YThiY2M5NTYwZGZlZjYzNDBlODJlODIzZTA4MzI5NWU2ODYyMjBmNDM3ODEyY2UyNzg5IiwidGFnIjoiIn0%3D; expires=Thu, 17 Sep 2026 03:18:23 GMT; Max-Age=172800; path=\/; secure; samesite=lax; corcava_session=eyJpdiI6IjhBdlgzWnhLdVFubWRiVDNKRjZiM1E9PSIsInZhbHVlIjoiN1N1aDJELzNyNXBwWTFXeitVWkZMMUR3NU5QYnNCWHpkYk5hOXdxQUZ3K241S29oZktrMGlmcVh6MW50UXZqZXVJcDR5dUpMN2FkUUtWNnBpdGpuMHVOS21nRy80Q1ljVnJVL2N5TzdPWmJ2WDUxQVBLZFh5cUZPd3kvQkVmMlEiLCJtYWMiOiIyODdhZjFlZjk1MjQ1YTUwY2ZjNGNkMDc4ODBiNzNkYTVjZDVhOGZiNjY5YTZkNDRkYmE2ZGUxZWIxZTA1YzdkIiwidGFnIjoiIn0%3D; expires=Thu, 17 Sep 2026 03:18:23 GMT; Max-Age=172800; path=\/; secure; httponly; samesite=lax" } ], "code": 401, "body": "{\"message\":\"Invalid API Key\"}", "name": "" } ] }, { "name": "Update a draft email.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/emails\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/emails\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the email." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "to", "value": "b", "type": "text", "description": "Must be a valid email address. Must not be greater than 255 characters." }, { "key": "subject", "value": "n", "type": "text", "description": "Must not be greater than 500 characters." }, { "key": "body", "value": "g", "type": "text", "description": "Must not be greater than 50000 characters." }, { "key": "scheduled_at", "value": "z", "type": "text", "description": "Must not be greater than 64 characters." }, { "key": "cc[0]", "value": "m", "type": "text", "description": "" }, { "key": "bcc[0]", "value": "i", "type": "text", "description": "" }, { "key": "remove_attachment_ids[0]", "value": "16", "type": "text", "description": "" }, { "key": "attachments[]", "src": [], "type": "file" }, { "key": "_method", "value": "PUT", "type": "text" } ] }, "description": "" }, "response": [] }, { "name": "Cancel (discard) a draft email.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/emails\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/emails\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the email." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Create a draft email for a contact.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/emails\/draft", "query": [], "raw": "{{baseUrl}}\/api\/v1\/emails\/draft" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "contact_id", "value": "15", "type": "text", "description": "Contact to associate the draft with. This field is required when none of reply_to_incoming_email_id<\/code> and contact_ref<\/code> are present. The id<\/code> of an existing record in the contacts table." }, { "key": "contact_ref[id]", "value": "16", "type": "text", "description": "" }, { "key": "contact_ref[email]", "value": "zbailey@example.net", "type": "text", "description": "" }, { "key": "to", "value": "alex@example.com", "type": "text", "description": "Recipient email. Defaults to the contact email when omitted. Must be a valid email address. Must not be greater than 255 characters." }, { "key": "subject", "value": "Following up", "type": "text", "description": "Email subject line. Must not be greater than 500 characters." }, { "key": "body", "value": "

Hi Alex,<\/p>

Thanks for your note.<\/p>", "type": "text", "description": "HTML message body. Use separate

tags per paragraph; use

    \/
      with
    1. for lists (not inline hyphens). Do not wrap the entire email in one

      . Corcava renders HTML as received. Must not be greater than 50000 characters." }, { "key": "mailbox_id", "value": "3", "type": "text", "description": "Mailbox id to send from. Uses the default mailbox when omitted." }, { "key": "from_mailbox", "value": "sales@company.com", "type": "text", "description": "Send-from mailbox email address (alternative to mailbox_id). Must be a valid email address. Must not be greater than 255 characters." }, { "key": "from", "value": "i", "type": "text", "description": "Must be a valid email address. Must not be greater than 255 characters." }, { "key": "scheduled_at", "value": "2026-07-29T09:00:00+00:00", "type": "text", "description": "Optional ISO 8601 datetime to schedule the send. Must not be greater than 64 characters." }, { "key": "cc[0]", "value": "y", "type": "text", "description": "" }, { "key": "bcc[0]", "value": "v", "type": "text", "description": "" }, { "key": "reply_to_incoming_email_id", "value": "45678", "type": "text", "description": "Link draft as a reply to this incoming CRM email id. The id<\/code> of an existing record in the incoming_emails table." }, { "key": "reply_to_outgoing_email_id", "value": "12345", "type": "text", "description": "Link draft as a reply to this sent CRM email id. The id<\/code> of an existing record in the outgoing_emails table." }, { "key": "remove_attachment_ids[0]", "value": "16", "type": "text", "description": "" }, { "key": "attachments[]", "src": [], "type": "file" } ] }, "description": "" }, "response": [] }, { "name": "AI-generate a reply or new email draft (subject + body). Does not save \u2014 use POST \/emails\/draft to persist.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/emails\/generate-draft", "query": [], "raw": "{{baseUrl}}\/api\/v1\/emails\/generate-draft" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"contact_id\":15,\"instruction\":\"Reply warmly and propose a call next week.\",\"thread_key\":\"thread:abc123\",\"sender_email\":\"alex@example.com\",\"reply_to_incoming_email_id\":45678,\"reply_to_outgoing_email_id\":12345}" }, "description": "" }, "response": [] }, { "name": "Schedule a draft email for future send (RFC 3339 with offset required).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/emails\/:email_id\/schedule", "query": [], "raw": "{{baseUrl}}\/api\/v1\/emails\/:email_id\/schedule", "variable": [ { "id": "email_id", "key": "email_id", "value": "1", "description": "The ID of the email." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"scheduled_at\":\"b\"}" }, "description": "" }, "response": [] }, { "name": "Clear schedule on a draft\/scheduled email (returns to normal draft).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/emails\/:email_id\/unschedule", "query": [], "raw": "{{baseUrl}}\/api\/v1\/emails\/:email_id\/unschedule", "variable": [ { "id": "email_id", "key": "email_id", "value": "1", "description": "The ID of the email." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Send a draft email via the connected Gmail mailbox.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/emails\/:email_id\/send", "query": [], "raw": "{{baseUrl}}\/api\/v1\/emails\/:email_id\/send", "variable": [ { "id": "email_id", "key": "email_id", "value": "1", "description": "The ID of the email." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "CRM Inbox", "description": "\nRead synced Gmail inbox threads for reply drafting via MCP \/ Public API.", "item": [ { "name": "List inbox contact\/sender groups with thread previews.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/inbox", "query": [ { "key": "search", "value": "acme", "description": "Filter by sender name, email, subject, or body preview.", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false }, { "key": "per_page", "value": "20", "description": "Results per page (max 50).", "disabled": false }, { "key": "view", "value": "inbox", "description": "Inbox or archived.", "disabled": false }, { "key": "inbox_filter", "value": "unanswered", "description": "Inbox filter: all, unread, or unanswered.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/inbox?search=acme&page=1&per_page=20&view=inbox&inbox_filter=unanswered" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"inbox_filter\":\"unanswered\",\"mailbox_ids\":[16]}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "X-Inertia" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "set-cookie", "value": "XSRF-TOKEN=eyJpdiI6ImlIUnNONUhDZytuWHNHREw5YTQrd2c9PSIsInZhbHVlIjoiTlVQOERYVWorVkVvcUJvWDh6OFNORXhOU2wyMU5VV3VaSkNUcGxNaWVyV01vbDg2MGdUTGN1NXRwREMvcVhaU0lqeUNMVWJaY2JwM2N0dTlNdEZLejZUeUhXZ1AxOU41R1BFc2t5WXhQUzV4UFo3cnFWZ2VBMFB0NVZ1b2ZRRHQiLCJtYWMiOiJiNzczYmU0YTBlNzM0NTIyMjE1NTA0ZGY1YjAzNzQyNGViYjVmZTg5NDZhN2U3Nzc2OGE2NTgxNmRkMmIyMmIzIiwidGFnIjoiIn0%3D; expires=Thu, 17 Sep 2026 03:18:23 GMT; Max-Age=172800; path=\/; secure; samesite=lax; corcava_session=eyJpdiI6InFvMS85UzZnUytBQ1dIMXFMeFRwR1E9PSIsInZhbHVlIjoiWFhKOXdKWTNVQUNFY3k3YmNEQXpsVlNnLzUrb0JFVjJiWkF3SWFmTUhDeUhUcVNWWHNRaGtwUXcxVGo1K0x2SHNsdXVLamRBRVVpQURqdjl4SXBNdkZHb1pXNTlSM2wyUkxGMXUvVCsxQjgvelA4cFZjcVNuNmtPY1Z3TUxBWW0iLCJtYWMiOiJjNTJlNTNiM2I0ZjMzMzU2NWRjNjMzMzAxMmU1NDE3NzZmYzRjMWQ1MjUyNTJiYTkzMGI1M2EzMGY1YTgwYWUxIiwidGFnIjoiIn0%3D; expires=Thu, 17 Sep 2026 03:18:23 GMT; Max-Age=172800; path=\/; secure; httponly; samesite=lax" } ], "code": 401, "body": "{\"message\":\"Invalid API Key\"}", "name": "" } ] }, { "name": "Resolve inbox reply context from an incoming message id (human URL: \/crm-emails\/inbox\/reply?incoming=\u2026).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/inbox\/reply", "query": [ { "key": "incoming", "value": "45678", "description": "Incoming email id.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/inbox\/reply?incoming=45678" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"incoming\":16}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "X-Inertia" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "set-cookie", "value": "XSRF-TOKEN=eyJpdiI6IkRxOTFpY1Bsd1ZjK1RuVm5ZVE9wRVE9PSIsInZhbHVlIjoiZWlnTEtPTFZtaitRRTBoaUp0ZTRtWitDTUxKem5XVXRKaHFCYVBWSnZFL2p2YzFHWmhQbGpiQXZJbkxCVWNXT01DTU54NjU3cENqZzA0ZlVoMHN6VDVtd0tFUzZZNnlOYTBiajh4L2JSNGdITE5WNlBzd3gzNjZTaFZoMEtBYzIiLCJtYWMiOiIwOGMwYWM0MTBhMDAyNjI0MTE5YjQ0MjAxZDMyMjAwNzA1ODAxY2I0ZjVkZDY2ZDlkNzBkNmQyOTM3YzI5YmQ2IiwidGFnIjoiIn0%3D; expires=Thu, 17 Sep 2026 03:18:23 GMT; Max-Age=172800; path=\/; secure; samesite=lax; corcava_session=eyJpdiI6ImRJbWlacUNYV3hPNW5CUS9MbXhsSEE9PSIsInZhbHVlIjoiM3p2YW05QVRUWVVjUUwzN3NoVEF6RFFQaVFPZkVBNks1NXJhSnhsVmNkdkxYTnNmOWVMUFBGZzkybGJ0MTVEUHlHUWdrd3FDeHZFWUhBeGg4TGRENDBwZ0MvYVdodDVLMGRxRy9BL2ZtWmpuRFVpd2VuVDJkb1ZMSjdwanBDQ3AiLCJtYWMiOiJlOTQ2MWNmZTFjNjIxNGM2OWFiODA4ZTc0ZmI5Yzk3NzVkMDVjNmE1YjBmOTMyZjY4MGUwYzMyY2EwMDBkZmY0IiwidGFnIjoiIn0%3D; expires=Thu, 17 Sep 2026 03:18:23 GMT; Max-Age=172800; path=\/; secure; httponly; samesite=lax" } ], "code": 401, "body": "{\"message\":\"Invalid API Key\"}", "name": "" } ] }, { "name": "Get full thread detail (incoming + sent messages in thread).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/inbox\/threads", "query": [ { "key": "thread_key", "value": "thread%3Aabc123", "description": "Thread key from list inbox.", "disabled": false }, { "key": "from", "value": "alex%40example.com", "description": "Sender email (preferred).", "disabled": false }, { "key": "sender_scope", "value": "s%3Aalex%40example.com", "description": "Legacy sender scope from list inbox.", "disabled": false }, { "key": "view", "value": "inbox", "description": "Inbox or archived.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/inbox\/threads?thread_key=thread%3Aabc123&from=alex%40example.com&sender_scope=s%3Aalex%40example.com&view=inbox" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"thread_key\":\"b\",\"sender_scope\":\"n\",\"view\":\"inbox\"}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "X-Inertia" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "set-cookie", "value": "XSRF-TOKEN=eyJpdiI6ImZXS2d5Y0pZdGMrZkQ2MXlQZ0RPVnc9PSIsInZhbHVlIjoiSG51MU9SRkh5WEdzQWNhR1NKd2NIY0JwZkF5Q3p3ZGFqYWc0ZnQ4bUwzOVBTRUFLVTFwenhtdGJiM2ZYSks3cVRUczFZZ21heS9GUFhHR2VvKy9nQUlNYjZNeHRxamh5eHg4NHFoSEdXNEhuZDRqWktrRVBJM2dKTEhsQ2dBelYiLCJtYWMiOiJlYjg0OGM0ZTQwM2MzYTY4ZTUwZjg0Y2FkYTUxY2MxYjYwYWViZjQyZTY5Y2I0YzVjYTg4YjhkYzc2YmE1NzBiIiwidGFnIjoiIn0%3D; expires=Thu, 17 Sep 2026 03:18:23 GMT; Max-Age=172800; path=\/; secure; samesite=lax; corcava_session=eyJpdiI6InZXMUVYbGRHMWYzTHVkeHdmaFNkOWc9PSIsInZhbHVlIjoiV2JkZTRVTndiMzRjZHhEdWxGekdWY2NZM2s3Wi9CenJUOTV2b2tVRXgxTllOR3oxZXA0VW1aZHVVOEh0VkErb1FPbjc5SWRiRG84M3ZzRFQxN2hsMlViUVdsTFpCWEgxSVNkYVk3aUthckZCN2RvdW9zUGZMV0ZKM0pkK0pWOWEiLCJtYWMiOiIxNzYxZjE3Y2I4YTA2Njc5OGNhNDEzNTM3NWNjYjRkZmI4MjFhOTg3ZWQyNjc1Y2ViZTI0NTgwN2UwZjRmNWI2IiwidGFnIjoiIn0%3D; expires=Thu, 17 Sep 2026 03:18:23 GMT; Max-Age=172800; path=\/; secure; httponly; samesite=lax" } ], "code": 401, "body": "{\"message\":\"Invalid API Key\"}", "name": "" } ] } ] }, { "name": "Clients", "description": "\nAPIs for managing clients.\n\nClients represent organisations you collaborate with. These endpoints let you list, create, update, and delete clients that belong to your team.", "item": [ { "name": "Display a paginated list of clients.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/clients", "query": [ { "key": "search", "value": "ACME", "description": "Filter clients by company, contact name, email, or phone.", "disabled": false }, { "key": "user_id", "value": "12", "description": "Filter clients by owner id.", "disabled": false }, { "key": "is_stripe", "value": "1", "description": "Filter by Stripe integration flag.", "disabled": false }, { "key": "is_crypto_payments", "value": "", "description": "Filter by crypto payments flag.", "disabled": true }, { "key": "per_page", "value": "50", "description": "Number of results per page. Maximum: 100.", "disabled": false }, { "key": "sort", "value": "created_at", "description": "Column used for sorting. Allowed: id, company_name, created_at, updated_at.", "disabled": false }, { "key": "direction", "value": "desc", "description": "Sort direction. Allowed: asc, desc.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/clients?search=ACME&user_id=12&is_stripe=1&is_crypto_payments=&per_page=50&sort=created_at&direction=desc" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 4,\n \"company_name\": \"ACME Inc.\",\n \"contact_name\": \"Alex Johnson\",\n \"display_name\": \"ACME Inc.\",\n \"currency_id\": 1,\n \"phone\": \"+1 202 555 0147\",\n \"email\": \"billing@acme.inc\",\n \"address_1\": \"123 Main St\",\n \"address_2\": null,\n \"zip\": \"10001\",\n \"country\": \"USA\",\n \"city\": \"New York\",\n \"stripe_id\": null,\n \"is_crypto_payments\": false,\n \"is_stripe\": false,\n \"notes\": \"Key enterprise account.\",\n \"user_id\": 12,\n \"team_id\": 8,\n \"created_at\": \"2025-01-10T08:00:00.000000Z\",\n \"updated_at\": \"2025-01-10T08:00:00.000000Z\",\n \"deleted_at\": null\n }\n ],\n \"links\": {\n \"first\": \"https:\/\/example.com\/api\/v1\/clients?page=1\",\n \"last\": \"https:\/\/example.com\/api\/v1\/clients?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"path\": \"https:\/\/example.com\/api\/v1\/clients\",\n \"per_page\": 30,\n \"to\": 1,\n \"total\": 1\n }\n}", "name": "success" } ] }, { "name": "Create a new client.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/clients", "query": [], "raw": "{{baseUrl}}\/api\/v1\/clients" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"company_name\":\"ACME Inc.\",\"contact_name\":\"Alex Johnson\",\"currency_id\":1,\"phone\":\"+1 202 555 0147\",\"email\":\"billing@acme.inc\",\"address_1\":\"123 Main St\",\"address_2\":\"Suite 502\",\"zip\":\"10001\",\"country\":\"USA\",\"city\":\"New York\",\"stripe_id\":\"cus_abc123\",\"is_crypto_payments\":false,\"is_stripe\":true,\"notes\":\"Key enterprise account.\",\"user_id\":12,\"tag_names\":[\"n\"],\"add_tag_names\":[\"g\"],\"remove_tag_names\":[\"z\"],\"create_missing_tags\":false}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"id\": 4,\n \"company_name\": \"ACME Inc.\",\n \"contact_name\": \"Alex Johnson\",\n \"display_name\": \"ACME Inc.\",\n \"currency_id\": 1,\n \"phone\": \"+1 202 555 0147\",\n \"email\": \"billing@acme.inc\",\n \"address_1\": \"123 Main St\",\n \"address_2\": null,\n \"zip\": \"10001\",\n \"country\": \"USA\",\n \"city\": \"New York\",\n \"stripe_id\": null,\n \"is_crypto_payments\": false,\n \"is_stripe\": false,\n \"notes\": \"Key enterprise account.\",\n \"user_id\": 12,\n \"team_id\": 8,\n \"created_at\": \"2025-01-10T08:00:00.000000Z\",\n \"updated_at\": \"2025-01-10T08:00:00.000000Z\",\n \"deleted_at\": null\n}", "name": "success" } ] }, { "name": "Display a single client.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/clients\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/clients\/:id", "variable": [ { "id": "id", "key": "id", "value": "4", "description": "Client id." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 4,\n \"company_name\": \"ACME Inc.\",\n \"contact_name\": \"Alex Johnson\",\n \"display_name\": \"ACME Inc.\",\n \"currency_id\": 1,\n \"phone\": \"+1 202 555 0147\",\n \"email\": \"billing@acme.inc\",\n \"address_1\": \"123 Main St\",\n \"address_2\": null,\n \"zip\": \"10001\",\n \"country\": \"USA\",\n \"city\": \"New York\",\n \"stripe_id\": null,\n \"is_crypto_payments\": false,\n \"is_stripe\": false,\n \"notes\": \"Key enterprise account.\",\n \"user_id\": 12,\n \"team_id\": 8,\n \"created_at\": \"2025-01-10T08:00:00.000000Z\",\n \"updated_at\": \"2025-01-10T08:00:00.000000Z\",\n \"deleted_at\": null\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" } ] }, { "name": "Update a client.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/clients\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/clients\/:id", "variable": [ { "id": "id", "key": "id", "value": "4", "description": "Client id." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"company_name\":\"ACME Inc.\",\"contact_name\":\"Alex Johnson\",\"currency_id\":1,\"phone\":\"+1 202 555 0147\",\"email\":\"billing@acme.inc\",\"address_1\":\"123 Main St\",\"address_2\":\"Suite 502\",\"zip\":\"10001\",\"country\":\"USA\",\"city\":\"New York\",\"stripe_id\":\"cus_abc123\",\"is_crypto_payments\":false,\"is_stripe\":true,\"notes\":\"Key enterprise account.\",\"user_id\":12,\"tag_names\":[\"n\"],\"add_tag_names\":[\"g\"],\"remove_tag_names\":[\"z\"],\"create_missing_tags\":true}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 4,\n \"company_name\": \"ACME Inc.\",\n \"contact_name\": \"Alex Johnson\",\n \"display_name\": \"ACME Inc.\",\n \"currency_id\": 1,\n \"phone\": \"+1 202 555 0147\",\n \"email\": \"billing@acme.inc\",\n \"address_1\": \"123 Main St\",\n \"address_2\": null,\n \"zip\": \"10001\",\n \"country\": \"USA\",\n \"city\": \"New York\",\n \"stripe_id\": null,\n \"is_crypto_payments\": false,\n \"is_stripe\": false,\n \"notes\": \"Key enterprise account.\",\n \"user_id\": 12,\n \"team_id\": 8,\n \"created_at\": \"2025-01-10T08:00:00.000000Z\",\n \"updated_at\": \"2025-01-10T11:30:00.000000Z\",\n \"deleted_at\": null\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" } ] }, { "name": "Delete a client.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/clients\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/clients\/:id", "variable": [ { "id": "id", "key": "id", "value": "4", "description": "Client id." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Soft-deletes the client. Linked contacts are detached (client_id set to null),\nnot deleted." }, "response": [ { "header": [], "code": 204, "body": "null", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" } ] } ] }, { "name": "Contact Notes", "description": "\nAPIs for managing notes attached to contacts.\n\nThese endpoints let you list, create, update, and delete notes for a specific contact.", "item": [ { "name": "Display a paginated list of notes for a contact.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/contacts\/:contact_id\/notes", "query": [ { "key": "per_page", "value": "20", "description": "Number of results per page. Maximum: 100. Default: 30.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/contacts\/:contact_id\/notes?per_page=20", "variable": [ { "id": "contact_id", "key": "contact_id", "value": "1", "description": "The ID of the contact." }, { "id": "contact", "key": "contact", "value": "15", "description": "Contact ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 7,\n \"contact_id\": 15,\n \"user_id\": 12,\n \"text\": \"Meeting scheduled for next Tuesday to discuss project requirements.\",\n \"created_at\": \"2025-01-15T10:30:00.000000Z\",\n \"updated_at\": \"2025-01-15T10:30:00.000000Z\"\n },\n {\n \"id\": 6,\n \"contact_id\": 15,\n \"user_id\": 8,\n \"text\": \"Client requested a callback regarding pricing.\",\n \"created_at\": \"2025-01-14T14:20:00.000000Z\",\n \"updated_at\": \"2025-01-14T14:20:00.000000Z\"\n }\n ],\n \"links\": {\n \"first\": \"https:\/\/example.com\/api\/v1\/contacts\/15\/notes?page=1\",\n \"last\": \"https:\/\/example.com\/api\/v1\/contacts\/15\/notes?page=2\",\n \"prev\": null,\n \"next\": \"https:\/\/example.com\/api\/v1\/contacts\/15\/notes?page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 2,\n \"path\": \"https:\/\/example.com\/api\/v1\/contacts\/15\/notes\",\n \"per_page\": 20,\n \"to\": 20,\n \"total\": 35\n }\n}", "name": "success" } ] }, { "name": "Create a new note for a contact.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/contacts\/:contact_id\/notes", "query": [], "raw": "{{baseUrl}}\/api\/v1\/contacts\/:contact_id\/notes", "variable": [ { "id": "contact_id", "key": "contact_id", "value": "1", "description": "The ID of the contact." }, { "id": "contact", "key": "contact", "value": "15", "description": "Contact ID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"text\":\"Meeting scheduled for next Tuesday to discuss project requirements.\"}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"id\": 7,\n \"contact_id\": 15,\n \"user_id\": 12,\n \"text\": \"Meeting scheduled for next Tuesday to discuss project requirements.\",\n \"created_at\": \"2025-01-15T10:30:00.000000Z\",\n \"updated_at\": \"2025-01-15T10:30:00.000000Z\"\n}", "name": "success" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"text\": [\n \"The text field is required.\"\n ]\n }\n}", "name": "validation_error" } ] }, { "name": "Update a contact note.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/contacts\/:contact_id\/notes\/:note_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/contacts\/:contact_id\/notes\/:note_id", "variable": [ { "id": "contact_id", "key": "contact_id", "value": "1", "description": "The ID of the contact." }, { "id": "note_id", "key": "note_id", "value": "1", "description": "The ID of the note." }, { "id": "contact", "key": "contact", "value": "15", "description": "Contact ID." }, { "id": "note", "key": "note", "value": "7", "description": "Note ID." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"text\":\"Meeting rescheduled to Wednesday due to client availability.\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 7,\n \"contact_id\": 15,\n \"user_id\": 12,\n \"text\": \"Meeting rescheduled to Wednesday due to client availability.\",\n \"created_at\": \"2025-01-15T10:30:00.000000Z\",\n \"updated_at\": \"2025-01-16T09:15:00.000000Z\"\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"text\": [\n \"The text field is required.\"\n ]\n }\n}", "name": "validation_error" } ] }, { "name": "Delete contact note.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/contacts\/:contact_id\/notes\/:note_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/contacts\/:contact_id\/notes\/:note_id", "variable": [ { "id": "contact_id", "key": "contact_id", "value": "1", "description": "The ID of the contact." }, { "id": "note_id", "key": "note_id", "value": "1", "description": "The ID of the note." }, { "id": "contact", "key": "contact", "value": "15", "description": "Contact ID." }, { "id": "note", "key": "note", "value": "7", "description": "Note ID." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "null", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" } ] } ] }, { "name": "Contact Tasks", "description": "\nAPIs for managing tasks related to a contact.\n\nThese endpoints allow you to list, create, update, and delete tasks\nthat are associated with a specific contact.", "item": [ { "name": "Display a paginated list of contact tasks.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/contacts\/:contact_id\/tasks", "query": [ { "key": "per_page", "value": "30", "description": "Number of results per page. Maximum: 100.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/contacts\/:contact_id\/tasks?per_page=30", "variable": [ { "id": "contact_id", "key": "contact_id", "value": "1", "description": "The ID of the contact." }, { "id": "contact", "key": "contact", "value": "15", "description": "Contact id." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 3,\n \"contact_id\": 15,\n \"user_id\": 7,\n \"due_at\": \"2025-02-01T12:00:00.000000Z\",\n \"created_at\": \"2025-01-10T08:00:00.000000Z\",\n \"updated_at\": \"2025-01-10T08:00:00.000000Z\"\n }\n ],\n \"links\": {\n \"first\": \"https:\/\/example.com\/api\/v1\/contacts\/15\/tasks?page=1\",\n \"last\": \"https:\/\/example.com\/api\/v1\/contacts\/15\/tasks?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"path\": \"https:\/\/example.com\/api\/v1\/contacts\/15\/tasks\",\n \"per_page\": 30,\n \"to\": 1,\n \"total\": 1\n }\n}", "name": "success" } ] }, { "name": "Create a new task for a contact.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/contacts\/:contact_id\/tasks", "query": [], "raw": "{{baseUrl}}\/api\/v1\/contacts\/:contact_id\/tasks", "variable": [ { "id": "contact_id", "key": "contact_id", "value": "1", "description": "The ID of the contact." }, { "id": "contact", "key": "contact", "value": "15", "description": "Contact id." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"description\":\"Eius et animi quos velit et.\",\"status\":\"v\",\"due_at\":\"2025-02-01T12:00:00Z\"}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"id\": 3,\n \"contact_id\": 15,\n \"user_id\": 7,\n \"due_at\": \"2025-02-01T12:00:00.000000Z\",\n \"created_at\": \"2025-01-10T08:00:00.000000Z\",\n \"updated_at\": \"2025-01-10T08:00:00.000000Z\"\n}", "name": "success" } ] }, { "name": "Update a contact task.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/contacts\/:contact_id\/tasks\/:task_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/contacts\/:contact_id\/tasks\/:task_id", "variable": [ { "id": "contact_id", "key": "contact_id", "value": "1", "description": "The ID of the contact." }, { "id": "task_id", "key": "task_id", "value": "8", "description": "The ID of the task." }, { "id": "contact", "key": "contact", "value": "15", "description": "Contact id." }, { "id": "task", "key": "task", "value": "3", "description": "Task id." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"description\":\"Eius et animi quos velit et.\",\"status\":\"v\",\"due_at\":\"2025-02-05T09:00:00Z\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 3,\n \"contact_id\": 15,\n \"user_id\": 7,\n \"due_at\": \"2025-02-05T09:00:00.000000Z\",\n \"created_at\": \"2025-01-10T08:00:00.000000Z\",\n \"updated_at\": \"2025-01-11T10:30:00.000000Z\"\n}", "name": "success" } ] }, { "name": "Delete a contact task.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/contacts\/:contact_id\/tasks\/:task_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/contacts\/:contact_id\/tasks\/:task_id", "variable": [ { "id": "contact_id", "key": "contact_id", "value": "1", "description": "The ID of the contact." }, { "id": "task_id", "key": "task_id", "value": "8", "description": "The ID of the task." }, { "id": "contact", "key": "contact", "value": "15", "description": "Contact id." }, { "id": "task", "key": "task", "value": "3", "description": "Task id." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "null", "name": "success" } ] } ] }, { "name": "Contacts", "description": "\nAPIs for managing contacts.\n\nContacts represent people related to your clients. Use these endpoints to list, create, update, and delete contacts within your team.", "item": [ { "name": "Display a paginated list of contacts.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/contacts", "query": [ { "key": "search", "value": "John+Doe", "description": "Filter contacts by name (including full name), email, phone, or company.", "disabled": false }, { "key": "client_id", "value": "4", "description": "Filter contacts by client id.", "disabled": false }, { "key": "user_id", "value": "12", "description": "Filter contacts by owner id.", "disabled": false }, { "key": "per_page", "value": "50", "description": "Number of results per page. Maximum: 100.", "disabled": false }, { "key": "sort", "value": "created_at", "description": "Column used for sorting. Allowed: id, first_name, last_name, created_at, updated_at.", "disabled": false }, { "key": "direction", "value": "desc", "description": "Sort direction. Allowed: asc, desc.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/contacts?search=John+Doe&client_id=4&user_id=12&per_page=50&sort=created_at&direction=desc" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 21,\n \"client_id\": 4,\n \"first_name\": \"Alex\",\n \"last_name\": \"Johnson\",\n \"display_name\": \"Alex Johnson\",\n \"company_name\": \"ACME Inc.\",\n \"website\": \"https:\/\/acme.inc\",\n \"email\": \"alex@acme.inc\",\n \"phone\": \"+1 202 555 0147\",\n \"user_id\": 12,\n \"team_id\": 8,\n \"skype\": null,\n \"telegram\": \"@alex\",\n \"linkedin\": \"https:\/\/linkedin.com\/in\/alex\",\n \"birth_date\": \"1992-09-15\",\n \"last_contacted_at\": \"2025-01-10T15:00:00.000000Z\",\n \"address_line_1\": \"123 Main St\",\n \"city\": \"New York\",\n \"zip\": \"10001\",\n \"country\": \"USA\",\n \"description\": \"Primary decision maker\",\n \"goal\": \"Close enterprise deal by Q3\",\n \"outreach_id\": null,\n \"company_id\": null,\n \"custom_fields\": {\n \"extra emails\": \"a@x.com, b@y.com\",\n \"foo-bar\": \"c@z.com\"\n },\n \"created_at\": \"2025-01-10T08:00:00.000000Z\",\n \"updated_at\": \"2025-01-10T15:00:00.000000Z\",\n \"deleted_at\": null\n }\n ],\n \"links\": {\n \"first\": \"https:\/\/example.com\/api\/v1\/contacts?page=1\",\n \"last\": \"https:\/\/example.com\/api\/v1\/contacts?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"path\": \"https:\/\/example.com\/api\/v1\/contacts\",\n \"per_page\": 50,\n \"to\": 1,\n \"total\": 1\n }\n}", "name": "success" } ] }, { "name": "Create a new contact.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/contacts", "query": [], "raw": "{{baseUrl}}\/api\/v1\/contacts" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"first_name\":\"Alex\",\"last_name\":\"Johnson\",\"company_name\":\"ACME Inc.\",\"website\":\"https:\\\/\\\/acme.inc\",\"client_id\":4,\"email\":\"alex@acme.inc\",\"phone\":\"+1 202 555 0147\",\"user_id\":12,\"skype\":\"j\",\"telegram\":\"@alex\",\"linkedin\":\"https:\\\/\\\/linkedin.com\\\/in\\\/alex\",\"birth_date\":\"2026-09-15T03:18:22\",\"last_contacted_at\":\"2026-09-15T03:18:22\",\"address_line_1\":\"k\",\"city\":\"h\",\"zip\":\"w\",\"country\":\"a\",\"description\":\"Primary decision maker\",\"goal\":\"Close enterprise deal by Q3\",\"outreach_id\":16,\"company_id\":16,\"custom_fields\":{\"extra emails\":\"a@x.com, b@y.com\",\"foo-bar\":\"c@z.com\"},\"client_ref\":{\"id\":16,\"name\":\"n\"},\"tag_names\":[\"g\"],\"add_tag_names\":[\"z\"],\"remove_tag_names\":[\"m\"],\"create_missing_tags\":true}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"id\": 21,\n \"client_id\": 4,\n \"first_name\": \"Alex\",\n \"last_name\": \"Johnson\",\n \"display_name\": \"Alex Johnson\",\n \"company_name\": \"ACME Inc.\",\n \"website\": \"https:\/\/acme.inc\",\n \"email\": \"alex@acme.inc\",\n \"phone\": \"+1 202 555 0147\",\n \"user_id\": 12,\n \"team_id\": 8,\n \"skype\": null,\n \"telegram\": \"@alex\",\n \"linkedin\": \"https:\/\/linkedin.com\/in\/alex\",\n \"birth_date\": \"1992-09-15\",\n \"last_contacted_at\": null,\n \"address_line_1\": \"123 Main St\",\n \"city\": \"New York\",\n \"zip\": \"10001\",\n \"country\": \"USA\",\n \"description\": \"Primary decision maker\",\n \"goal\": \"Close enterprise deal by Q3\",\n \"outreach_id\": null,\n \"company_id\": null,\n \"custom_fields\": {\n \"extra emails\": \"a@x.com, b@y.com\",\n \"foo-bar\": \"c@z.com\"\n },\n \"created_at\": \"2025-01-10T08:00:00.000000Z\",\n \"updated_at\": \"2025-01-10T08:00:00.000000Z\",\n \"deleted_at\": null\n}", "name": "success" }, { "header": [], "code": 422, "body": "{\"message\": \"Client not found\"}", "name": "validation_error" } ] }, { "name": "Display a single contact.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/contacts\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/contacts\/:id", "variable": [ { "id": "id", "key": "id", "value": "21", "description": "Contact id." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 21,\n \"client_id\": 4,\n \"first_name\": \"Alex\",\n \"last_name\": \"Johnson\",\n \"display_name\": \"Alex Johnson\",\n \"company_name\": \"ACME Inc.\",\n \"website\": \"https:\/\/acme.inc\",\n \"email\": \"alex@acme.inc\",\n \"phone\": \"+1 202 555 0147\",\n \"user_id\": 12,\n \"team_id\": 8,\n \"skype\": null,\n \"telegram\": \"@alex\",\n \"linkedin\": \"https:\/\/linkedin.com\/in\/alex\",\n \"birth_date\": \"1992-09-15\",\n \"last_contacted_at\": \"2025-01-10T15:00:00.000000Z\",\n \"address_line_1\": \"123 Main St\",\n \"city\": \"New York\",\n \"zip\": \"10001\",\n \"country\": \"USA\",\n \"description\": \"Primary decision maker\",\n \"goal\": \"Close enterprise deal by Q3\",\n \"outreach_id\": null,\n \"company_id\": null,\n \"custom_fields\": {\n \"extra emails\": \"a@x.com, b@y.com\",\n \"foo-bar\": \"c@z.com\"\n },\n \"created_at\": \"2025-01-10T08:00:00.000000Z\",\n \"updated_at\": \"2025-01-10T15:00:00.000000Z\",\n \"deleted_at\": null\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" } ] }, { "name": "Update a contact.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/contacts\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/contacts\/:id", "variable": [ { "id": "id", "key": "id", "value": "21", "description": "Contact id." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"first_name\":\"Alex\",\"last_name\":\"Johnson\",\"company_name\":\"g\",\"website\":\"z\",\"client_id\":4,\"email\":\"alex@acme.inc\",\"phone\":\"+1 202 555 0147\",\"user_id\":12,\"skype\":\"j\",\"telegram\":\"n\",\"linkedin\":\"i\",\"birth_date\":\"2026-09-15T03:18:22\",\"last_contacted_at\":\"2026-09-15T03:18:22\",\"address_line_1\":\"k\",\"city\":\"h\",\"zip\":\"w\",\"country\":\"a\",\"description\":\"Primary decision maker\",\"goal\":\"Close enterprise deal by Q3\",\"outreach_id\":16,\"company_id\":16,\"custom_fields\":{\"extra emails\":\"a@x.com, b@y.com\"},\"client_ref\":{\"id\":16,\"name\":\"n\"},\"tag_names\":[\"g\"],\"add_tag_names\":[\"z\"],\"remove_tag_names\":[\"m\"],\"create_missing_tags\":true}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 21,\n \"client_id\": 4,\n \"first_name\": \"Alex\",\n \"last_name\": \"Johnson\",\n \"display_name\": \"Alex Johnson\",\n \"company_name\": \"ACME Inc.\",\n \"website\": \"https:\/\/acme.inc\",\n \"email\": \"alex@acme.inc\",\n \"phone\": \"+1 202 555 0147\",\n \"user_id\": 12,\n \"team_id\": 8,\n \"skype\": null,\n \"telegram\": \"@alex\",\n \"linkedin\": \"https:\/\/linkedin.com\/in\/alex\",\n \"birth_date\": \"1992-09-15\",\n \"last_contacted_at\": \"2025-01-10T15:00:00.000000Z\",\n \"address_line_1\": \"123 Main St\",\n \"city\": \"New York\",\n \"zip\": \"10001\",\n \"country\": \"USA\",\n \"description\": \"Primary decision maker\",\n \"goal\": \"Close enterprise deal by Q3\",\n \"outreach_id\": null,\n \"company_id\": null,\n \"custom_fields\": {\n \"extra emails\": \"a@x.com, b@y.com\",\n \"foo-bar\": \"c@z.com\"\n },\n \"created_at\": \"2025-01-10T08:00:00.000000Z\",\n \"updated_at\": \"2025-01-10T18:30:00.000000Z\",\n \"deleted_at\": null\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" } ] }, { "name": "Delete a contact.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/contacts\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/contacts\/:id", "variable": [ { "id": "id", "key": "id", "value": "21", "description": "Contact id." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "null", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" } ] } ] }, { "name": "Custom Fields", "description": "\nAPIs for managing custom field definitions.\n\nCustom fields allow teams to define additional structured data\nthat can be attached to various entities across the system.", "item": [ { "name": "Display a paginated list of custom fields.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/custom-fields", "query": [ { "key": "per_page", "value": "50", "description": "Number of results per page. Maximum: 100.", "disabled": false }, { "key": "sort", "value": "created_at", "description": "Column used for sorting. Allowed: id, created_at, updated_at.", "disabled": false }, { "key": "direction", "value": "desc", "description": "Sort direction. Allowed: asc, desc.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/custom-fields?per_page=50&sort=created_at&direction=desc" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"priority\",\n \"label\": \"Priority\",\n \"team_id\": 8,\n \"created_at\": \"2025-01-10T08:00:00.000000Z\",\n \"updated_at\": \"2025-01-10T08:00:00.000000Z\"\n }\n ],\n \"links\": {\n \"first\": \"https:\/\/example.com\/api\/v1\/custom-fields?page=1\",\n \"last\": \"https:\/\/example.com\/api\/v1\/custom-fields?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"path\": \"https:\/\/example.com\/api\/v1\/custom-fields\",\n \"per_page\": 30,\n \"to\": 1,\n \"total\": 1\n }\n}", "name": "success" } ] }, { "name": "Create a new custom field.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/custom-fields", "query": [], "raw": "{{baseUrl}}\/api\/v1\/custom-fields" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"priority\",\"type\":\"string\"}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"id\": 1,\n \"name\": \"priority\",\n \"label\": \"Priority\",\n \"team_id\": 8,\n \"created_at\": \"2025-01-10T08:00:00.000000Z\",\n \"updated_at\": \"2025-01-10T08:00:00.000000Z\"\n}", "name": "success" } ] }, { "name": "Update a custom field.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/custom-fields\/:field_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/custom-fields\/:field_id", "variable": [ { "id": "field_id", "key": "field_id", "value": "3", "description": "The ID of the field." }, { "id": "field", "key": "field", "value": "1", "description": "Custom field id." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"priority\",\"type\":\"string\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 1,\n \"name\": \"priority\",\n \"label\": \"Priority\",\n \"team_id\": 8,\n \"created_at\": \"2025-01-10T08:00:00.000000Z\",\n \"updated_at\": \"2025-01-11T10:30:00.000000Z\"\n}", "name": "success" } ] }, { "name": "Delete a custom field.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/custom-fields\/:customField_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/custom-fields\/:customField_id", "variable": [ { "id": "customField_id", "key": "customField_id", "value": "3", "description": "The ID of the customField." }, { "id": "customField", "key": "customField", "value": "1", "description": "Custom field id." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "null", "name": "success" } ] } ] }, { "name": "Deal Flow Columns", "description": "\nAPIs for managing deal pipeline columns\/stages.\n\nDeal flow columns represent stages in a sales or deal pipeline. These endpoints let you list, create, update, reorder, and delete columns that belong to your team.", "item": [ { "name": "Display a paginated list of deal flow columns.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/deal-columns", "query": [ { "key": "name", "value": "Proposal", "description": "Filter columns by name.", "disabled": false }, { "key": "sort", "value": "order", "description": "Column used for sorting. Allowed: id, name, order, created_at, updated_at.", "disabled": false }, { "key": "direction", "value": "asc", "description": "Sort direction. Allowed: asc, desc.", "disabled": false }, { "key": "per_page", "value": "50", "description": "Number of results per page. Maximum: 100.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/deal-columns?name=Proposal&sort=order&direction=asc&per_page=50" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Qualified Lead\",\n \"board_id\": 5,\n \"team_id\": 8,\n \"deal_probability\": \"30%\",\n \"order\": 0,\n \"created_at\": \"2025-01-10T08:00:00.000000Z\",\n \"updated_at\": \"2025-01-10T08:00:00.000000Z\",\n \"deleted_at\": null\n },\n {\n \"id\": 2,\n \"name\": \"Proposal Made\",\n \"board_id\": 5,\n \"team_id\": 8,\n \"deal_probability\": \"50%\",\n \"order\": 1,\n \"created_at\": \"2025-01-10T08:00:00.000000Z\",\n \"updated_at\": \"2025-01-10T08:00:00.000000Z\",\n \"deleted_at\": null\n }\n ],\n \"links\": {\n \"first\": \"https:\/\/example.com\/api\/v1\/deal-columns?page=1\",\n \"last\": \"https:\/\/example.com\/api\/v1\/deal-columns?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"path\": \"https:\/\/example.com\/api\/v1\/deal-columns\",\n \"per_page\": 30,\n \"to\": 2,\n \"total\": 2\n }\n}", "name": "success" } ] }, { "name": "Create a new deal flow column.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/deal-columns", "query": [], "raw": "{{baseUrl}}\/api\/v1\/deal-columns" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Proposal Made\",\"board_id\":5,\"deal_probability\":\"50%\",\"order\":2}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"data\": {\n \"id\": 3,\n \"name\": \"Proposal Made\",\n \"board_id\": 5,\n \"team_id\": 8,\n \"deal_probability\": \"50%\",\n \"order\": 2,\n \"created_at\": \"2025-01-10T10:00:00.000000Z\",\n \"updated_at\": \"2025-01-10T10:00:00.000000Z\",\n \"deleted_at\": null\n },\n \"message\": \"Column created successfully\"\n}", "name": "success" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"name\": [\"The name field is required.\"],\n \"board_id\": [\"The selected board id is invalid.\"]\n }\n}", "name": "validation_error" } ] }, { "name": "Update a deal flow column.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/deal-columns\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/deal-columns\/:id", "variable": [ { "id": "id", "key": "id", "value": "3", "description": "Column ID." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Proposal Submitted\",\"board_id\":5,\"deal_probability\":\"60%\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 3,\n \"name\": \"Proposal Submitted\",\n \"board_id\": 5,\n \"team_id\": 8,\n \"deal_probability\": \"60%\",\n \"order\": 3,\n \"created_at\": \"2025-01-10T10:00:00.000000Z\",\n \"updated_at\": \"2025-01-10T11:30:00.000000Z\",\n \"deleted_at\": null\n },\n \"message\": \"Column updated successfully\"\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Column not found\"\n}", "name": "not_found" } ] }, { "name": "Delete a deal flow column.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/deal-columns\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/deal-columns\/:id", "variable": [ { "id": "id", "key": "id", "value": "3", "description": "Column ID." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Column deleted successfully\"\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Column not found\"\n}", "name": "not_found" } ] }, { "name": "Reorder a deal flow column.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/deal-columns\/:id\/order", "query": [], "raw": "{{baseUrl}}\/api\/v1\/deal-columns\/:id\/order", "variable": [ { "id": "id", "key": "id", "value": "3", "description": "Column ID." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"order\":1}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 3,\n \"name\": \"Proposal Made\",\n \"board_id\": 5,\n \"team_id\": 8,\n \"deal_probability\": \"50%\",\n \"order\": 1,\n \"created_at\": \"2025-01-10T10:00:00.000000Z\",\n \"updated_at\": \"2025-01-10T12:00:00.000000Z\",\n \"deleted_at\": null\n },\n \"message\": \"Column order updated successfully\"\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Column not found\"\n}", "name": "not_found" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"order\": [\"The order field is required.\"]\n }\n}", "name": "validation_error" } ] } ] }, { "name": "Deals Management", "description": "\nAPIs for managing deals\n\nThis controller provides endpoints to create, read, update, delete, and manage the order of deals within the system.", "item": [ { "name": "Display a paginated listing of deals.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/deals", "query": [ { "key": "search", "value": "b", "description": "Must not be greater than 500 characters.", "disabled": false }, { "key": "user_id", "value": "16", "description": "", "disabled": false }, { "key": "column_id", "value": "16", "description": "", "disabled": false }, { "key": "contact_id", "value": "16", "description": "", "disabled": false }, { "key": "date_from", "value": "2026-09-15T03%3A18%3A22", "description": "Must be a valid date.", "disabled": false }, { "key": "date_to", "value": "2026-09-15T03%3A18%3A22", "description": "Must be a valid date.", "disabled": false }, { "key": "sort", "value": "name", "description": "", "disabled": false }, { "key": "direction", "value": "desc", "description": "", "disabled": false }, { "key": "per_page", "value": "22", "description": "Must be at least 1. Must not be greater than 100.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/deals?search=b&user_id=16&column_id=16&contact_id=16&date_from=2026-09-15T03%3A18%3A22&date_to=2026-09-15T03%3A18%3A22&sort=name&direction=desc&per_page=22" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Big Deal\",\n \"slug\": \"big-deal\",\n \"outreach_id\": 3,\n \"company_id\": 7,\n \"contact_id\": 15,\n \"user_id\": 5,\n \"team_id\": 2,\n \"description\": \"This is a very important deal.\",\n \"column_id\": 4,\n \"closed_at\": \"2024-05-01T00:00:00.000000Z\",\n \"amount\": \"10000.00\",\n \"order\": 1,\n \"created_at\": \"2024-04-01T12:00:00.000000Z\",\n \"updated_at\": \"2024-04-15T15:30:00.000000Z\",\n \"deleted_at\": null\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 3,\n \"per_page\": 30,\n \"to\": 30,\n \"total\": 75\n }\n }", "name": "success" }, { "header": [], "code": 401, "body": "{\"message\": \"Unauthenticated.\"}", "name": "unauthenticated" }, { "header": [], "code": 403, "body": "{\"message\": \"This action is unauthorized.\"}", "name": "forbidden" } ] }, { "name": "Display the specified deal.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/deals\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/deals\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the deal." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 1,\n \"name\": \"Big Deal\",\n \"slug\": \"big-deal\",\n \"outreach_id\": 3,\n \"company_id\": 7,\n \"contact_id\": 15,\n \"user_id\": 5,\n \"team_id\": 2,\n \"description\": \"This is a very important deal.\",\n \"column_id\": 4,\n \"closed_at\": \"2024-05-01T00:00:00.000000Z\",\n \"amount\": \"10000.00\",\n \"order\": 1,\n \"created_at\": \"2024-04-01T12:00:00.000000Z\",\n \"updated_at\": \"2024-04-15T15:30:00.000000Z\",\n \"deleted_at\": null\n}", "name": "success" }, { "header": [], "code": 401, "body": "{\"message\": \"Unauthenticated.\"}", "name": "unauthenticated" }, { "header": [], "code": 403, "body": "{\"message\": \"This action is unauthorized", "name": "forbidden" }, { "header": [], "code": 404, "body": "{\"message\": \"Deal not found.\"}", "name": "not_found" } ] }, { "name": "Store a newly created deal in storage.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/deals", "query": [], "raw": "{{baseUrl}}\/api\/v1\/deals" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"\\\"New Deal\\\"\",\"description\":\"\\\"This deal is very promising.\\\"\",\"closed_at\":\"\\\"2024-06-30\\\"\",\"outreach_id\":3,\"contact_id\":15,\"company_id\":7,\"amount\":\"\\\"5000.00\\\"\",\"column_id\":4,\"user_id\":5,\"attachments\":[\"architecto\"]}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"id\": 2,\n \"name\": \"New Deal\",\n \"slug\": \"new-deal\",\n \"outreach_id\": 3,\n \"company_id\": 7,\n \"contact_id\": 15,\n \"user_id\": 5,\n \"team_id\": 2,\n \"description\": \"This deal is very promising.\",\n \"column_id\": 4,\n \"closed_at\": \"2024-06-30T00:00:00.000000Z\",\n \"amount\": \"5000.00\",\n \"order\": 2,\n \"created_at\": \"2024-05-01T10:00:00.000000Z\",\n \"updated_at\": \"2024-05-01T10:00:00.000000Z\",\n \"deleted_at\": null\n}", "name": "created" }, { "header": [], "code": 400, "body": "{\"message\": \"The given data was invalid.\", \"errors\": {\"name\": [\"The name field is required.\"]}}", "name": "validation_error" }, { "header": [], "code": 401, "body": "{\"message\": \"Unauthenticated.\"}", "name": "unauthenticated" }, { "header": [], "code": 403, "body": "{\"message\": \"This action is unauthorized.\"}", "name": "forbidden" } ] }, { "name": "Update the specified deal in storage.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/deals\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/deals\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the deal." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"\\\"Updated Deal Name\\\"\",\"description\":\"\\\"Updated description.\\\"\",\"closed_at\":\"\\\"2024-07-15\\\"\",\"outreach_id\":4,\"contact_id\":16,\"company_id\":8,\"amount\":\"\\\"7500.00\\\"\",\"user_id\":6,\"attachments\":[\"architecto\"]}" }, "description": "To change column or position, use PUT deals\/{id}\/order (column_id is not accepted here)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 1,\n \"name\": \"Updated Deal Name\",\n \"slug\": \"updated-deal-name\",\n \"outreach_id\": 4,\n \"company_id\": 8,\n \"contact_id\": 16,\n \"user_id\": 6,\n \"team_id\": 2,\n \"description\": \"Updated description.\",\n \"column_id\": 5,\n \"closed_at\": \"2024-07-15T00:00:00.000000Z\",\n \"amount\": \"7500.00\",\n \"order\": 1,\n \"created_at\": \"2024-04-01T12:00:00.000000Z\",\n \"updated_at\": \"2024-05-10T14:20:00.000000Z\",\n \"deleted_at\": null\n}", "name": "success" }, { "header": [], "code": 400, "body": "{\"message\": \"The given data was invalid.\", \"errors\": {\"name\": [\"The name field must not be greater than 255 characters.\"]}}", "name": "validation_error" }, { "header": [], "code": 401, "body": "{\"message\": \"Unauthenticated.\"}", "name": "unauthenticated" }, { "header": [], "code": 403, "body": "{\"message\": \"This action is unauthorized.\"}", "name": "forbidden" }, { "header": [], "code": 404, "body": "{\"message\": \"Deal not found.\"}", "name": "not_found" } ] }, { "name": "Remove the specified deal from storage.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/deals\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/deals\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the deal." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"message\": \"Deal deleted successfully.\"}", "name": "success" }, { "header": [], "code": 401, "body": "{\"message\": \"Unauthenticated.\"}", "name": "unauthenticated" }, { "header": [], "code": 403, "body": "{\"message\": \"This action is unauthorized.\"}", "name": "forbidden" }, { "header": [], "code": 404, "body": "{\"message\": \"Deal not found.\"}", "name": "not_found" } ] }, { "name": "Update the order of the specified deal.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/deals\/order", "query": [], "raw": "{{baseUrl}}\/api\/v1\/deals\/order", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the deal." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"order\":3,\"column_id\":2}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\": { ...deal data... }, \"message\": \"Deal order updated successfully.\"}", "name": "success" }, { "header": [], "code": 400, "body": "{\"message\": \"The given data was invalid.\", \"errors\": {\"order\": [\"The order field is required.\"]}}", "name": "validation_error" }, { "header": [], "code": 401, "body": "{\"message\": \"Unauthenticated.\"}", "name": "unauthenticated" }, { "header": [], "code": 403, "body": "{\"message\": \"This action is unauthorized.\"}", "name": "forbidden" }, { "header": [], "code": 404, "body": "{\"message\": \"Deal not found.\"}", "name": "not_found" } ] }, { "name": "PUT api\/v1\/deals\/{id}\/order", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/deals\/:id\/order", "query": [], "raw": "{{baseUrl}}\/api\/v1\/deals\/:id\/order", "variable": [ { "id": "id", "key": "id", "value": "2070", "description": "The ID of the deal." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] } ] }, { "name": "Email Campaigns", "description": "\nAPIs for managing email marketing campaigns.\n\nEmail campaigns allow you to create scheduled email messages,\nconfigure their content (template or text editor),\nand send them to selected recipients.", "item": [ { "name": "Display a paginated list of email campaigns.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/email-campaigns", "query": [ { "key": "per_page", "value": "20", "description": "Number of results per page. Maximum: 100.", "disabled": false }, { "key": "sort", "value": "created_at", "description": "Column used for sorting. Allowed: created_at, updated_at.", "disabled": false }, { "key": "direction", "value": "desc", "description": "Sort direction. Allowed: asc, desc.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/email-campaigns?per_page=20&sort=created_at&direction=desc" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 12,\n \"user_id\": 5,\n \"team_id\": 3,\n \"email_template_id\": 7,\n \"name\": \"January Newsletter\",\n \"scheduled_at\": \"2025-02-01T10:00:00.000000Z\",\n \"email_type\": \"template\",\n \"text_editor\": null,\n \"created_at\": \"2025-01-20T08:30:00.000000Z\",\n \"updated_at\": \"2025-01-20T08:30:00.000000Z\"\n }\n ],\n \"links\": {\n \"first\": \"https:\/\/example.com\/api\/v1\/email-campaigns?page=1\",\n \"last\": \"https:\/\/example.com\/api\/v1\/email-campaigns?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"path\": \"https:\/\/example.com\/api\/v1\/email-campaigns\",\n \"per_page\": 10,\n \"to\": 1,\n \"total\": 1\n }\n}", "name": "success" } ] }, { "name": "Display a single email campaign.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/email-campaigns\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/email-campaigns\/:id", "variable": [ { "id": "id", "key": "id", "value": "12", "description": "Email campaign id." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 12,\n \"user_id\": 5,\n \"team_id\": 3,\n \"email_template_id\": 7,\n \"name\": \"January Newsletter\",\n \"scheduled_at\": \"2025-02-01T10:00:00.000000Z\",\n \"email_type\": \"template\",\n \"text_editor\": null,\n \"created_at\": \"2025-01-20T08:30:00.000000Z\",\n \"updated_at\": \"2025-01-20T08:30:00.000000Z\"\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" } ] }, { "name": "Create a new email campaign.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/email-campaigns", "query": [], "raw": "{{baseUrl}}\/api\/v1\/email-campaigns" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"January Newsletter\",\"scheduled_at\":\"2025-02-01T10:00:00Z\",\"email_type\":\"template\",\"email_template_id\":7,\"text_editor\":\"Hello, this is our newsletter.\"}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"id\": 12,\n \"user_id\": 5,\n \"team_id\": 3,\n \"email_template_id\": 7,\n \"name\": \"January Newsletter\",\n \"scheduled_at\": \"2025-02-01T10:00:00.000000Z\",\n \"email_type\": \"template\",\n \"text_editor\": null,\n \"created_at\": \"2025-01-20T08:30:00.000000Z\",\n \"updated_at\": \"2025-01-20T08:30:00.000000Z\"\n}", "name": "success" } ] }, { "name": "Update an existing email campaign.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/email-campaigns\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/email-campaigns\/:id", "variable": [ { "id": "id", "key": "id", "value": "12", "description": "Email campaign id." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"February Newsletter\",\"scheduled_at\":\"2025-02-15T10:00:00Z\",\"email_type\":\"text_editor\",\"email_template_id\":7,\"text_editor\":\"architecto\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 12,\n \"name\": \"February Newsletter\",\n \"email_type\": \"text_editor\",\n \"scheduled_at\": \"2025-02-15T10:00:00.000000Z\",\n \"updated_at\": \"2025-01-25T09:00:00.000000Z\"\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" } ] }, { "name": "Delete an email campaign.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/email-campaigns\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/email-campaigns\/:id", "variable": [ { "id": "id", "key": "id", "value": "12", "description": "Email campaign id." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "null", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" } ] }, { "name": "Send an email campaign.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/email-campaigns\/:id\/send", "query": [], "raw": "{{baseUrl}}\/api\/v1\/email-campaigns\/:id\/send", "variable": [ { "id": "id", "key": "id", "value": "12", "description": "Email campaign id." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Email campaign sent successfully\"\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" } ] } ] }, { "name": "Email Templates", "description": "\nAPIs for managing email templates.\n\nEmail templates are reusable messages that belong to a team and can be used\nfor sending emails across the system.", "item": [ { "name": "Display a paginated list of email templates.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/email-templates", "query": [ { "key": "per_page", "value": "10", "description": "Number of results per page. Maximum: 100.", "disabled": false }, { "key": "sort", "value": "created_at", "description": "Column used for sorting. Allowed: created_at, updated_at.", "disabled": false }, { "key": "direction", "value": "desc", "description": "Sort direction. Allowed: asc, desc.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/email-templates?per_page=10&sort=created_at&direction=desc" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 5,\n \"template_name\": \"Invoice Reminder\",\n \"template_html\": \"...<\/html>\",\n \"design_object\": \"{}\",\n \"created_at\": \"2025-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2025-01-15T10:00:00.000000Z\"\n }\n ],\n \"links\": {\n \"first\": \"https:\/\/example.com\/api\/v1\/email-templates?page=1\",\n \"last\": \"https:\/\/example.com\/api\/v1\/email-templates?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"path\": \"https:\/\/example.com\/api\/v1\/email-templates\",\n \"per_page\": 10,\n \"to\": 1,\n \"total\": 1\n }\n}", "name": "success" } ] }, { "name": "Display a single email template.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/email-templates\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/email-templates\/:id", "variable": [ { "id": "id", "key": "id", "value": "5", "description": "Email template id." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 5,\n \"template_name\": \"Invoice Reminder\",\n \"template_html\": \"...<\/html>\",\n \"design_object\": \"{}\",\n \"created_at\": \"2025-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2025-01-15T10:00:00.000000Z\"\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" } ] }, { "name": "Create a new email template.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/email-templates", "query": [], "raw": "{{baseUrl}}\/api\/v1\/email-templates" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"template_name\":\"Invoice Reminder\",\"template_html\":\"...<\\\/html>\",\"design_object\":\"{}\"}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"id\": 5,\n \"template_name\": \"Invoice Reminder\",\n \"template_html\": \"...<\/html>\",\n \"design_object\": \"{}\",\n \"created_at\": \"2025-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2025-01-15T10:00:00.000000Z\"\n}", "name": "success" } ] }, { "name": "Update an existing email template.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/email-templates\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/email-templates\/:id", "variable": [ { "id": "id", "key": "id", "value": "5", "description": "Email template id." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"template_name\":\"Updated Invoice Reminder\",\"template_html\":\"updated<\\\/html>\",\"design_object\":\"{}\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 5,\n \"template_name\": \"Updated Invoice Reminder\",\n \"template_html\": \"updated<\/html>\",\n \"design_object\": \"{}\",\n \"created_at\": \"2025-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2025-01-15T11:30:00.000000Z\"\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" } ] }, { "name": "Delete an email template.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/email-templates\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/email-templates\/:id", "variable": [ { "id": "id", "key": "id", "value": "5", "description": "Email template id." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "null", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" } ] } ] }, { "name": "Endpoints", "description": "", "item": [ { "name": "Display a paginated list of invoices.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/invoices", "query": [ { "key": "search", "value": "INV-001", "description": "Filter invoices by invoice number or client name.", "disabled": false }, { "key": "client_id", "value": "1", "description": "Filter invoices by client ID.", "disabled": false }, { "key": "status", "value": "1", "description": "Filter by status (0=draft, 1=sent, 2=closed, 3=cancelled, 4=open).", "disabled": false }, { "key": "date_from", "value": "2024-01-01", "description": "date Filter by creation date (from). Format: YYYY-MM-DD.", "disabled": false }, { "key": "date_to", "value": "2024-12-31", "description": "date Filter by creation date (to). Format: YYYY-MM-DD.", "disabled": false }, { "key": "sort", "value": "created_at", "description": "Column used for sorting. Allowed: id, number, amount, created_at, updated_at, issue_date, due_date.", "disabled": false }, { "key": "direction", "value": "desc", "description": "Sort direction. Allowed: asc, desc.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Number of results per page. Maximum: 100. Default: 50.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/invoices?search=INV-001&client_id=1&status=1&date_from=2024-01-01&date_to=2024-12-31&sort=created_at&direction=desc&per_page=25" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"hash\": \"abc123def456\",\n \"currency_id\": 1,\n \"random_number\": 123456,\n \"status\": 1,\n \"exchange_coefficient\": 1.0,\n \"amount\": 1000.50,\n \"amount_base_currency\": 1000.50,\n \"paid_amount\": 500.00,\n \"paid_amount_base_currency\": 500.00,\n \"outstanding_amount\": 500.50,\n \"outstanding_amount_base_currency\": 500.50,\n \"client_id\": 1,\n \"user_id\": 12,\n \"team_id\": 8,\n \"from_company_id\": null,\n \"discount\": 0,\n \"tax1\": 0,\n \"tax2\": 0,\n \"issue_date\": \"2024-01-15\",\n \"due_date\": \"2024-02-15\",\n \"notes\": \"Invoice for development services\",\n \"number\": \"INV-001\",\n \"interval_date\": null,\n \"email\": \"client@example.com\",\n \"stripe_external_id\": null,\n \"stripe_invoice_url\": null,\n \"passim_invoice_url\": null,\n \"invoiced_at\": \"2024-01-15T10:30:00.000000Z\",\n \"created_at\": \"2024-01-15T10:30:00.000000Z\",\n \"updated_at\": \"2024-01-15T10:30:00.000000Z\",\n \"deleted_at\": null,\n \"payment_amount_paid\": 500.50\n },\n {\n \"id\": 2,\n \"hash\": \"def456ghi789\",\n \"currency_id\": 1,\n \"random_number\": 789012,\n \"status\": 0,\n \"exchange_coefficient\": 1.0,\n \"amount\": 1500.00,\n \"amount_base_currency\": 1500.00,\n \"paid_amount\": 0.00,\n \"paid_amount_base_currency\": 0.00,\n \"outstanding_amount\": 1500.00,\n \"outstanding_amount_base_currency\": 1500.00,\n \"client_id\": 2,\n \"user_id\": 12,\n \"team_id\": 8,\n \"from_company_id\": null,\n \"discount\": 10,\n \"tax1\": 20,\n \"tax2\": 5,\n \"issue_date\": \"2024-01-20\",\n \"due_date\": \"2024-02-20\",\n \"notes\": \"Monthly retainer invoice\",\n \"number\": \"INV-002\",\n \"interval_date\": null,\n \"email\": \"client2@example.com\",\n \"stripe_external_id\": null,\n \"stripe_invoice_url\": null,\n \"passim_invoice_url\": null,\n \"invoiced_at\": \"2024-01-20T14:45:00.000000Z\",\n \"created_at\": \"2024-01-20T14:45:00.000000Z\",\n \"updated_at\": \"2024-01-20T14:45:00.000000Z\",\n \"deleted_at\": null,\n \"payment_amount_paid\": 0.00\n }\n ],\n \"links\": {\n \"first\": \"https:\/\/example.com\/api\/v1\/invoices?page=1\",\n \"last\": \"https:\/\/example.com\/api\/v1\/invoices?page=3\",\n \"prev\": null,\n \"next\": \"https:\/\/example.com\/api\/v1\/invoices?page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 3,\n \"path\": \"https:\/\/example.com\/api\/v1\/invoices\",\n \"per_page\": 50,\n \"to\": 50,\n \"total\": 125\n }\n}", "name": "success" } ] }, { "name": "Create a new invoice.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/invoices", "query": [], "raw": "{{baseUrl}}\/api\/v1\/invoices" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"client_id\":1,\"currency_id\":1,\"status\":0,\"amount\":\"1000.50\",\"issue_date\":\"2024-01-15\",\"due_date\":\"2024-02-15\",\"notes\":\"\\\"Invoice for development services\\\"\",\"number\":\"\\\"INV-001\\\"\",\"discount\":10,\"tax1\":20,\"tax2\":5,\"email\":\"\\\"client@example.com\\\"\",\"items\":[\"architecto\"]}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"data\": {\n \"id\": 3,\n \"hash\": \"ghi789jkl012\",\n \"currency_id\": 1,\n \"random_number\": 345678,\n \"status\": 0,\n \"exchange_coefficient\": 1.0,\n \"amount\": 1000.50,\n \"amount_base_currency\": 1000.50,\n \"paid_amount\": 0.00,\n \"paid_amount_base_currency\": 0.00,\n \"outstanding_amount\": 1000.50,\n \"outstanding_amount_base_currency\": 1000.50,\n \"client_id\": 1,\n \"user_id\": 12,\n \"team_id\": 8,\n \"from_company_id\": null,\n \"discount\": 10,\n \"tax1\": 20,\n \"tax2\": 5,\n \"issue_date\": \"2024-01-15\",\n \"due_date\": \"2024-02-15\",\n \"notes\": \"Invoice for development services\",\n \"number\": \"INV-003\",\n \"interval_date\": null,\n \"email\": \"client@example.com\",\n \"stripe_external_id\": null,\n \"stripe_invoice_url\": null,\n \"passim_invoice_url\": null,\n \"invoiced_at\": \"2024-01-15T10:30:00.000000Z\",\n \"created_at\": \"2024-01-15T10:30:00.000000Z\",\n \"updated_at\": \"2024-01-15T10:30:00.000000Z\",\n \"deleted_at\": null,\n \"payment_amount_paid\": 0.00,\n \"items\": [\n {\n \"id\": 3,\n \"name\": \"Feature development\",\n \"price\": 100.00,\n \"quantity\": 10,\n \"amount\": 1000.00,\n \"invoice_id\": 3\n },\n {\n \"id\": 4,\n \"name\": \"API Integration\",\n \"price\": 0.50,\n \"quantity\": 1,\n \"amount\": 0.50,\n \"invoice_id\": 3\n }\n ]\n }\n}", "name": "success" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"client_id\": [\"The client id field is required.\"],\n \"amount\": [\"The amount field is required.\"]\n }\n}", "name": "validation_error" } ] }, { "name": "Display a single invoice with items.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/invoices\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/invoices\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "Invoice ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 1,\n \"hash\": \"abc123def456\",\n \"currency_id\": 1,\n \"random_number\": 123456,\n \"status\": 1,\n \"exchange_coefficient\": 1.0,\n \"amount\": 1000.50,\n \"amount_base_currency\": 1000.50,\n \"paid_amount\": 500.00,\n \"paid_amount_base_currency\": 500.00,\n \"outstanding_amount\": 500.50,\n \"outstanding_amount_base_currency\": 500.50,\n \"client_id\": 1,\n \"user_id\": 12,\n \"team_id\": 8,\n \"from_company_id\": null,\n \"discount\": 0,\n \"tax1\": 0,\n \"tax2\": 0,\n \"issue_date\": \"2024-01-15\",\n \"due_date\": \"2024-02-15\",\n \"notes\": \"Invoice for development services\",\n \"number\": \"INV-001\",\n \"interval_date\": null,\n \"email\": \"client@example.com\",\n \"stripe_external_id\": null,\n \"stripe_invoice_url\": null,\n \"passim_invoice_url\": null,\n \"invoiced_at\": \"2024-01-15T10:30:00.000000Z\",\n \"created_at\": \"2024-01-15T10:30:00.000000Z\",\n \"updated_at\": \"2024-01-15T10:30:00.000000Z\",\n \"deleted_at\": null,\n \"payment_amount_paid\": 500.50,\n \"items\": [\n {\n \"id\": 1,\n \"name\": \"Feature development\",\n \"price\": 100.00,\n \"quantity\": 10,\n \"amount\": 1000.00,\n \"invoice_id\": 1\n },\n {\n \"id\": 2,\n \"name\": \"API Integration\",\n \"price\": 0.50,\n \"quantity\": 1,\n \"amount\": 0.50,\n \"invoice_id\": 1\n }\n ]\n }\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Invoice not found\"}", "name": "not_found" } ] }, { "name": "Update an existing invoice.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/invoices\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/invoices\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "Invoice ID." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"client_id\":2,\"currency_id\":2,\"status\":1,\"amount\":\"1200.00\",\"issue_date\":\"2024-01-16\",\"due_date\":\"2024-02-16\",\"notes\":\"\\\"Updated invoice\\\"\",\"number\":\"\\\"INV-001-REV\\\"\",\"discount\":15,\"tax1\":18,\"tax2\":3,\"email\":\"\\\"updated@example.com\\\"\",\"items\":[\"architecto\"]}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 1,\n \"hash\": \"abc123def456\",\n \"currency_id\": 2,\n \"random_number\": 123456,\n \"status\": 1,\n \"exchange_coefficient\": 1.0,\n \"amount\": 1200.00,\n \"amount_base_currency\": 1200.00,\n \"paid_amount\": 500.00,\n \"paid_amount_base_currency\": 500.00,\n \"outstanding_amount\": 700.00,\n \"outstanding_amount_base_currency\": 700.00,\n \"client_id\": 2,\n \"user_id\": 12,\n \"team_id\": 8,\n \"from_company_id\": null,\n \"discount\": 15,\n \"tax1\": 18,\n \"tax2\": 3,\n \"issue_date\": \"2024-01-16\",\n \"due_date\": \"2024-02-16\",\n \"notes\": \"Updated invoice\",\n \"number\": \"INV-001-REV\",\n \"interval_date\": null,\n \"email\": \"updated@example.com\",\n \"stripe_external_id\": null,\n \"stripe_invoice_url\": null,\n \"passim_invoice_url\": null,\n \"invoiced_at\": \"2024-01-15T10:30:00.000000Z\",\n \"created_at\": \"2024-01-15T10:30:00.000000Z\",\n \"updated_at\": \"2024-01-16T14:20:00.000000Z\",\n \"deleted_at\": null,\n \"payment_amount_paid\": 500.50,\n \"items\": [\n {\n \"id\": 5,\n \"name\": \"Updated development\",\n \"price\": 120.00,\n \"quantity\": 10,\n \"amount\": 1200.00,\n \"invoice_id\": 1\n }\n ]\n }\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Invoice not found\"}", "name": "not_found" } ] }, { "name": "Delete an invoice (soft delete).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/invoices\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/invoices\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "Invoice ID." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Invoice deleted successfully\"\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Invoice not found\"}", "name": "not_found" } ] }, { "name": "Update invoice status.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/invoices\/:id\/status", "query": [], "raw": "{{baseUrl}}\/api\/v1\/invoices\/:id\/status", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "Invoice ID." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"status\":1}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 1,\n \"hash\": \"abc123def456\",\n \"number\": \"INV-001\",\n \"status\": 1,\n \"amount\": 1000.50,\n \"client_id\": 1,\n \"issue_date\": \"2024-01-15\",\n \"due_date\": \"2024-02-15\",\n \"created_at\": \"2024-01-15T10:30:00.000000Z\",\n \"updated_at\": \"2024-01-16T16:45:00.000000Z\"\n },\n \"message\": \"Invoice status updated successfully\"\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Invoice not found\"}", "name": "not_found" }, { "header": [], "code": 422, "body": "{\n \"message\": \"Cannot change status from closed to draft\"\n}", "name": "invalid_transition" } ] }, { "name": "Send an invoice to client.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/invoices\/:id\/send", "query": [], "raw": "{{baseUrl}}\/api\/v1\/invoices\/:id\/send", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "Invoice ID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Updates invoice status to \"sent\" (1)" }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Invoice sent successfully\"\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Invoice not found\"}", "name": "not_found" }, { "header": [], "code": 422, "body": "{\"message\": \"No valid recipient email for this invoice; set invoice email or client email.\"}", "name": "no_recipient" }, { "header": [], "code": 500, "body": "{\"message\": \"Unable to send invoice email\"}", "name": "mail_failed" } ] }, { "name": "Create a CRM email draft to follow up on an invoice (does not send).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/invoices\/:id\/followup-draft", "query": [], "raw": "{{baseUrl}}\/api\/v1\/invoices\/:id\/followup-draft", "variable": [ { "id": "id", "key": "id", "value": "MBJkCmaYOiAmXn9", "description": "The ID of the invoice." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"subject\":\"b\",\"message\":\"n\"}" }, "description": "" }, "response": [] }, { "name": "Record a payment for an invoice.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/invoices\/:id\/payment", "query": [], "raw": "{{baseUrl}}\/api\/v1\/invoices\/:id\/payment", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "Invoice ID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"amount_paid\":\"500.00\",\"payment_date\":\"2024-01-20\",\"notes\":\"\\\"Bank transfer - Reference: INV001\\\"\"}" }, "description": "Creates a payment record and updates invoice paid\/outstanding amounts.\nIf invoice becomes fully paid, status is automatically updated to \"closed\" (2)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Payment recorded successfully\",\n \"payment\": {\n \"id\": 1,\n \"invoice_id\": 1,\n \"currency_id\": 1,\n \"exchange_coefficient\": 1.0,\n \"amount_paid\": 500.00,\n \"amount_paid_base_currency\": 500.00,\n \"payment_date\": \"2024-01-20\",\n \"notes\": \"Bank transfer - Reference: INV001\",\n \"created_at\": \"2024-01-20T10:15:00.000000Z\",\n \"updated_at\": \"2024-01-20T10:15:00.000000Z\"\n }\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Invoice not found\"}", "name": "not_found" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"amount_paid\": [\"The amount paid must be greater than 0.\"]\n }\n}", "name": "validation_error" } ] }, { "name": "POST api\/v1\/spreadsheet-import\/previews\/{publicId}\/apply", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/spreadsheet-import\/previews\/:publicId\/apply", "query": [], "raw": "{{baseUrl}}\/api\/v1\/spreadsheet-import\/previews\/:publicId\/apply", "variable": [ { "id": "publicId", "key": "publicId", "value": "BcECdBDA-CdED-bFEA-CbCE-BcCdeBfbbebc", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] } ] }, { "name": "Expenses", "description": "\nAPIs for managing business expenses.\n\nTrack business expenses with support for categorization, project assignment, and file attachments.\nAll expenses are scoped to the authenticated user's team.", "item": [ { "name": "List expenses", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/expenses", "query": [ { "key": "user_id", "value": "12", "description": "Filter expenses by user id.", "disabled": false }, { "key": "project_id", "value": "5", "description": "Filter expenses by project id.", "disabled": false }, { "key": "per_page", "value": "50", "description": "Number of results per page. Minimum: 1, Maximum: 100.", "disabled": false }, { "key": "sort", "value": "created_at", "description": "Column used for sorting. Allowed: id, user_id, project_id, created_at, updated_at.", "disabled": false }, { "key": "direction", "value": "desc", "description": "Sort direction. Allowed: asc, desc.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/expenses?user_id=12&project_id=5&per_page=50&sort=created_at&direction=desc" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Display a paginated list of expenses with optional filtering and sorting." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 15,\n \"description\": \"Office supplies\",\n \"date\": \"2024-01-15\",\n \"user_id\": 12,\n \"team_id\": 8,\n \"category\": \"Office Expenses\",\n \"amount\": 145.50,\n \"notes\": \"Purchased notebooks and pens\",\n \"billable\": true,\n \"file_url\": \"https:\/\/example.com\/receipts\/receipt-15.pdf\",\n \"project_id\": 5,\n \"created_at\": \"2024-01-15T14:30:00.000000Z\",\n \"updated_at\": \"2024-01-15T14:30:00.000000Z\",\n \"deleted_at\": null\n },\n {\n \"id\": 16,\n \"description\": \"Business lunch\",\n \"date\": \"2024-01-14\",\n \"user_id\": 12,\n \"team_id\": 8,\n \"category\": \"Meals & Entertainment\",\n \"amount\": 89.75,\n \"notes\": \"Client meeting at restaurant\",\n \"billable\": true,\n \"file_url\": null,\n \"project_id\": null,\n \"created_at\": \"2024-01-14T19:45:00.000000Z\",\n \"updated_at\": \"2024-01-14T19:45:00.000000Z\",\n \"deleted_at\": null\n }\n ],\n \"links\": {\n \"first\": \"https:\/\/example.com\/api\/v1\/expenses?page=1\",\n \"last\": \"https:\/\/example.com\/api\/v1\/expenses?page=3\",\n \"prev\": null,\n \"next\": \"https:\/\/example.com\/api\/v1\/expenses?page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 3,\n \"path\": \"https:\/\/example.com\/api\/v1\/expenses\",\n \"per_page\": 30,\n \"to\": 30,\n \"total\": 75\n }\n}", "name": "success" } ] }, { "name": "Create expense", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/expenses", "query": [], "raw": "{{baseUrl}}\/api\/v1\/expenses" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"description\":\"Office supplies\",\"date\":\"2024-01-15\",\"user_id\":12,\"category\":\"Office Expenses\",\"amount\":\"145.50\",\"notes\":\"Purchased notebooks and pens\",\"billable\":true,\"file_url\":\"https:\\\/\\\/example.com\\\/receipts\\\/receipt-15.pdf\",\"project_id\":5,\"team_id\":\"architecto\"}" }, "description": "Create a new business expense record." }, "response": [ { "header": [], "code": 201, "body": "{\n \"data\": {\n \"id\": 15,\n \"description\": \"Office supplies\",\n \"date\": \"2024-01-15\",\n \"user_id\": 12,\n \"team_id\": 8,\n \"category\": \"Office Expenses\",\n \"amount\": 145.50,\n \"notes\": \"Purchased notebooks and pens\",\n \"billable\": true,\n \"file_url\": \"https:\/\/example.com\/receipts\/receipt-15.pdf\",\n \"project_id\": 5,\n \"created_at\": \"2024-01-15T14:30:00.000000Z\",\n \"updated_at\": \"2024-01-15T14:30:00.000000Z\",\n \"deleted_at\": null\n },\n \"message\": \"Expense created successfully\"\n}", "name": "success" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"date\": [\"The date field is required.\"],\n \"amount\": [\"The amount field is required.\"]\n }\n}", "name": "validation_error" } ] }, { "name": "Update expense", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/expenses\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/expenses\/:id", "variable": [ { "id": "id", "key": "id", "value": "15", "description": "Expense id." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"description\":\"Updated office supplies\",\"date\":\"2024-01-16\",\"user_id\":13,\"category\":\"Updated Office Expenses\",\"amount\":\"150.00\",\"notes\":\"Added printer paper\",\"billable\":false,\"file_url\":\"https:\\\/\\\/example.com\\\/receipts\\\/receipt-15-updated.pdf\",\"project_id\":6,\"team_id\":\"architecto\"}" }, "description": "Update an existing expense record. Expenses linked to an invoice cannot be edited." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 15,\n \"description\": \"Updated office supplies\",\n \"date\": \"2024-01-16\",\n \"user_id\": 12,\n \"team_id\": 8,\n \"category\": \"Updated Office Expenses\",\n \"amount\": 150.00,\n \"notes\": \"Added printer paper\",\n \"billable\": false,\n \"file_url\": \"https:\/\/example.com\/receipts\/receipt-15-updated.pdf\",\n \"project_id\": 6,\n \"created_at\": \"2024-01-15T14:30:00.000000Z\",\n \"updated_at\": \"2024-01-16T10:15:00.000000Z\",\n \"deleted_at\": null\n },\n \"message\": \"Expense updated successfully\"\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Expense not found\"\n}", "name": "not_found" }, { "header": [], "code": 422, "body": "{\n \"message\": \"Expenses with an invoice cannot be edited\"\n}", "name": "invoice_linked" } ] }, { "name": "Delete expense", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/expenses\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/expenses\/:id", "variable": [ { "id": "id", "key": "id", "value": "15", "description": "Expense id." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete an expense record." }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Expense deleted successfully\"\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Expense not found\"\n}", "name": "not_found" } ] } ] }, { "name": "HR Candidates", "description": "\nPublic API for managing HR candidates.\n\nCandidates belong to HR vacancies and are always scoped to the authenticated user's team.", "item": [ { "name": "List candidates for a vacancy.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/hr\/vacancies\/:vacancy\/candidates", "query": [ { "key": "per_page", "value": "30", "description": "Number of items per page (max 100).", "disabled": false }, { "key": "sort", "value": "created_at", "description": "Sort column. Allowed: id, created_at, updated_at.", "disabled": false }, { "key": "direction", "value": "desc", "description": "Sort direction. Allowed: asc, desc.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/hr\/vacancies\/:vacancy\/candidates?per_page=30&sort=created_at&direction=desc", "variable": [ { "id": "vacancy", "key": "vacancy", "value": "5", "description": "HR vacancy ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"John Doe\",\n \"slug\": \"john-doe\",\n \"profile_url\": \"https:\/\/linkedin.com\/in\/johndoe\",\n \"hr_vacancy_id\": 5,\n \"hr_vacancy_column_id\": 2,\n \"created_at\": \"2025-01-10T08:00:00.000000Z\",\n \"updated_at\": \"2025-01-10T08:00:00.000000Z\"\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"per_page\": 30,\n \"total\": 1\n }\n}", "name": "success" } ] }, { "name": "Show a candidate.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/hr\/candidates\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/hr\/candidates\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "Candidate ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 1,\n \"name\": \"John Doe\",\n \"slug\": \"john-doe\",\n \"profile_url\": \"https:\/\/linkedin.com\/in\/johndoe\",\n \"hr_vacancy_id\": 5,\n \"hr_vacancy_column_id\": 2,\n \"created_at\": \"2025-01-10T08:00:00.000000Z\",\n \"updated_at\": \"2025-01-10T08:00:00.000000Z\"\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" } ] }, { "name": "Create a candidate.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/hr\/candidates", "query": [], "raw": "{{baseUrl}}\/api\/v1\/hr\/candidates" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"John Doe\",\"profile_url\":\"https:\\\/\\\/linkedin.com\\\/in\\\/johndoe\",\"hr_vacancy_id\":5,\"hr_vacancy_column_id\":2}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"id\": 1,\n \"name\": \"John Doe\",\n \"slug\": \"john-doe\",\n \"profile_url\": \"https:\/\/linkedin.com\/in\/johndoe\",\n \"hr_vacancy_id\": 5,\n \"hr_vacancy_column_id\": 2,\n \"created_at\": \"2025-01-10T08:00:00.000000Z\",\n \"updated_at\": \"2025-01-10T08:00:00.000000Z\"\n}", "name": "success" } ] }, { "name": "Update a candidate.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/hr\/candidates\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/hr\/candidates\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "Candidate ID." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"John Doe\",\"profile_url\":\"https:\\\/\\\/linkedin.com\\\/in\\\/johndoe\",\"hr_vacancy_id\":5,\"hr_vacancy_column_id\":2}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 1,\n \"name\": \"John Doe\",\n \"slug\": \"john-doe\",\n \"profile_url\": \"https:\/\/linkedin.com\/in\/johndoe\",\n \"hr_vacancy_id\": 5,\n \"hr_vacancy_column_id\": 2,\n \"created_at\": \"2025-01-10T08:00:00.000000Z\",\n \"updated_at\": \"2025-01-11T10:30:00.000000Z\"\n}", "name": "success" } ] }, { "name": "Delete a candidate.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/hr\/candidates\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/hr\/candidates\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "Candidate ID." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" } ] }, { "name": "Add a comment to a candidate.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/hr\/candidates\/:id\/comments", "query": [], "raw": "{{baseUrl}}\/api\/v1\/hr\/candidates\/:id\/comments", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "Candidate ID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"comment\":\"Had a great interview.\"}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"message\": \"Comment added successfully\"\n}", "name": "success" } ] } ] }, { "name": "HR Interviews", "description": "\nAPIs for managing HR interviews.\n\nHR interviews represent scheduled or conducted interviews within your team.", "item": [ { "name": "Store a newly created HrInterview in storage.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/hr\/interviews", "query": [], "raw": "{{baseUrl}}\/api\/v1\/hr\/interviews" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"hr_candidate_id\":1,\"interviewer_user_id\":2,\"from\":\"architecto\",\"to\":\"architecto\"}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"id\": 1,\n \"user_id\": 3,\n \"team_id\": 1,\n \"interviewer_user_id\": 2,\n \"from\": \"2024-07-01T10:00:00Z\",\n \"to\": \"2024-07-01T11:00:00Z\",\n \"created_at\": \"2024-06-15T12:00:00Z\",\n \"updated_at\": \"2024-06-15T12:00:00Z\"\n}", "name": "Success" } ] } ] }, { "name": "HR Vacancies", "description": "\nAPIs for managing HR vacancies.\n\nVacancies represent open job positions within a team.\nThese endpoints allow authenticated users to list, view,\ncreate, update, and delete vacancies belonging to their team.", "item": [ { "name": "Display a paginated list of vacancies.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/hr\/vacancies", "query": [ { "key": "per_page", "value": "30", "description": "Number of results per page. Maximum: 100.", "disabled": false }, { "key": "sort", "value": "created_at", "description": "Column used for sorting. Allowed: id, created_at, updated_at.", "disabled": false }, { "key": "direction", "value": "desc", "description": "Sort direction. Allowed: asc, desc.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/hr\/vacancies?per_page=30&sort=created_at&direction=desc" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"per_page\":1,\"sort\":\"id\",\"direction\":\"asc\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 10,\n \"title\": \"Senior PHP Developer\",\n \"slug\": \"senior-php-developer\",\n \"description\": \"We are looking for an experienced PHP developer.\",\n \"requirements\": \"5+ years of PHP, Laravel experience\",\n \"created_at\": \"2025-01-10T08:00:00.000000Z\",\n \"updated_at\": \"2025-01-10T08:00:00.000000Z\"\n }\n ],\n \"links\": {\n \"first\": \"https:\/\/example.com\/api\/v1\/hr\/vacancies?page=1\",\n \"last\": \"https:\/\/example.com\/api\/v1\/hr\/vacancies?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"path\": \"https:\/\/example.com\/api\/v1\/hr\/vacancies\",\n \"per_page\": 30,\n \"to\": 1,\n \"total\": 1\n }\n}", "name": "success" } ] }, { "name": "Display a single vacancy.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/hr\/vacancies\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/hr\/vacancies\/:id", "variable": [ { "id": "id", "key": "id", "value": "10", "description": "Vacancy id." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 10,\n \"title\": \"Senior PHP Developer\",\n \"slug\": \"senior-php-developer\",\n \"description\": \"We are looking for an experienced PHP developer.\",\n \"requirements\": \"5+ years of PHP, Laravel experience\",\n \"created_at\": \"2025-01-10T08:00:00.000000Z\",\n \"updated_at\": \"2025-01-10T08:00:00.000000Z\"\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" } ] }, { "name": "Create a new vacancy.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/hr\/vacancies", "query": [], "raw": "{{baseUrl}}\/api\/v1\/hr\/vacancies" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"Senior PHP Developer\",\"requirements\":\"5+ years of PHP, Laravel experience\",\"description\":\"We are looking for an experienced PHP developer.\"}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"id\": 10,\n \"title\": \"Senior PHP Developer\",\n \"slug\": \"senior-php-developer\",\n \"description\": \"We are looking for an experienced PHP developer.\",\n \"requirements\": \"5+ years of PHP, Laravel experience\",\n \"created_at\": \"2025-01-10T08:00:00.000000Z\",\n \"updated_at\": \"2025-01-10T08:00:00.000000Z\"\n}", "name": "success" } ] }, { "name": "Update an existing vacancy.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/hr\/vacancies\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/hr\/vacancies\/:id", "variable": [ { "id": "id", "key": "id", "value": "10", "description": "Vacancy id." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"Senior PHP Developer\",\"requirements\":\"Strong Laravel and REST API knowledge\",\"description\":\"Updated description.\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 10,\n \"title\": \"Senior PHP Developer\",\n \"slug\": \"senior-php-developer\",\n \"description\": \"Updated description.\",\n \"requirements\": \"Strong Laravel and REST API knowledge\",\n \"created_at\": \"2025-01-10T08:00:00.000000Z\",\n \"updated_at\": \"2025-01-10T12:00:00.000000Z\"\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" } ] }, { "name": "Delete a vacancy.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/hr\/vacancies\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/hr\/vacancies\/:id", "variable": [ { "id": "id", "key": "id", "value": "10", "description": "Vacancy id." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "null", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" } ] } ] }, { "name": "Healthcheck", "description": "Checking API availability", "item": [ { "name": "Ping API", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ping", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ping" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n 'message' => 'pong'\n}", "name": "" } ] } ] }, { "name": "Meetings", "description": "\nAPIs for managing calendar meetings.\n\nMeetings represent scheduled events within a team. These endpoints allow you to list, create,\nupdate, and delete meetings associated with your team.", "item": [ { "name": "Display a paginated list of meetings.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/meetings", "query": [ { "key": "user_id", "value": "12", "description": "Filter meetings by owner id.", "disabled": false }, { "key": "per_page", "value": "20", "description": "Number of results per page. Maximum: 100.", "disabled": false }, { "key": "sort", "value": "created_at", "description": "Column used for sorting. Allowed: id, name, created_at, updated_at.", "disabled": false }, { "key": "direction", "value": "desc", "description": "Sort direction. Allowed: asc, desc.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/meetings?user_id=12&per_page=20&sort=created_at&direction=desc" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"user_id\":16,\"per_page\":22,\"sort\":\"created_at\",\"direction\":\"desc\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 5,\n \"name\": \"Project kickoff\",\n \"from\": \"2025-02-01T09:00:00.000000Z\",\n \"to\": \"2025-02-01T10:00:00.000000Z\",\n \"user_id\": 12,\n \"team_id\": 8,\n \"location\": \"Zoom\",\n \"meeting_url\": \"https:\/\/zoom.us\/j\/123456789\",\n \"description\": \"Initial project discussion\",\n \"created_at\": \"2025-01-20T08:00:00.000000Z\",\n \"updated_at\": \"2025-01-20T08:00:00.000000Z\"\n }\n ],\n \"links\": {\n \"first\": \"https:\/\/example.com\/api\/v1\/meetings?page=1\",\n \"last\": \"https:\/\/example.com\/api\/v1\/meetings?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"path\": \"https:\/\/example.com\/api\/v1\/meetings\",\n \"per_page\": 10,\n \"to\": 1,\n \"total\": 1\n }\n}", "name": "success" } ] }, { "name": "Create a new meeting.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/meetings", "query": [], "raw": "{{baseUrl}}\/api\/v1\/meetings" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Sprint planning\",\"guest_email\":\"guest@example.com\",\"guest_timezone\":\"Europe\\\/Berlin\",\"location\":\"Office room 3\",\"meeting_url\":\"https:\\\/\\\/meet.google.com\\\/abc-defg-hij\",\"description\":\"Discuss sprint scope\",\"from\":\"2025-02-01T09:00:00Z\",\"to\":\"2025-02-01T10:00:00Z\",\"add_to_calendar\":false,\"client_timezone\":\"Asia\\\/Ulaanbaatar\"}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"id\": 5,\n \"name\": \"Sprint planning\",\n \"from\": \"2025-02-01T09:00:00.000000Z\",\n \"to\": \"2025-02-01T10:00:00.000000Z\",\n \"user_id\": 12,\n \"team_id\": 8,\n \"location\": \"Office room 3\",\n \"meeting_url\": null,\n \"description\": \"Discuss sprint scope\",\n \"created_at\": \"2025-01-20T08:00:00.000000Z\",\n \"updated_at\": \"2025-01-20T08:00:00.000000Z\"\n}", "name": "success" } ] }, { "name": "Update an existing meeting.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/meetings\/:meeting_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/meetings\/:meeting_id", "variable": [ { "id": "meeting_id", "key": "meeting_id", "value": "1", "description": "The ID of the meeting." }, { "id": "meeting", "key": "meeting", "value": "5", "description": "Meeting id." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Updated meeting title\",\"guest_email\":\"zbailey@example.net\",\"guest_timezone\":\"America\\\/Moncton\",\"location\":\"Zoom\",\"meeting_url\":\"https:\\\/\\\/zoom.us\\\/j\\\/123456789\",\"description\":\"Updated agenda\",\"from\":\"2025-02-01T10:00:00Z\",\"to\":\"2025-02-01T11:00:00Z\",\"add_to_calendar\":false,\"client_timezone\":\"Asia\\\/Ulaanbaatar\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 5,\n \"name\": \"Updated meeting title\",\n \"from\": \"2025-02-01T10:00:00.000000Z\",\n \"to\": \"2025-02-01T11:00:00.000000Z\",\n \"user_id\": 12,\n \"team_id\": 8,\n \"location\": \"Zoom\",\n \"meeting_url\": \"https:\/\/zoom.us\/j\/123456789\",\n \"description\": \"Updated agenda\",\n \"created_at\": \"2025-01-20T08:00:00.000000Z\",\n \"updated_at\": \"2025-01-21T09:30:00.000000Z\"\n}", "name": "success" } ] }, { "name": "Delete a meeting.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/meetings\/:meeting_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/meetings\/:meeting_id", "variable": [ { "id": "meeting_id", "key": "meeting_id", "value": "1", "description": "The ID of the meeting." }, { "id": "meeting", "key": "meeting", "value": "5", "description": "Meeting id." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "null", "name": "success" } ] } ] }, { "name": "Outreach", "description": "\nAPIs for managing outreach activities.\n\nOutreach activities represent sales outreach efforts like calls, emails, and social media interactions.\nThese endpoints let you list, create, update, and delete outreach activities for your team.", "item": [ { "name": "Display a paginated list of outreach activities.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/outreach", "query": [ { "key": "type", "value": "1", "description": "Filter by outreach type.", "disabled": false }, { "key": "user_id", "value": "12", "description": "Filter by user id.", "disabled": false }, { "key": "search", "value": "prospect", "description": "Filter by value, description, email, or phone.", "disabled": false }, { "key": "date_from", "value": "2024-01-01", "description": "date Filter by start date (YYYY-MM-DD).", "disabled": false }, { "key": "date_to", "value": "2024-12-31", "description": "date Filter by end date (YYYY-MM-DD).", "disabled": false }, { "key": "per_page", "value": "50", "description": "Number of results per page. Maximum: 100.", "disabled": false }, { "key": "sort", "value": "datetime", "description": "Column used for sorting. Allowed: id, type, value, datetime, created_at, updated_at.", "disabled": false }, { "key": "direction", "value": "desc", "description": "Sort direction. Allowed: asc, desc.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/outreach?type=1&user_id=12&search=prospect&date_from=2024-01-01&date_to=2024-12-31&per_page=50&sort=datetime&direction=desc" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 4,\n \"type\": 1,\n \"value\": \"Initial contact\",\n \"email\": \"john@example.com\",\n \"phone\": \"+1 202 555 0147\",\n \"user_id\": 12,\n \"team_id\": 8,\n \"description\": \"Initial outreach via email\",\n \"datetime\": \"2024-01-10T08:00:00.000000Z\",\n \"created_at\": \"2024-01-10T08:00:00.000000Z\",\n \"updated_at\": \"2024-01-10T08:00:00.000000Z\",\n \"deleted_at\": null\n }\n ],\n \"links\": {\n \"first\": \"https:\/\/example.com\/api\/v1\/outreach?page=1\",\n \"last\": \"https:\/\/example.com\/api\/v1\/outreach?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"path\": \"https:\/\/example.com\/api\/v1\/outreach\",\n \"per_page\": 10,\n \"to\": 1,\n \"total\": 1\n }\n}", "name": "success" } ] }, { "name": "Create a new outreach activity.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/outreach", "query": [], "raw": "{{baseUrl}}\/api\/v1\/outreach" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":1,\"value\":\"Initial contact\",\"email\":\"john@example.com\",\"phone\":\"+1 202 555 0147\",\"user_id\":12,\"description\":\"Initial outreach via email\",\"datetime\":\"2024-01-10T08:00:00Z\"}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"message\": \"Outreach activity created successfully.\",\n \"data\": {\n \"id\": 4,\n \"type\": 1,\n \"value\": \"Initial contact\",\n \"email\": \"john@example.com\",\n \"phone\": \"+1 202 555 0147\",\n \"user_id\": 12,\n \"team_id\": 8,\n \"description\": \"Initial outreach via email\",\n \"datetime\": \"2024-01-10T08:00:00.000000Z\",\n \"created_at\": \"2024-01-10T08:00:00.000000Z\",\n \"updated_at\": \"2024-01-10T08:00:00.000000Z\",\n \"deleted_at\": null\n }\n}", "name": "success" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"type\": [\"The type field is required.\"],\n \"value\": [\"The value field is required.\"],\n \"datetime\": [\"The datetime field is required.\"]\n }\n}", "name": "validation_error" } ] }, { "name": "Update an outreach activity.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/outreach\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/outreach\/:id", "variable": [ { "id": "id", "key": "id", "value": "4", "description": "Outreach id." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":2,\"value\":\"Follow-up call\",\"email\":\"john@example.com\",\"phone\":\"+1 202 555 0147\",\"user_id\":12,\"description\":\"Follow-up call made\",\"datetime\":\"2024-01-11T10:00:00Z\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Outreach activity updated successfully.\",\n \"data\": {\n \"id\": 4,\n \"type\": 2,\n \"value\": \"Follow-up call\",\n \"email\": \"john@example.com\",\n \"phone\": \"+1 202 555 0147\",\n \"user_id\": 12,\n \"team_id\": 8,\n \"description\": \"Follow-up call made\",\n \"datetime\": \"2024-01-11T10:00:00.000000Z\",\n \"created_at\": \"2024-01-10T08:00:00.000000Z\",\n \"updated_at\": \"2024-01-11T10:00:00.000000Z\",\n \"deleted_at\": null\n }\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"type\": [\"The selected type is invalid.\"]\n }\n}", "name": "validation_error" } ] }, { "name": "Delete an outreach activity.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/outreach\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/outreach\/:id", "variable": [ { "id": "id", "key": "id", "value": "4", "description": "Outreach id." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "null", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" } ] } ] }, { "name": "Pay Rates", "description": "\nAPIs for managing user pay rates over time.\n\nPay rates represent hourly rates assigned to users with specific start dates.\nUsers can have multiple pay rates over time, but only one rate per date.", "item": [ { "name": "Display a paginated list of pay rates for a user.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id\/pay-rates", "query": [ { "key": "per_page", "value": "50", "description": "Number of results per page. Maximum: 100.", "disabled": false }, { "key": "sort", "value": "started_at", "description": "Column used for sorting. Allowed: id, rate, started_at, created_at, updated_at.", "disabled": false }, { "key": "direction", "value": "desc", "description": "Sort direction. Allowed: asc, desc.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id\/pay-rates?per_page=50&sort=started_at&direction=desc", "variable": [ { "id": "user_id", "key": "user_id", "value": "1", "description": "The ID of the user." }, { "id": "user", "key": "user", "value": "1", "description": "User ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"rate\": 50.00,\n \"user_id\": 1,\n \"status\": \"current\",\n \"started_at\": \"2024-01-01T00:00:00.000000Z\",\n \"created_at\": \"2024-01-01T00:00:00.000000Z\",\n \"updated_at\": \"2024-01-01T00:00:00.000000Z\"\n },\n {\n \"id\": 2,\n \"rate\": 55.00,\n \"user_id\": 1,\n \"status\": \"future\",\n \"started_at\": \"2024-02-01T00:00:00.000000Z\",\n \"created_at\": \"2024-01-15T10:30:00.000000Z\",\n \"updated_at\": \"2024-01-15T10:30:00.000000Z\"\n }\n ],\n \"links\": {\n \"first\": \"https:\/\/example.com\/api\/v1\/users\/1\/pay-rates?page=1\",\n \"last\": \"https:\/\/example.com\/api\/v1\/users\/1\/pay-rates?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"path\": \"https:\/\/example.com\/api\/v1\/users\/1\/pay-rates\",\n \"per_page\": 30,\n \"to\": 2,\n \"total\": 2\n }\n}", "name": "success" } ] }, { "name": "Create a new pay rate.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id\/pay-rates", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id\/pay-rates", "variable": [ { "id": "user_id", "key": "user_id", "value": "1", "description": "The ID of the user." }, { "id": "user", "key": "user", "value": "1", "description": "User ID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"rate\":\"50.00\",\"started_at\":\"2024-01-01\"}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"id\": 3,\n \"rate\": 50.00,\n \"user_id\": 1,\n \"status\": \"past\",\n \"started_at\": \"2023-12-01T00:00:00.000000Z\",\n \"created_at\": \"2024-01-15T10:30:00.000000Z\",\n \"updated_at\": \"2024-01-15T10:30:00.000000Z\"\n}", "name": "success" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"started_at\": [\"The start date already exists for this user.\"]\n }\n}", "name": "validation_error" } ] }, { "name": "Update a pay rate.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id\/pay-rates\/:payRate_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id\/pay-rates\/:payRate_id", "variable": [ { "id": "user_id", "key": "user_id", "value": "1", "description": "The ID of the user." }, { "id": "payRate_id", "key": "payRate_id", "value": "1", "description": "The ID of the payRate." }, { "id": "user", "key": "user", "value": "1", "description": "User ID." }, { "id": "id", "key": "id", "value": "1", "description": "Pay Rate ID." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"rate\":\"55.00\",\"started_at\":\"2024-02-01\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 1,\n \"rate\": 55.00,\n \"user_id\": 1,\n \"status\": \"current\",\n \"started_at\": \"2024-01-15T00:00:00.000000Z\",\n \"created_at\": \"2024-01-01T00:00:00.000000Z\",\n \"updated_at\": \"2024-01-15T11:45:00.000000Z\"\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Pay rate not found for this user\"}", "name": "not_found" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"started_at\": [\"The start date already exists for this user.\"]\n }\n}", "name": "validation_error" } ] }, { "name": "Delete a pay rate.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id\/pay-rates\/:payRate_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id\/pay-rates\/:payRate_id", "variable": [ { "id": "user_id", "key": "user_id", "value": "1", "description": "The ID of the user." }, { "id": "payRate_id", "key": "payRate_id", "value": "1", "description": "The ID of the payRate." }, { "id": "user", "key": "user", "value": "1", "description": "User ID." }, { "id": "id", "key": "id", "value": "2", "description": "Pay Rate ID." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "null", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Pay rate not found for this user\"}", "name": "not_found" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"error\": [\"Current and past pay rates cannot be deleted.\"]\n }\n}", "name": "validation_error" } ] } ] }, { "name": "Project Rates", "description": "\nAPIs for managing project rates.\n\nProject rates define billing rates for projects. These endpoints let you list, create, update, and delete rates for specific projects.", "item": [ { "name": "Display a paginated list of project rates.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/projects\/:project_id\/rates", "query": [ { "key": "user_id", "value": "5", "description": "Filter rates by user id.", "disabled": false }, { "key": "currency_id", "value": "1", "description": "Filter rates by currency id.", "disabled": false }, { "key": "per_page", "value": "50", "description": "Number of results per page. Maximum: 100.", "disabled": false }, { "key": "sort", "value": "started_at", "description": "Column used for sorting. Allowed: id, rate, user_id, currency_id, started_at, created_at, updated_at.", "disabled": false }, { "key": "direction", "value": "desc", "description": "Sort direction. Allowed: asc, desc.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/projects\/:project_id\/rates?user_id=5¤cy_id=1&per_page=50&sort=started_at&direction=desc", "variable": [ { "id": "project_id", "key": "project_id", "value": "1", "description": "The ID of the project." }, { "id": "project", "key": "project", "value": "1", "description": "Project id." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"project_id\": 1,\n \"user_id\": 5,\n \"rate\": 100.00,\n \"currency_id\": 1,\n \"started_at\": \"2024-01-01T00:00:00.000000Z\",\n \"created_at\": \"2024-01-01T00:00:00.000000Z\",\n \"updated_at\": \"2024-01-01T00:00:00.000000Z\"\n }\n ],\n \"links\": {\n \"first\": \"https:\/\/example.com\/api\/v1\/projects\/1\/rates?page=1\",\n \"last\": \"https:\/\/example.com\/api\/v1\/projects\/1\/rates?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"path\": \"https:\/\/example.com\/api\/v1\/projects\/1\/rates\",\n \"per_page\": 30,\n \"to\": 1,\n \"total\": 1\n }\n}", "name": "success" } ] }, { "name": "Create a new project rate.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/projects\/:project_id\/rates", "query": [], "raw": "{{baseUrl}}\/api\/v1\/projects\/:project_id\/rates", "variable": [ { "id": "project_id", "key": "project_id", "value": "1", "description": "The ID of the project." }, { "id": "project", "key": "project", "value": "1", "description": "Project id." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"rate\":\"100.00\",\"started_at\":\"2024-01-01\",\"user_id\":5,\"currency_id\":1}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"id\": 1,\n \"project_id\": 1,\n \"user_id\": 5,\n \"rate\": 100.00,\n \"currency_id\": 1,\n \"started_at\": \"2024-01-01T00:00:00.000000Z\",\n \"created_at\": \"2024-01-01T00:00:00.000000Z\",\n \"updated_at\": \"2024-01-01T00:00:00.000000Z\"\n}", "name": "success" }, { "header": [], "code": 422, "body": "{\"message\": \"The Start date already exists\"}", "name": "validation_error" } ] }, { "name": "Update a project rate.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/projects\/:project_id\/rates\/:projectRate_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/projects\/:project_id\/rates\/:projectRate_id", "variable": [ { "id": "project_id", "key": "project_id", "value": "1", "description": "The ID of the project." }, { "id": "projectRate_id", "key": "projectRate_id", "value": "119", "description": "The ID of the projectRate." }, { "id": "project", "key": "project", "value": "1", "description": "Project id." }, { "id": "projectRate", "key": "projectRate", "value": "1", "description": "Project rate id." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"rate\":\"120.00\",\"started_at\":\"2024-02-01\",\"user_id\":5,\"currency_id\":1}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 1,\n \"project_id\": 1,\n \"user_id\": 5,\n \"rate\": 120.00,\n \"currency_id\": 1,\n \"started_at\": \"2024-02-01T00:00:00.000000Z\",\n \"created_at\": \"2024-01-01T00:00:00.000000Z\",\n \"updated_at\": \"2024-01-15T10:30:00.000000Z\"\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Project rate not found for this project\"}", "name": "not_found" }, { "header": [], "code": 422, "body": "{\"message\": \"The Start date already exists\"}", "name": "validation_error" } ] }, { "name": "Delete a project rate.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/projects\/:project_id\/rates\/:projectRate_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/projects\/:project_id\/rates\/:projectRate_id", "variable": [ { "id": "project_id", "key": "project_id", "value": "1", "description": "The ID of the project." }, { "id": "projectRate_id", "key": "projectRate_id", "value": "119", "description": "The ID of the projectRate." }, { "id": "project", "key": "project", "value": "1", "description": "Project id." }, { "id": "projectRate", "key": "projectRate", "value": "1", "description": "Project rate id." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "null", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Project rate not found for this project\"}", "name": "not_found" }, { "header": [], "code": 422, "body": "{\"message\": \"Current and past project rate cannot be deleted\"}", "name": "validation_error" } ] } ] }, { "name": "Projects", "description": "\nAPIs for managing projects.\n\nProjects represent client initiatives. These endpoints let you list, create, update, and delete projects that belong to your team.", "item": [ { "name": "Display a paginated list of projects.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/projects", "query": [ { "key": "search", "value": "onboarding", "description": "Filter projects by partial match in the project name.", "disabled": false }, { "key": "client_id", "value": "4", "description": "Filter projects by client id.", "disabled": false }, { "key": "user_id", "value": "12", "description": "Filter projects by owner id.", "disabled": false }, { "key": "billable", "value": "1", "description": "Filter by billable flag.", "disabled": false }, { "key": "per_page", "value": "50", "description": "Number of results per page. Maximum: 100.", "disabled": false }, { "key": "sort", "value": "created_at", "description": "Column used for sorting. Allowed: id, name, created_at, updated_at.", "disabled": false }, { "key": "direction", "value": "desc", "description": "Sort direction. Allowed: asc, desc.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/projects?search=onboarding&client_id=4&user_id=12&billable=1&per_page=50&sort=created_at&direction=desc" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 3,\n \"name\": \"Client onboarding\",\n \"description\": \"Kick-off project for ACME Inc.\",\n \"client_id\": 4,\n \"user_id\": 12,\n \"team_id\": 8,\n \"billable\": true,\n \"created_at\": \"2025-01-10T08:00:00.000000Z\",\n \"updated_at\": \"2025-01-10T08:00:00.000000Z\",\n \"deleted_at\": null\n }\n ],\n \"links\": {\n \"first\": \"https:\/\/example.com\/api\/v1\/projects?page=1\",\n \"last\": \"https:\/\/example.com\/api\/v1\/projects?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"path\": \"https:\/\/example.com\/api\/v1\/projects\",\n \"per_page\": 30,\n \"to\": 1,\n \"total\": 1\n }\n}", "name": "success" } ] }, { "name": "Create a new project.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/projects", "query": [], "raw": "{{baseUrl}}\/api\/v1\/projects" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Client onboarding\",\"description\":\"Kick-off project for ACME Inc.\",\"client_id\":4,\"billable\":true,\"user_id\":12}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"id\": 3,\n \"name\": \"Client onboarding\",\n \"description\": \"Kick-off project for ACME Inc.\",\n \"client_id\": 4,\n \"user_id\": 12,\n \"team_id\": 8,\n \"billable\": true,\n \"created_at\": \"2025-01-10T08:00:00.000000Z\",\n \"updated_at\": \"2025-01-10T08:00:00.000000Z\",\n \"deleted_at\": null\n}", "name": "success" }, { "header": [], "code": 422, "body": "{\"message\": \"Client not found\"}", "name": "validation_error" } ] }, { "name": "Display a single project.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/projects\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/projects\/:id", "variable": [ { "id": "id", "key": "id", "value": "3", "description": "Project id." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 3,\n \"name\": \"Client onboarding\",\n \"description\": \"Kick-off project for ACME Inc.\",\n \"client_id\": 4,\n \"user_id\": 12,\n \"team_id\": 8,\n \"billable\": true,\n \"created_at\": \"2025-01-10T08:00:00.000000Z\",\n \"updated_at\": \"2025-01-10T08:00:00.000000Z\",\n \"deleted_at\": null\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" } ] }, { "name": "Update a project.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/projects\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/projects\/:id", "variable": [ { "id": "id", "key": "id", "value": "3", "description": "Project id." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Client onboarding\",\"description\":\"Kick-off project for ACME Inc.\",\"client_id\":4,\"billable\":true,\"user_id\":12}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 3,\n \"name\": \"Client onboarding\",\n \"description\": \"Kick-off project for ACME Inc.\",\n \"client_id\": 4,\n \"user_id\": 12,\n \"team_id\": 8,\n \"billable\": true,\n \"created_at\": \"2025-01-10T08:00:00.000000Z\",\n \"updated_at\": \"2025-01-10T10:30:00.000000Z\",\n \"deleted_at\": null\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" } ] }, { "name": "Delete a project.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/projects\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/projects\/:id", "variable": [ { "id": "id", "key": "id", "value": "3", "description": "Project id." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "null", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" } ] } ] }, { "name": "Reports", "description": "\nAPIs for querying time tracking reports.\n\nThese endpoints let you query aggregated time tracking data with various filters and grouping options.\nEvery request must be authenticated via an active Public API key or Bearer token.", "item": [ { "name": "Query time tracking reports.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/reports", "query": [ { "key": "start", "value": "2025-01-01", "description": "date Start date for the report period. Defaults to start of current week.", "disabled": false }, { "key": "end", "value": "2025-01-31", "description": "date End date for the report period. Defaults to end of current week.", "disabled": false }, { "key": "groupBy", "value": "project", "description": "How to group results. Allowed: member, project, date, client, task.", "disabled": false }, { "key": "members[0]", "value": "1", "description": "Filter by member IDs.", "disabled": false }, { "key": "members[1]", "value": "2", "description": "Filter by member IDs.", "disabled": false }, { "key": "members[2]", "value": "3", "description": "Filter by member IDs.", "disabled": false }, { "key": "projects[0]", "value": "10", "description": "Filter by project IDs.", "disabled": false }, { "key": "projects[1]", "value": "20", "description": "Filter by project IDs.", "disabled": false }, { "key": "clients[0]", "value": "5", "description": "Filter by client IDs.", "disabled": false }, { "key": "clients[1]", "value": "6", "description": "Filter by client IDs.", "disabled": false }, { "key": "summary_only", "value": "1", "description": "If true, return only aggregated totals per group (faster for profitability queries).", "disabled": false }, { "key": "fields", "value": "user_name%2Cproject_name%2Cbilled%2Cspent", "description": "Comma-separated list of fields to return.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/reports?start=2025-01-01&end=2025-01-31&groupBy=project&members[0]=1&members[1]=2&members[2]=3&projects[0]=10&projects[1]=20&clients[0]=5&clients[1]=6&summary_only=1&fields=user_name%2Cproject_name%2Cbilled%2Cspent" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns time tracking data grouped by member, project, client, date, or task.\nSupports filtering by date range, members, projects, and clients." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\",\n \"totals\": {\n \"total_time\": \"45h 30m\",\n \"total_spent\": 2500.00,\n \"total_billed\": 4500.00,\n \"currencyGroups\": {},\n \"baseCurrencySums\": {}\n },\n \"filters\": {\n \"teamId\": 1,\n \"startedDate\": \"2025-01-01 00:00:00\",\n \"endDate\": \"2025-01-31 23:59:59\",\n \"projects\": null,\n \"members\": null,\n \"clients\": null,\n \"groupBy\": \"project\"\n },\n \"summary\": {\n \"1\": {\n \"group_id\": 1,\n \"group_name\": \"Project Alpha\",\n \"total_spent\": 1200.00,\n \"total_billed\": 2400.00,\n \"profit\": 1200.00,\n \"profit_margin\": 50.0,\n \"total_time\": \"24h 00m\",\n \"total_seconds\": 86400\n }\n }\n}", "name": "success" }, { "header": [], "code": 401, "body": "{\"message\": \"Authorization required\"}", "name": "unauthenticated" } ] } ] }, { "name": "Screenshots", "description": "\nAPIs for managing time tracking screenshots.\n\nThese endpoints let you list screenshots captured during time tracking sessions. Screenshots are organized by user, project, and date.", "item": [ { "name": "Display a paginated list of screenshots.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/screenshots", "query": [ { "key": "project_id", "value": "5", "description": "Filter screenshots by project ID.", "disabled": false }, { "key": "user_id", "value": "12", "description": "Filter screenshots by user ID. Only superadmins and organization managers can view other users' screenshots. Defaults to authenticated user's ID.", "disabled": false }, { "key": "date", "value": "2024-01-15", "description": "Filter screenshots by specific date (YYYY-MM-DD format).", "disabled": false }, { "key": "date_from", "value": "2024-01-01", "description": "Filter screenshots by date range start (YYYY-MM-DD format).", "disabled": false }, { "key": "date_to", "value": "2024-01-31", "description": "Filter screenshots by date range end (YYYY-MM-DD format). Requires date_from parameter.", "disabled": false }, { "key": "per_page", "value": "50", "description": "Number of results per page. Maximum: 100.", "disabled": false }, { "key": "sort", "value": "started_at", "description": "Column used for sorting. Allowed: id, started_at, user_id, project_id.", "disabled": false }, { "key": "direction", "value": "desc", "description": "Sort direction. Allowed: asc, desc.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/screenshots?project_id=5&user_id=12&date=2024-01-15&date_from=2024-01-01&date_to=2024-01-31&per_page=50&sort=started_at&direction=desc" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 123,\n \"project_id\": 5,\n \"user_id\": 12,\n \"path\": \"screenshots\/2024\/01\/15\/abc123.jpg\",\n \"signed_url\": \"https:\/\/storage.example.com\/screenshots\/2024\/01\/15\/abc123.jpg?signature=abc123\",\n \"taken_at\": \"2024-01-15T10:30:00.000000Z\"\n }\n ],\n \"links\": {\n \"first\": \"https:\/\/example.com\/api\/v1\/screenshots?page=1\",\n \"last\": \"https:\/\/example.com\/api\/v1\/screenshots?page=3\",\n \"prev\": null,\n \"next\": \"https:\/\/example.com\/api\/v1\/screenshots?page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 3,\n \"path\": \"https:\/\/example.com\/api\/v1\/screenshots\",\n \"per_page\": 30,\n \"to\": 30,\n \"total\": 85\n }\n}", "name": "success" } ] } ] }, { "name": "Tags", "description": "\nTeam-scoped tags that can be attached to contacts, projects, tasks, and other resources.", "item": [ { "name": "GET api\/v1\/tags", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tags", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tags" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "X-Inertia" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "set-cookie", "value": "XSRF-TOKEN=eyJpdiI6IkNNcW1EVm9CRWlWMTd2OVQyb1gzRnc9PSIsInZhbHVlIjoiclQyS3VrSzNENXdrZmU4ZE5pOS9ZbWV0bzBKZ0ZteXNISTIxY1NpTElvUitvSWkxRk9XeTFSZ3RCRW90WHk1eUVGMG1yUUFMVDhRSFp6c0lIN0tQMm9zWDMxRzZDZFp0b1B4ejRORG1kelJzMy9hVUk5L0hEY01veUJOUVFCZ1giLCJtYWMiOiIwMzJiZDBjY2Y1MDljNDIwYjE5ZGQ5ODIxY2IyOWEwMjM1YTRkNGFhMGIwNWFjYmU0NjQyNGZmYmY5ZWUyOGIxIiwidGFnIjoiIn0%3D; expires=Thu, 17 Sep 2026 03:18:23 GMT; Max-Age=172800; path=\/; secure; samesite=lax; corcava_session=eyJpdiI6IlJIQS9KUVBvMXlvMWlsY1hPaUV6dXc9PSIsInZhbHVlIjoiS1RDZkxzYjhqT1lZTTVsMFR1aUdEUENCejh2VUJ1T1NyaEp4eWJMVHlDR204TXNsQThjNW9JbWcyTEJqdzhicy9NRVNMMGZHcFVCTFUwT0JWTzBkRmh0Vm1saXdtbW9nVjhzeE5ndUlqSFZzME5mNFNpYVAyQXhMVTQyWmlCc2UiLCJtYWMiOiI0NWI1OTU0ZmJlYzBlOWM5Y2U4Mzk0ZDhlMWQ5NGFiOTMzYTdhM2RlODEzNzEzY2UwNjdkZWRlYmRlN2JhN2JlIiwidGFnIjoiIn0%3D; expires=Thu, 17 Sep 2026 03:18:23 GMT; Max-Age=172800; path=\/; secure; httponly; samesite=lax" } ], "code": 401, "body": "{\"message\":\"Authorization required\"}", "name": "" } ] }, { "name": "POST api\/v1\/tags", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tags", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tags" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"color\":\"ngzmiyvdljnikhwa\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET api\/v1\/tags\/{tag_id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tags\/:tag_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tags\/:tag_id", "variable": [ { "id": "tag_id", "key": "tag_id", "value": "1", "description": "The ID of the tag." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "X-Inertia" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "set-cookie", "value": "XSRF-TOKEN=eyJpdiI6IkZFOEE2WkZGV3k1MGVlZ0xOQ1ptbVE9PSIsInZhbHVlIjoiODFQY1plZEVYT3ZzZG1idXU2SnJVbnQzWXQyS2F5UUw4WGJFdGprM2htOHZXclpwdUFnQzZoRDJ5a3QxRUt1UWJkdUU5dkE4UEY1dWFPdURxMjAySm9Femt5VVhLYnRTT3RLd255UmdqZlE2azNGR1ptaWpUMWhVbm1Jb1EzTHciLCJtYWMiOiI1OGMzNzA1N2NiMTZkODE5YTdmZWVhNDU4YjA1OGJmMmRmNDExYWQ2NDQ4ODhkZWM2Y2MzMTQ5NTA3YmUxYjBhIiwidGFnIjoiIn0%3D; expires=Thu, 17 Sep 2026 03:18:23 GMT; Max-Age=172800; path=\/; secure; samesite=lax; corcava_session=eyJpdiI6IjZjRlBmbldpck5kdXR2bExaU21URWc9PSIsInZhbHVlIjoiVnFEVTRGa1k0Mm1jRWhQOXNjMTg1emc0bmY5YjhtTkhuSXduV3BrVjRHeE9wWW82ODY3UUtDeGwwOUt5MnZOOForRUpoR1pkZ3B0TFd0WTRoKzBDTmlFZjRiKzdEVlB6ZENZVWU0bEQ3OEg2ais0TkJWSmsyV1FKWlRzRlNvZG4iLCJtYWMiOiIwMTk1MDYxNjA2ZGFiYTU0Y2NhNWNjMmY4ODFlYzc1MzQwNTU0ZGEzNzE2ZWExODliOWY2Y2VmMTAxOWYzY2QyIiwidGFnIjoiIn0%3D; expires=Thu, 17 Sep 2026 03:18:23 GMT; Max-Age=172800; path=\/; secure; httponly; samesite=lax" } ], "code": 401, "body": "{\"message\":\"Authorization required\"}", "name": "" } ] }, { "name": "PUT api\/v1\/tags\/{tag_id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tags\/:tag_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tags\/:tag_id", "variable": [ { "id": "tag_id", "key": "tag_id", "value": "1", "description": "The ID of the tag." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"color\":\"ngzmiyvdljnikhwa\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "DELETE api\/v1\/tags\/{tag_id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tags\/:tag_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tags\/:tag_id", "variable": [ { "id": "tag_id", "key": "tag_id", "value": "1", "description": "The ID of the tag." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "PUT api\/v1\/taggables\/{type}\/{id}\/tags", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/taggables\/:type\/:id\/tags", "query": [], "raw": "{{baseUrl}}\/api\/v1\/taggables\/:type\/:id\/tags", "variable": [ { "id": "type", "key": "type", "value": "architecto", "description": "" }, { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the {type}." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"tag_ids\":[16],\"tag_names\":[\"n\"]}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] } ] }, { "name": "Task Comments", "description": "\nAPIs for managing comments on tasks.\n\nComments are stored as TaskEvent records with type='comment'.\nThese endpoints let you list, add, update, and delete comments on tasks.\nEvery request must be authenticated via an active Public API key.", "item": [ { "name": "List comments on a task.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tasks\/:task\/comments", "query": [ { "key": "per_page", "value": "50", "description": "The number of results per page. Maximum: 100.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/tasks\/:task\/comments?per_page=50", "variable": [ { "id": "task", "key": "task", "value": "42", "description": "Task ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"task_id\": 42,\n \"user_id\": 5,\n \"user_name\": \"John Doe\",\n \"text\": \"Blocked waiting on design review\",\n \"created_at\": \"2025-01-11T10:15:00.000000Z\",\n \"updated_at\": \"2025-01-11T10:15:00.000000Z\"\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"total\": 1\n }\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Task not found\"}", "name": "not_found" } ] }, { "name": "Add a comment to a task.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tasks\/:task\/comments", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tasks\/:task\/comments", "variable": [ { "id": "task", "key": "task", "value": "42", "description": "Task ID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"text\":\"Blocked waiting on design review\"}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"id\": 15,\n \"task_id\": 42,\n \"user_id\": 5,\n \"user_name\": \"John Doe\",\n \"text\": \"Blocked waiting on design review\",\n \"created_at\": \"2025-01-11T10:15:00.000000Z\",\n \"updated_at\": \"2025-01-11T10:15:00.000000Z\"\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Task not found\"}", "name": "not_found" }, { "header": [], "code": 422, "body": "{\"message\": \"The text field is required.\"}", "name": "validation_error" } ] }, { "name": "Get a single comment.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tasks\/:task\/comments\/:comment", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tasks\/:task\/comments\/:comment", "variable": [ { "id": "task", "key": "task", "value": "42", "description": "Task ID." }, { "id": "comment", "key": "comment", "value": "15", "description": "Comment ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 15,\n \"task_id\": 42,\n \"user_id\": 5,\n \"user_name\": \"John Doe\",\n \"text\": \"Blocked waiting on design review\",\n \"created_at\": \"2025-01-11T10:15:00.000000Z\",\n \"updated_at\": \"2025-01-11T10:15:00.000000Z\"\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Comment not found\"}", "name": "not_found" } ] }, { "name": "Update a comment.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tasks\/:task\/comments\/:comment", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tasks\/:task\/comments\/:comment", "variable": [ { "id": "task", "key": "task", "value": "42", "description": "Task ID." }, { "id": "comment", "key": "comment", "value": "15", "description": "Comment ID." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"text\":\"Updated: Ready for QA\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 15,\n \"task_id\": 42,\n \"user_id\": 5,\n \"user_name\": \"John Doe\",\n \"text\": \"Updated: Ready for QA\",\n \"created_at\": \"2025-01-11T10:15:00.000000Z\",\n \"updated_at\": \"2025-01-11T16:30:00.000000Z\"\n}", "name": "success" }, { "header": [], "code": 403, "body": "{\"message\": \"You can only edit your own comments\"}", "name": "forbidden" }, { "header": [], "code": 404, "body": "{\"message\": \"Comment not found\"}", "name": "not_found" } ] }, { "name": "Delete a comment.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tasks\/:task\/comments\/:comment", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tasks\/:task\/comments\/:comment", "variable": [ { "id": "task", "key": "task", "value": "42", "description": "Task ID." }, { "id": "comment", "key": "comment", "value": "15", "description": "Comment ID." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "null", "name": "success" }, { "header": [], "code": 403, "body": "{\"message\": \"You can only delete your own comments\"}", "name": "forbidden" }, { "header": [], "code": 404, "body": "{\"message\": \"Comment not found\"}", "name": "not_found" } ] } ] }, { "name": "Task Events", "description": "\nAPIs for managing task events (comments, system events).\n\nTask events represent activity history of a task, such as user comments\nor system-generated changes.", "item": [ { "name": "Display a paginated list of task events.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tasks\/:task_id\/events", "query": [ { "key": "type", "value": "comment", "description": "Filter events by type.", "disabled": false }, { "key": "user_id", "value": "12", "description": "Filter events by author id.", "disabled": false }, { "key": "per_page", "value": "30", "description": "Number of results per page. Maximum: 100.", "disabled": false }, { "key": "sort", "value": "created_at", "description": "Column used for sorting. Allowed: id, created_at, updated_at.", "disabled": false }, { "key": "direction", "value": "desc", "description": "Sort direction. Allowed: asc, desc.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/tasks\/:task_id\/events?type=comment&user_id=12&per_page=30&sort=created_at&direction=desc", "variable": [ { "id": "task_id", "key": "task_id", "value": "8", "description": "The ID of the task." }, { "id": "task", "key": "task", "value": "15", "description": "Task id." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 101,\n \"task_id\": 15,\n \"user_id\": 12,\n \"type\": \"comment\",\n \"text\": \"Looks good to me\",\n \"created_at\": \"2025-01-15T10:30:00.000000Z\",\n \"user\": {\n \"id\": 12,\n \"name\": \"Alex Johnson\"\n }\n }\n ],\n \"links\": {\n \"first\": \"https:\/\/example.com\/api\/v1\/tasks\/15\/events?page=1\",\n \"last\": \"https:\/\/example.com\/api\/v1\/tasks\/15\/events?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"path\": \"https:\/\/example.com\/api\/v1\/tasks\/15\/events\",\n \"per_page\": 30,\n \"to\": 1,\n \"total\": 1\n }\n}", "name": "success" } ] }, { "name": "Create a new task event (comment).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tasks\/:task_id\/events", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tasks\/:task_id\/events", "variable": [ { "id": "task_id", "key": "task_id", "value": "8", "description": "The ID of the task." }, { "id": "task", "key": "task", "value": "15", "description": "Task id." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"text\":\"Please fix the validation logic.\"}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"id\": 102,\n \"task_id\": 15,\n \"user_id\": 12,\n \"type\": \"comment\",\n \"text\": \"Please fix the validation logic.\",\n \"created_at\": \"2025-01-15T11:00:00.000000Z\",\n \"user\": {\n \"id\": 12,\n \"name\": \"Alex Johnson\"\n }\n}", "name": "success" } ] }, { "name": "Delete a task event.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/task-events\/:taskEvent_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/task-events\/:taskEvent_id", "variable": [ { "id": "taskEvent_id", "key": "taskEvent_id", "value": "1", "description": "The ID of the taskEvent." }, { "id": "taskEvent", "key": "taskEvent", "value": "102", "description": "Task event id." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "null", "name": "success" }, { "header": [], "code": 403, "body": "{\"message\": \"This action is unauthorized.\"}", "name": "forbidden" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" } ] } ] }, { "name": "Task Labels", "description": "\nAPIs for managing task labels.\n\nTask labels allow you to categorize and organize tasks within a project board. These endpoints let you list board labels and attach\/detach labels to specific tasks.", "item": [ { "name": "Display a paginated list of board labels.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/boards\/:board_id\/labels", "query": [ { "key": "per_page", "value": "30", "description": "Number of results per page. Maximum: 100.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/boards\/:board_id\/labels?per_page=30", "variable": [ { "id": "board_id", "key": "board_id", "value": "1", "description": "The ID of the board." }, { "id": "board", "key": "board", "value": "5", "description": "Board ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"title\": \"Bug\",\n \"color\": \"#FF0000\",\n \"board_id\": 5\n },\n {\n \"id\": 2,\n \"title\": \"Feature\",\n \"color\": \"#00FF00\",\n \"board_id\": 5\n }\n ],\n \"links\": {\n \"first\": \"https:\/\/example.com\/api\/v1\/boards\/5\/labels?page=1\",\n \"last\": \"https:\/\/example.com\/api\/v1\/boards\/5\/labels?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"path\": \"https:\/\/example.com\/api\/v1\/boards\/5\/labels\",\n \"per_page\": 30,\n \"to\": 2,\n \"total\": 2\n }\n}", "name": "success" } ] }, { "name": "Attach a label to a task.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tasks\/:task_id\/labels", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tasks\/:task_id\/labels", "variable": [ { "id": "task_id", "key": "task_id", "value": "8", "description": "The ID of the task." }, { "id": "task", "key": "task", "value": "42", "description": "Task ID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"label_id\":1}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"id\": 123,\n \"task_id\": 42,\n \"label_id\": 1,\n \"created_at\": \"2025-01-10T08:00:00.000000Z\",\n \"updated_at\": \"2025-01-10T08:00:00.000000Z\"\n}", "name": "success" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The label id field is required.\",\n \"errors\": {\n \"label_id\": [\"The label id field is required.\"]\n }\n}", "name": "validation_error" } ] }, { "name": "Update a task label.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tasks\/:task_id\/labels\/:label", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tasks\/:task_id\/labels\/:label", "variable": [ { "id": "task_id", "key": "task_id", "value": "8", "description": "The ID of the task." }, { "id": "label", "key": "label", "value": "1", "description": "Current label ID attached to the task." }, { "id": "task", "key": "task", "value": "42", "description": "Task ID." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"label_id\":2}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 123,\n \"task_id\": 42,\n \"label_id\": 2,\n \"created_at\": \"2025-01-10T08:00:00.000000Z\",\n \"updated_at\": \"2025-01-10T08:30:00.000000Z\"\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Label not found on task\"}", "name": "not_found" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The label id field is required.\",\n \"errors\": {\n \"label_id\": [\"The label id field is required.\"]\n }\n}", "name": "validation_error" } ] }, { "name": "Detach a label from a task.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tasks\/:task_id\/labels\/:label", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tasks\/:task_id\/labels\/:label", "variable": [ { "id": "task_id", "key": "task_id", "value": "8", "description": "The ID of the task." }, { "id": "label", "key": "label", "value": "1", "description": "Label ID to detach from the task." }, { "id": "task", "key": "task", "value": "42", "description": "Task ID." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "null", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Label not found on task\"}", "name": "not_found" } ] } ] }, { "name": "Tasks", "description": "\nAPIs for managing project tasks.\n\nThese endpoints let you list, create, update, and delete tasks that belong to your team.\nEvery request must be authenticated via an active Public API key.", "item": [ { "name": "Display a paginated list of tasks for the authenticated team.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tasks", "query": [ { "key": "search", "value": "onboarding", "description": "Filter tasks by partial match in the task name.", "disabled": false }, { "key": "project_id", "value": "12", "description": "Filter tasks by related project id.", "disabled": false }, { "key": "board_id", "value": "7", "description": "Filter tasks by project board id.", "disabled": false }, { "key": "column_id", "value": "20", "description": "Filter tasks by column id.", "disabled": false }, { "key": "assigned_to_me", "value": "1", "description": "When true (e.g. 1 or \"true\"), return only tasks assigned to the authenticated user (via task_users). When omitted or false, no assignment filter is applied. Requires authentication.", "disabled": false }, { "key": "per_page", "value": "50", "description": "The number of results per page. Maximum: 100.", "disabled": false }, { "key": "sort", "value": "created_at", "description": "Column used for sorting. Allowed: id, name, created_at, updated_at.", "disabled": false }, { "key": "direction", "value": "desc", "description": "Sort direction. Allowed: asc, desc.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/tasks?search=onboarding&project_id=12&board_id=7&column_id=20&assigned_to_me=1&per_page=50&sort=created_at&direction=desc" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Follow up call\",\n \"description\": \"Call the client back with the pricing update.\",\n \"slug\": \"follow-up-call\",\n \"team_id\": 8,\n \"project_id\": 3,\n \"project_board_id\": 5,\n \"column_id\": 9,\n \"contact_id\": 21,\n \"company_id\": null,\n \"outreach_id\": null,\n \"estimate_time\": null,\n \"date_from\": \"2025-01-10\",\n \"date_to\": null,\n \"closed_at\": null,\n \"amount\": \"0.00\",\n \"order\": 2,\n \"created_at\": \"2025-01-11T10:15:00.000000Z\",\n \"updated_at\": \"2025-01-11T10:15:00.000000Z\",\n \"deleted_at\": null\n }\n ],\n \"links\": {\n \"first\": \"https:\/\/example.com\/api\/v1\/tasks?page=1\",\n \"last\": \"https:\/\/example.com\/api\/v1\/tasks?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"path\": \"https:\/\/example.com\/api\/v1\/tasks\",\n \"per_page\": 30,\n \"to\": 1,\n \"total\": 1\n }\n}", "name": "success" } ] }, { "name": "Create a new task.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tasks", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tasks" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Follow up call\",\"description\":\"Call the client back with the pricing update.\",\"estimate_time\":3.5,\"date_from\":\"2025-01-10\",\"date_to\":\"2025-01-12\",\"closed_at\":\"2026-09-15T03:18:21\",\"outreach_id\":16,\"company_id\":16,\"project_id\":3,\"contact_id\":21,\"column_id\":9,\"order\":5,\"amount\":2500,\"slug\":\"m\",\"user_ids\":[1,2,3],\"project_ref\":{\"id\":16,\"name\":\"n\"},\"tag_names\":[\"g\"],\"add_tag_names\":[\"z\"],\"remove_tag_names\":[\"m\"],\"create_missing_tags\":true}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"id\": 42,\n \"name\": \"Follow up call\",\n \"description\": \"Call the client back with the pricing update.\",\n \"slug\": \"follow-up-call\",\n \"team_id\": 8,\n \"project_id\": 3,\n \"project_board_id\": 5,\n \"column_id\": 9,\n \"contact_id\": 21,\n \"company_id\": null,\n \"outreach_id\": null,\n \"estimate_time\": null,\n \"date_from\": \"2025-01-10\",\n \"date_to\": null,\n \"closed_at\": null,\n \"amount\": \"0.00\",\n \"order\": 2,\n \"created_at\": \"2025-01-11T10:15:00.000000Z\",\n \"updated_at\": \"2025-01-11T10:15:00.000000Z\",\n \"deleted_at\": null\n}", "name": "success" }, { "header": [], "code": 422, "body": "{\"message\": \"Column not found\"}", "name": "validation_error" } ] }, { "name": "Display a single task.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tasks\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tasks\/:id", "variable": [ { "id": "id", "key": "id", "value": "42", "description": "Task id." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 42,\n \"name\": \"Follow up call\",\n \"description\": \"Call the client back with the pricing update.\",\n \"slug\": \"follow-up-call\",\n \"team_id\": 8,\n \"project_id\": 3,\n \"project_board_id\": 5,\n \"column_id\": 9,\n \"contact_id\": 21,\n \"company_id\": null,\n \"outreach_id\": null,\n \"estimate_time\": null,\n \"date_from\": \"2025-01-10\",\n \"date_to\": null,\n \"closed_at\": null,\n \"amount\": \"0.00\",\n \"order\": 2,\n \"created_at\": \"2025-01-11T10:15:00.000000Z\",\n \"updated_at\": \"2025-01-11T10:15:00.000000Z\",\n \"deleted_at\": null\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" } ] }, { "name": "Update a task.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tasks\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tasks\/:id", "variable": [ { "id": "id", "key": "id", "value": "42", "description": "Task id." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Follow up call\",\"description\":\"Call the client with the new quote.\",\"estimate_time\":4,\"date_from\":\"2025-01-10\",\"date_to\":\"2025-01-12\",\"closed_at\":\"2026-09-15T03:18:21\",\"outreach_id\":16,\"company_id\":16,\"project_id\":3,\"contact_id\":21,\"column_id\":9,\"order\":5,\"amount\":2500,\"slug\":\"m\",\"user_ids\":[1,2,3],\"tag_names\":[\"g\"],\"add_tag_names\":[\"z\"],\"remove_tag_names\":[\"m\"],\"create_missing_tags\":true}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 42,\n \"name\": \"Follow up call\",\n \"description\": \"Call the client with the new quote.\",\n \"slug\": \"follow-up-call\",\n \"team_id\": 8,\n \"project_id\": 3,\n \"project_board_id\": 5,\n \"column_id\": 9,\n \"contact_id\": 21,\n \"company_id\": null,\n \"outreach_id\": null,\n \"estimate_time\": null,\n \"date_from\": \"2025-01-10\",\n \"date_to\": null,\n \"closed_at\": null,\n \"amount\": \"0.00\",\n \"order\": 4,\n \"created_at\": \"2025-01-11T10:15:00.000000Z\",\n \"updated_at\": \"2025-01-11T16:20:00.000000Z\",\n \"deleted_at\": null\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" } ] }, { "name": "Delete a task.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tasks\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tasks\/:id", "variable": [ { "id": "id", "key": "id", "value": "42", "description": "Task id." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "null", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" } ] } ] }, { "name": "Team Invoices", "description": "\nAPIs for managing team invoices.\n\nInvoices represent bills issued to clients. These endpoints let you list, view, close, and reopen invoices that belong to your team.", "item": [ { "name": "Display a paginated list of team invoices.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/team-invoices", "query": [ { "key": "search", "value": "INV-2023-001", "description": "Filter invoices by invoice number.", "disabled": false }, { "key": "user_id", "value": "12", "description": "Filter invoices by user (creator) id.", "disabled": false }, { "key": "status", "value": "sent", "description": "Filter by invoice status.", "disabled": false }, { "key": "date_from", "value": "2023-01-01", "description": "date Filter invoices created from this date (YYYY-MM-DD).", "disabled": false }, { "key": "date_to", "value": "2023-12-31", "description": "date Filter invoices created until this date (YYYY-MM-DD).", "disabled": false }, { "key": "per_page", "value": "50", "description": "Number of results per page. Maximum: 100.", "disabled": false }, { "key": "sort", "value": "created_at", "description": "Column used for sorting. Allowed: id, number, amount, status, issue_date, due_date, created_at, updated_at.", "disabled": false }, { "key": "direction", "value": "desc", "description": "Sort direction. Allowed: asc, desc.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/team-invoices?search=INV-2023-001&user_id=12&status=sent&date_from=2023-01-01&date_to=2023-12-31&per_page=50&sort=created_at&direction=desc" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 45,\n \"number\": \"INV-2023-001\",\n \"hash\": \"abc123def456\",\n \"status\": \"sent\",\n \"amount\": 1500.00,\n \"currency_id\": 1,\n \"issue_date\": \"2023-01-15\",\n \"due_date\": \"2023-02-15\",\n \"client_id\": 8,\n \"user_id\": 12,\n \"team_id\": 5,\n \"created_at\": \"2023-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2023-01-15T10:00:00.000000Z\",\n \"currency\": {\n \"id\": 1,\n \"code\": \"USD\",\n \"name\": \"US Dollar\"\n },\n \"user\": {\n \"id\": 12,\n \"name\": \"John Doe\",\n \"email\": \"john@example.com\"\n },\n \"items\": [\n {\n \"id\": 1,\n \"description\": \"Website Development\",\n \"quantity\": 10,\n \"unit_price\": 150.00,\n \"total\": 1500.00\n }\n ]\n }\n ],\n \"links\": {\n \"first\": \"https:\/\/example.com\/api\/v1\/team-invoices?page=1\",\n \"last\": \"https:\/\/example.com\/api\/v1\/team-invoices?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"path\": \"https:\/\/example.com\/api\/v1\/team-invoices\",\n \"per_page\": 50,\n \"to\": 1,\n \"total\": 1\n }\n}", "name": "success" } ] }, { "name": "Display a single team invoice.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/team-invoices\/:hash", "query": [], "raw": "{{baseUrl}}\/api\/v1\/team-invoices\/:hash", "variable": [ { "id": "hash", "key": "hash", "value": "abc123def456", "description": "Invoice hash identifier." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 45,\n \"number\": \"INV-2023-001\",\n \"hash\": \"abc123def456\",\n \"status\": \"sent\",\n \"amount\": 1500.00,\n \"currency_id\": 1,\n \"issue_date\": \"2023-01-15\",\n \"due_date\": \"2023-02-15\",\n \"client_id\": 8,\n \"user_id\": 12,\n \"team_id\": 5,\n \"created_at\": \"2023-01-15T10:00:00.000000Z\",\n \"updated_at\": \"2023-01-15T10:00:00.000000Z\",\n \"total_paid\": 750.00,\n \"balance_due\": 750.00,\n \"currency\": {\n \"id\": 1,\n \"code\": \"USD\",\n \"name\": \"US Dollar\"\n },\n \"user\": {\n \"id\": 12,\n \"name\": \"John Doe\",\n \"email\": \"john@example.com\"\n },\n \"items\": [\n {\n \"id\": 1,\n \"description\": \"Website Development\",\n \"quantity\": 10,\n \"unit_price\": 150.00,\n \"total\": 1500.00\n }\n ],\n \"invoice_payments\": [\n {\n \"id\": 3,\n \"amount_paid\": 750.00,\n \"payment_date\": \"2023-01-20\",\n \"payment_method\": \"credit_card\"\n }\n ]\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Team invoice not found\"}", "name": "not_found" } ] }, { "name": "Close an invoice.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/team-invoices\/:hash\/close", "query": [], "raw": "{{baseUrl}}\/api\/v1\/team-invoices\/:hash\/close", "variable": [ { "id": "hash", "key": "hash", "value": "abc123def456", "description": "Invoice hash identifier." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Marks a sent invoice as closed. Only invoices with \"sent\" status can be closed." }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Team invoice closed successfully\"\n}", "name": "success" }, { "header": [], "code": 403, "body": "{\n \"message\": \"This action is unauthorized.\"\n}", "name": "unauthorized" }, { "header": [], "code": 404, "body": "{\"message\": \"Team invoice not found\"}", "name": "not_found" }, { "header": [], "code": 422, "body": "{\n \"message\": \"Only sent invoices can be closed.\"\n}", "name": "invalid_status" } ] }, { "name": "Reopen an invoice.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/team-invoices\/:hash\/reopen", "query": [], "raw": "{{baseUrl}}\/api\/v1\/team-invoices\/:hash\/reopen", "variable": [ { "id": "hash", "key": "hash", "value": "abc123def456", "description": "Invoice hash identifier." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Reopens a closed invoice, changing its status back to sent. Only invoices with \"closed\" status can be reopened." }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Team invoice reopened successfully\"\n}", "name": "success" }, { "header": [], "code": 403, "body": "{\n \"message\": \"This action is unauthorized.\"\n}", "name": "unauthorized" }, { "header": [], "code": 404, "body": "{\"message\": \"Team invoice not found\"}", "name": "not_found" }, { "header": [], "code": 422, "body": "{\n \"message\": \"Only closed invoices can be reopened.\"\n}", "name": "invalid_status" } ] } ] }, { "name": "Team Members", "description": "\nAPIs for listing team members (users).\n\nTeam members are users who belong to your team. Use these endpoints to search and list members.\nThis endpoint supports fuzzy search - typos, partial names, and accents are handled automatically.", "item": [ { "name": "List team members with optional fuzzy search.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users", "query": [ { "key": "search", "value": "alex", "description": "Search by name or email (fuzzy matching).", "disabled": false }, { "key": "per_page", "value": "50", "description": "Number of results per page. Maximum: 100.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/users?search=alex&per_page=50" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns team members matching the search query. Supports fuzzy matching:\n- \"Alex\" finds \"Alexander\"\n- \"romanko\" finds \"Romank\u00f3\"\n- Typo-tolerant search" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 12,\n \"name\": \"Alexander Romank\u00f3\",\n \"email\": \"alex@example.com\",\n \"profile_photo_url\": \"https:\/\/example.com\/photos\/12.jpg\"\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"total\": 1\n }\n}", "name": "success" } ] }, { "name": "Get a single team member by ID.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:id", "variable": [ { "id": "id", "key": "id", "value": "12", "description": "User ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 12,\n \"name\": \"Alexander Romank\u00f3\",\n \"email\": \"alex@example.com\",\n \"profile_photo_url\": \"https:\/\/example.com\/photos\/12.jpg\"\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" } ] }, { "name": "Update a team member (admin only).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:id", "variable": [ { "id": "id", "key": "id", "value": "12", "description": "User ID." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"is_active\":true,\"can_add_manual_time\":true,\"can_move_time\":false,\"target_hours\":40}" }, "description": "Only admins (SuperAdmin, OrganizationManager) can update team members.\nFields that can be updated (defined in User::API_UPDATABLE_FIELDS):\n- is_active: Enable\/disable user\n- can_add_manual_time: Allow manual time entry\n- can_move_time: Allow moving time between projects\n- target_hours: Weekly target hours goal" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 12,\n \"name\": \"Alexander Romank\u00f3\",\n \"email\": \"alex@example.com\",\n \"is_active\": true,\n \"can_add_manual_time\": true,\n \"can_move_time\": false,\n \"target_hours\": 40\n}", "name": "success" }, { "header": [], "code": 403, "body": "{\"message\": \"Only admins can update team members\"}", "name": "forbidden" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" } ] }, { "name": "Invite a new team member.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/invite", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/invite" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"john@example.com\",\"role\":\"user\",\"pay_rate\":25,\"projects\":[1,2,3],\"is_manager\":false}" }, "description": "Send an invitation email to a new team member. Only admins (SuperAdmin, OrganizationManager) can invite." }, "response": [ { "header": [], "code": 201, "body": "{\n \"message\": \"Invitation sent successfully\",\n \"data\": {\n \"email\": \"john@example.com\",\n \"role\": \"user\",\n \"pay_rate\": 25.00,\n \"projects\": [1, 2, 3]\n }\n}", "name": "success" }, { "header": [], "code": 403, "body": "{\"message\": \"This action is unauthorized.\"}", "name": "forbidden" }, { "header": [], "code": 422, "body": "{\"message\": \"This user already belongs to the team.\"}", "name": "already_member" }, { "header": [], "code": 422, "body": "{\"message\": \"User already has a team.\"}", "name": "has_team" } ] } ] }, { "name": "Tickets", "description": "\nAPIs for managing user tickets\n\nThese endpoints allow a user to list, create, update, and delete their own tickets.\nAccess is restricted by API key and user ownership. Use `auth:api` middleware.", "item": [ { "name": "Display a list of the authenticated user's tickets.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tickets", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tickets" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "[\n {\n \"id\": 39,\n \"name\": \"Login issue\",\n \"description\": \"Cannot log in.\",\n \"status\": \"new\",\n \"priority\": \"high\",\n \"source\": \"email\",\n \"owner_id\": 1251,\n \"client_id\": null,\n \"team_id\": 514,\n \"adds_client_activity\": 1,\n \"created_at\": \"2025-10-23T00:00:00.000000Z\",\n \"updated_at\": \"2025-10-23T14:37:12.000000Z\"\n }\n]", "name": "success" } ] }, { "name": "Store a newly created ticket.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tickets", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tickets" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"\\\"Login issue\\\"\",\"description\":\"\\\"Cannot log in.\\\"\",\"status\":\"new\",\"priority\":\"low\",\"source\":\"email\",\"client_id\":16,\"contact_id\":16}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"id\": 39,\n \"name\": \"Login issue\",\n \"description\": \"Cannot log in.\",\n \"status\": \"new\",\n \"priority\": \"high\",\n \"source\": \"email\",\n \"owner_id\": 1251,\n \"client_id\": null,\n \"team_id\": 514,\n \"adds_client_activity\": 1,\n \"created_at\": \"2025-10-23T00:00:00.000000Z\",\n \"updated_at\": \"2025-10-23T14:37:12.000000Z\"\n}", "name": "success" } ] }, { "name": "Display the specified ticket (only if it belongs to the user).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tickets\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tickets\/:id", "variable": [ { "id": "id", "key": "id", "value": "39", "description": "ticket ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 39,\n \"name\": \"Login issue\",\n \"description\": \"Cannot log in.\",\n \"status\": \"new\",\n \"priority\": \"high\",\n \"source\": \"email\",\n \"owner_id\": 1251,\n \"client_id\": null,\n \"team_id\": 514,\n \"adds_client_activity\": 1,\n \"created_at\": \"2025-10-23T00:00:00.000000Z\",\n \"updated_at\": \"2025-10-23T14:37:12.000000Z\"\n}", "name": "success" }, { "header": [], "code": 403, "body": "{\"message\": \"Forbidden\"}", "name": "unauthorized" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" } ] }, { "name": "Update the specified ticket.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tickets\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tickets\/:id", "variable": [ { "id": "id", "key": "id", "value": "39", "description": "ticket ID." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"\\\"Login issue\\\"\",\"description\":\"\\\"Cannot log in.\\\"\",\"status\":\"new\",\"priority\":\"low\",\"source\":\"email\",\"client_id\":16,\"contact_id\":16}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 39,\n \"name\": \"Login issue\",\n \"description\": \"Cannot log in.\",\n \"status\": \"new\",\n \"priority\": \"high\",\n \"source\": \"email\",\n \"owner_id\": 1251,\n \"client_id\": null,\n \"team_id\": 514,\n \"adds_client_activity\": 1,\n \"created_at\": \"2025-10-23T00:00:00.000000Z\",\n \"updated_at\": \"2025-10-23T14:37:12.000000Z\"\n}", "name": "success" }, { "header": [], "code": 403, "body": "{\"message\": \"Forbidden\"}", "name": "unauthorized" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" } ] }, { "name": "Remove the specified ticket.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tickets\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/tickets\/:id", "variable": [ { "id": "id", "key": "id", "value": "39", "description": "ticket ID." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "null", "name": "success" }, { "header": [], "code": 403, "body": "{\"message\": \"Forbidden\"}", "name": "unauthorized" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" } ] } ] }, { "name": "Time Intervals", "description": "\nAPIs for managing time intervals.\n\nTime intervals represent periods of tracked work. These endpoints let you list, create, update, delete, and move time intervals.", "item": [ { "name": "Display a paginated list of time intervals.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/time-intervals", "query": [ { "key": "project_id", "value": "15", "description": "Filter intervals by project ID.", "disabled": false }, { "key": "user_id", "value": "42", "description": "Filter intervals by user ID.", "disabled": false }, { "key": "date_from", "value": "2024-01-01", "description": "date Filter intervals starting from this date (YYYY-MM-DD).", "disabled": false }, { "key": "date_to", "value": "2024-12-31", "description": "date Filter intervals ending before this date (YYYY-MM-DD).", "disabled": false }, { "key": "is_invoiced", "value": "1", "description": "Filter by invoiced status.", "disabled": false }, { "key": "per_page", "value": "50", "description": "Number of results per page. Maximum: 100.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/time-intervals?project_id=15&user_id=42&date_from=2024-01-01&date_to=2024-12-31&is_invoiced=1&per_page=50" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 123,\n \"project_id\": 15,\n \"user_id\": 42,\n \"started_at\": \"2024-03-15T09:00:00.000000Z\",\n \"finished_at\": \"2024-03-15T10:30:00.000000Z\",\n \"manual_time\": true,\n \"source\": \"api\",\n \"is_invoiced\": false,\n \"created_at\": \"2024-03-15T10:30:05.000000Z\",\n \"updated_at\": \"2024-03-15T10:30:05.000000Z\"\n }\n ],\n \"links\": {\n \"first\": \"https:\/\/example.com\/api\/v1\/time-intervals?page=1\",\n \"last\": \"https:\/\/example.com\/api\/v1\/time-intervals?page=3\",\n \"prev\": null,\n \"next\": \"https:\/\/example.com\/api\/v1\/time-intervals?page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 3,\n \"path\": \"https:\/\/example.com\/api\/v1\/time-intervals\",\n \"per_page\": 50,\n \"to\": 50,\n \"total\": 125\n }\n}", "name": "success" } ] }, { "name": "Display a single time interval.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/time-intervals\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/time-intervals\/:id", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "Time interval ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 123,\n \"project_id\": 15,\n \"user_id\": 42,\n \"started_at\": \"2024-03-15T09:00:00.000000Z\",\n \"finished_at\": \"2024-03-15T10:30:00.000000Z\",\n \"manual_time\": true,\n \"source\": \"api\",\n \"is_invoiced\": false,\n \"created_at\": \"2024-03-15T10:30:05.000000Z\",\n \"updated_at\": \"2024-03-15T10:30:05.000000Z\"\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" } ] }, { "name": "Create a new time interval.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/time-intervals", "query": [], "raw": "{{baseUrl}}\/api\/v1\/time-intervals" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"project_id\":15,\"started_at\":\"2024-03-15T09:00:00Z\",\"finished_at\":\"2024-03-15T10:30:00Z\",\"user_id\":42}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"id\": 123,\n \"project_id\": 15,\n \"user_id\": 42,\n \"started_at\": \"2024-03-15T09:00:00.000000Z\",\n \"finished_at\": \"2024-03-15T10:30:00.000000Z\",\n \"manual_time\": true,\n \"source\": \"api\",\n \"is_invoiced\": false,\n \"created_at\": \"2024-03-15T10:30:05.000000Z\",\n \"updated_at\": \"2024-03-15T10:30:05.000000Z\"\n}", "name": "success" }, { "header": [], "code": 422, "body": "{\n \"message\": \"Project not found\"\n}", "name": "validation_error" } ] }, { "name": "Update a time interval.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/time-intervals\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/time-intervals\/:id", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "Time interval ID." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"started_at\":\"2024-03-15T09:00:00Z\",\"finished_at\":\"2024-03-15T10:30:00Z\",\"project_id\":15,\"user_id\":42}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 123,\n \"project_id\": 15,\n \"user_id\": 42,\n \"started_at\": \"2024-03-15T09:00:00.000000Z\",\n \"finished_at\": \"2024-03-15T11:00:00.000000Z\",\n \"manual_time\": true,\n \"source\": \"api\",\n \"is_invoiced\": false,\n \"created_at\": \"2024-03-15T10:30:05.000000Z\",\n \"updated_at\": \"2024-03-15T11:05:12.000000Z\"\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" } ] }, { "name": "Delete a time interval.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/time-intervals\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/time-intervals\/:id", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "Time interval ID." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "null", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" } ] }, { "name": "Move a time interval to another project.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/time-intervals\/:id\/move", "query": [], "raw": "{{baseUrl}}\/api\/v1\/time-intervals\/:id\/move", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "Time interval ID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"new_project_id\":18,\"reason\":\"Wrong project assignment\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\"message\": \"Not found\"}", "name": "not_found" }, { "header": [], "code": 422, "body": "{\n \"message\": \"Project not found\"\n}", "name": "validation_error" } ] } ] }, { "name": "Time Tracking", "description": "\nAPIs for managing time tracking via external sources (Telegram bot, Slack bot, Web Agent, etc.).\nThese endpoints allow starting and stopping time intervals manually.\n\nOnly users with manual time tracking enabled can use these endpoints.", "item": [ { "name": "Start Time Tracking", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/time-tracking\/start", "query": [], "raw": "{{baseUrl}}\/api\/v1\/time-tracking\/start" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"project_id\":5,\"task_id\":123,\"note\":\"Working on homepage\"}" }, "description": "Start tracking time on a project. Creates a new open time interval.\nOnly available for users with manual time tracking enabled.\n\nRequires either project_id or project_name. Use GET \/api\/v1\/projects to list available projects." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"started\",\n \"interval_id\": 456,\n \"project\": {\n \"id\": 5,\n \"name\": \"Website Redesign\"\n },\n \"started_at\": \"2025-12-26T10:30:00.000000Z\",\n \"message\": \"Time tracking started on Website Redesign\"\n}", "name": "success" }, { "header": [], "code": 403, "body": "{\n \"error\": \"Manual time tracking is not enabled for your account.\"\n}", "name": "manual_time_disabled" }, { "header": [], "code": 404, "body": "{\n \"error\": \"Project not found or you do not have access to it.\"\n}", "name": "project_not_found" }, { "header": [], "code": 409, "body": "{\n \"error\": \"You already have an active time tracking session.\",\n \"active_interval\": {\n \"id\": 123,\n \"project_name\": \"Other Project\",\n \"started_at\": \"2025-12-26T08:00:00.000000Z\",\n \"duration_hours\": 2.5\n }\n}", "name": "already_tracking" } ] }, { "name": "Stop Time Tracking", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/time-tracking\/stop", "query": [], "raw": "{{baseUrl}}\/api\/v1\/time-tracking\/stop" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"note\":\"Completed homepage design\"}" }, "description": "Stop the current active time tracking session." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"stopped\",\n \"interval_id\": 456,\n \"project\": {\n \"id\": 5,\n \"name\": \"Website Redesign\"\n },\n \"started_at\": \"2025-12-26T10:30:00.000000Z\",\n \"finished_at\": \"2025-12-26T12:45:00.000000Z\",\n \"duration\": \"2h 15m\",\n \"message\": \"Tracked 2h 15m on Website Redesign\"\n}", "name": "success" }, { "header": [], "code": 404, "body": "{\n \"error\": \"No active time tracking session found.\"\n}", "name": "no_active_tracking" } ] }, { "name": "Get Tracking Status", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/time-tracking\/status", "query": [], "raw": "{{baseUrl}}\/api\/v1\/time-tracking\/status" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get the current time tracking status for the authenticated user." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"tracking\",\n \"interval\": {\n \"id\": 456,\n \"project_id\": 5,\n \"project_name\": \"Website Redesign\",\n \"task_id\": null,\n \"started_at\": \"2025-12-26T10:30:00.000000Z\",\n \"duration_hours\": 1.5,\n \"duration_formatted\": \"1h 30m\"\n }\n}", "name": "tracking_active" }, { "header": [], "code": 200, "body": "{\n \"status\": \"not_tracking\",\n \"message\": \"You are not currently tracking time.\"\n}", "name": "not_tracking" } ] }, { "name": "Heartbeat - update last activity timestamp for web tracker.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/time-tracking\/heartbeat", "query": [], "raw": "{{baseUrl}}\/api\/v1\/time-tracking\/heartbeat" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Only applies to SOURCE_WEB intervals. Idempotent." }, "response": [] }, { "name": "Reconcile - handle away time (stop at last active, keep running, or split).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/time-tracking\/reconcile", "query": [], "raw": "{{baseUrl}}\/api\/v1\/time-tracking\/reconcile" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"action\":\"architecto\"}" }, "description": "" }, "response": [] }, { "name": "Add a note to the current web tracking interval.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/time-tracking\/interval\/:timeInterval_id\/note", "query": [], "raw": "{{baseUrl}}\/api\/v1\/time-tracking\/interval\/:timeInterval_id\/note", "variable": [ { "id": "timeInterval_id", "key": "timeInterval_id", "value": "12", "description": "The ID of the timeInterval." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"content\":\"Quick break\"}" }, "description": "" }, "response": [] } ] }, { "name": "Workflows", "description": "\nNatural-language automation workflows (compiled SQL + tool actions).", "item": [ { "name": "GET api\/v1\/workflows", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/workflows", "query": [], "raw": "{{baseUrl}}\/api\/v1\/workflows" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "X-Inertia" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "set-cookie", "value": "XSRF-TOKEN=eyJpdiI6IitNbEJNM3BUaDZ2QlJ3a3lSYmtzYWc9PSIsInZhbHVlIjoiTnFIcUVlbDdyMytvRnh6ZzdDUEZxb2dWaStGTzRReUJQbUpyREVWWGNMUGRxMmZJdlNTUEdnQWJJRlFCYjcrT3pXR25sSHRIYnd0Vm4zQ3hnckxTOUdXdE1GUHJadUlnQ0lsckhTeWxSOUtiREtGNWlpNldMUjdDM2NJMldFUG8iLCJtYWMiOiIzNjUwNGVkMDc3M2RmMTNjZDhjMzRjZmI5YTU5ZjhjOTczYTU0NDVkYTc3MmE2MjUzNGZmMTAyNzMxMTdiNjIyIiwidGFnIjoiIn0%3D; expires=Thu, 17 Sep 2026 03:18:22 GMT; Max-Age=172800; path=\/; secure; samesite=lax; corcava_session=eyJpdiI6Ilp6SWpsVkRUQTJRamdKakViYlo5dXc9PSIsInZhbHVlIjoiaEFDNmhBLzZscDgzOFJtMzJMaFhGdHZsQ0RXMUQwNjdENmovOFJoV21QVUNUY2VMMi9Lb0VuMTR0RklXdTFLVDRHeUZ4Y2lDK3FCVXVUTkhQUW5ydVRHMmprYlhBMS9pSHRFazNGNjR4Qi9kZStKSy9mQUxOT0pXZXhKVEtNR08iLCJtYWMiOiI3MWRiNGZiZjUzMTMxZDQwY2RmOTBlOTIyZjc1ODcwOTEyMDZiMjJhMTcxZmVjZjdhNzNhZjg4NjdkY2Q3YTkwIiwidGFnIjoiIn0%3D; expires=Thu, 17 Sep 2026 03:18:22 GMT; Max-Age=172800; path=\/; secure; httponly; samesite=lax" } ], "code": 401, "body": "{\"message\":\"Authorization required\"}", "name": "" } ] }, { "name": "POST api\/v1\/workflows", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/workflows", "query": [], "raw": "{{baseUrl}}\/api\/v1\/workflows" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"source_text\":\"n\",\"anchor_type\":\"contact\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "PUT api\/v1\/workflows\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/workflows\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/workflows\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the workflow." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"source_text\":\"n\",\"anchor_type\":\"contact\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "DELETE api\/v1\/workflows\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/workflows\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/workflows\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the workflow." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] } ] } ], "auth": { "type": "apikey", "apikey": [ { "key": "in", "value": "header", "type": "string" }, { "key": "key", "value": "X-API-Key", "type": "string" } ] } }