{ "info": { "name": "Apploye Partner API", "description": "Read-only partner API for Apploye time-tracking data.\n\nAuthenticate with the `X-APPLOYE-API-KEY` header (see the Security Scheme\nbelow). List endpoints are paginated (`page`/`limit` query params; response\nenvelope documented per operation) and rate-limited per organization,\nHTTP method, and canonical resource group. API Gateway also applies a\ncoarse service-wide ceiling. Authenticated application responses include\n`RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` whenever\nquota accounting succeeds.\n\nUser UUID field shapes vary by endpoint family: some responses expose a\ntop-level `user_id`, others nest it under `user.user_id` or `user.id`, and\na few embed it inside `created_by`/`updated_by`. Field names are stable\nwithin v1 \u2014 check each operation's response schema for the exact shape.\n\n## API versioning\n\n- **URL major version** \u2014 every operation path begins with `/v1/`. Incompatible wire changes will be published under a new prefix (e.g. `/v2/`) while `/v1/` remains during migration.\n- **Contract version** \u2014 this document's `info.version` (semver, currently 1.4.0) tracks the OpenAPI contract revision. Additive changes under `/v1/` bump minor or patch.\n\n`x-api-path-version` on this `info` object is the wire major version. It is not sent as an HTTP header.\n", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_postman_id": "apploye-partner-api-v1" }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-APPLOYE-API-KEY", "type": "string" }, { "key": "value", "value": "{{api_key}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "variable": [ { "key": "base_url", "value": "https://api.apploye.com" }, { "key": "api_key", "value": "" } ], "item": [ { "name": "Activity", "item": [ { "name": "listAppReports", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/app_reports", "host": [ "{{base_url}}" ], "path": [ "v1", "app_reports" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 20)", "disabled": true } ] }, "description": "Per-user per-day application time. Results sorted by descending date then user name.\n`app_data` within each item sorted by most time first.\nDate range max: 31 days. Offset pagination: default limit 20, max 20.\nUnknown `team_id` returns 404.\n" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/app_reports", "host": [ "{{base_url}}" ], "path": [ "v1", "app_reports" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 20)", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"user\": {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"email\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"image\": null,\n \"color\": \"string\"\n },\n \"working_day\": \"2025-06-01\",\n \"app_data\": [\n {\n \"app\": \"string\",\n \"time\": \"string\"\n }\n ],\n \"total_time\": \"string\"\n }\n ]\n}" }, { "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/app_reports", "host": [ "{{base_url}}" ], "path": [ "v1", "app_reports" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 20)", "disabled": true } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {\n \"start_date\": [\n \"start_date and end_date are required.\"\n ]\n }\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/app_reports", "host": [ "{{base_url}}" ], "path": [ "v1", "app_reports" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 20)", "disabled": true } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/app_reports", "host": [ "{{base_url}}" ], "path": [ "v1", "app_reports" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 20)", "disabled": true } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/app_reports", "host": [ "{{base_url}}" ], "path": [ "v1", "app_reports" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 20)", "disabled": true } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/app_reports", "host": [ "{{base_url}}" ], "path": [ "v1", "app_reports" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 20)", "disabled": true } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/app_reports", "host": [ "{{base_url}}" ], "path": [ "v1", "app_reports" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 20)", "disabled": true } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] }, { "name": "listUrlReports", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/url_reports", "host": [ "{{base_url}}" ], "path": [ "v1", "url_reports" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 20)", "disabled": true } ] }, "description": "Per-user per-day website URL time. Same structure and behavior as app_reports.\nDate range max: 31 days. Offset pagination: default limit 20, max 20.\nUnknown `team_id` returns 404.\n" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/url_reports", "host": [ "{{base_url}}" ], "path": [ "v1", "url_reports" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 20)", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"user\": {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"email\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"image\": null,\n \"color\": \"string\"\n },\n \"working_day\": \"2025-06-01\",\n \"url_data\": [\n {\n \"url\": \"string\",\n \"time\": \"string\"\n }\n ],\n \"total_time\": \"string\"\n }\n ]\n}" }, { "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/url_reports", "host": [ "{{base_url}}" ], "path": [ "v1", "url_reports" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 20)", "disabled": true } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {\n \"start_date\": [\n \"start_date and end_date are required.\"\n ]\n }\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/url_reports", "host": [ "{{base_url}}" ], "path": [ "v1", "url_reports" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 20)", "disabled": true } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/url_reports", "host": [ "{{base_url}}" ], "path": [ "v1", "url_reports" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 20)", "disabled": true } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/url_reports", "host": [ "{{base_url}}" ], "path": [ "v1", "url_reports" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 20)", "disabled": true } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/url_reports", "host": [ "{{base_url}}" ], "path": [ "v1", "url_reports" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 20)", "disabled": true } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/url_reports", "host": [ "{{base_url}}" ], "path": [ "v1", "url_reports" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 20)", "disabled": true } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] }, { "name": "listScreenshots", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/screenshots", "host": [ "{{base_url}}" ], "path": [ "v1", "screenshots" ], "query": [ { "key": "user_id", "value": "", "description": "User whose screenshots to retrieve", "disabled": false }, { "key": "date", "value": "2025-06-15", "description": "Target date (YYYY-MM-DD, max 179 days in the past)", "disabled": false }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true } ] }, "description": "Activity-block records for one user on one day, each with nested screenshot entries.\nReturns a **bare array** (not a paginated envelope).\n\n`user_id` and `date` are required. Max lookback: 179 days.\nReturns 404 if the user is not in this org or the date exceeds the lookback limit.\n" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/screenshots", "host": [ "{{base_url}}" ], "path": [ "v1", "screenshots" ], "query": [ { "key": "user_id", "value": "", "description": "User whose screenshots to retrieve", "disabled": false }, { "key": "date", "value": "2025-06-15", "description": "Target date (YYYY-MM-DD, max 179 days in the past)", "disabled": false }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"timesheet_id\": \"00000000-0000-0000-0000-000000000001\",\n \"start_timestamp\": 1748764800,\n \"end_timestamp\": 1748764800,\n \"activity\": 0,\n \"screen_count\": 1,\n \"screenshots\": [\n {\n \"timestamp\": 1748764800,\n \"image\": null,\n \"thumbnail\": null,\n \"screen_number\": 1\n }\n ]\n }\n]" }, { "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/screenshots", "host": [ "{{base_url}}" ], "path": [ "v1", "screenshots" ], "query": [ { "key": "user_id", "value": "", "description": "User whose screenshots to retrieve", "disabled": false }, { "key": "date", "value": "2025-06-15", "description": "Target date (YYYY-MM-DD, max 179 days in the past)", "disabled": false }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {\n \"start_date\": [\n \"start_date and end_date are required.\"\n ]\n }\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/screenshots", "host": [ "{{base_url}}" ], "path": [ "v1", "screenshots" ], "query": [ { "key": "user_id", "value": "", "description": "User whose screenshots to retrieve", "disabled": false }, { "key": "date", "value": "2025-06-15", "description": "Target date (YYYY-MM-DD, max 179 days in the past)", "disabled": false }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/screenshots", "host": [ "{{base_url}}" ], "path": [ "v1", "screenshots" ], "query": [ { "key": "user_id", "value": "", "description": "User whose screenshots to retrieve", "disabled": false }, { "key": "date", "value": "2025-06-15", "description": "Target date (YYYY-MM-DD, max 179 days in the past)", "disabled": false }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/screenshots", "host": [ "{{base_url}}" ], "path": [ "v1", "screenshots" ], "query": [ { "key": "user_id", "value": "", "description": "User whose screenshots to retrieve", "disabled": false }, { "key": "date", "value": "2025-06-15", "description": "Target date (YYYY-MM-DD, max 179 days in the past)", "disabled": false }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/screenshots", "host": [ "{{base_url}}" ], "path": [ "v1", "screenshots" ], "query": [ { "key": "user_id", "value": "", "description": "User whose screenshots to retrieve", "disabled": false }, { "key": "date", "value": "2025-06-15", "description": "Target date (YYYY-MM-DD, max 179 days in the past)", "disabled": false }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/screenshots", "host": [ "{{base_url}}" ], "path": [ "v1", "screenshots" ], "query": [ { "key": "user_id", "value": "", "description": "User whose screenshots to retrieve", "disabled": false }, { "key": "date", "value": "2025-06-15", "description": "Target date (YYYY-MM-DD, max 179 days in the past)", "disabled": false }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] }, { "name": "listSuspiciousActivityLogs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/suspicious_activity_logs", "host": [ "{{base_url}}" ], "path": [ "v1", "suspicious_activity_logs" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": false }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only logs whose `updated_at` is on or after this ISO 8601 UTC datetime. When used alone (with `user_id`), filters by `updated_at` only \u2014 no detection-time window. When combined with a date range, must fall within `start_date`/`end_date` (inclusive). Each log includes `updated_at` for watermarking the next poll.", "disabled": true }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "User whose logs to return. Must be an active non-client org member.", "disabled": false }, { "key": "severity", "value": "Critical", "description": "Filter by severity", "disabled": true }, { "key": "status", "value": "Open", "description": "Filter by status", "disabled": true }, { "key": "type", "value": "consecutive injection", "description": "Filter by injection type", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] }, "description": "Detected injection activity (consecutive or partial) logged by the Apploye desktop\nagent for one user. `user_id` is always required.\n\n**Filter modes** (provide at least one besides `user_id`):\n- **Date range:** `start_date` + `end_date` (max 31-day span) filter by when injection\n was detected (`start_timestamp`). Optional `timezone` overrides org timezone for\n day boundaries.\n- **Incremental:** `updated_since` alone filters by `blacklisted_app_logs.updated_at >=`\n watermark (no detection-time window).\n- **Combined:** date range plus `updated_since`; watermark must fall within the\n date window (inclusive, using request/org timezone).\n\nOffset pagination: default limit 50, max 100.\n" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/suspicious_activity_logs", "host": [ "{{base_url}}" ], "path": [ "v1", "suspicious_activity_logs" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": false }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only logs whose `updated_at` is on or after this ISO 8601 UTC datetime. When used alone (with `user_id`), filters by `updated_at` only \u2014 no detection-time window. When combined with a date range, must fall within `start_date`/`end_date` (inclusive). Each log includes `updated_at` for watermarking the next poll.", "disabled": true }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "User whose logs to return. Must be an active non-client org member.", "disabled": false }, { "key": "severity", "value": "Critical", "description": "Filter by severity", "disabled": true }, { "key": "status", "value": "Open", "description": "Filter by status", "disabled": true }, { "key": "type", "value": "consecutive injection", "description": "Filter by injection type", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"blacklisted_app_id\": \"00000000-0000-0000-0000-000000000001\",\n \"timesheet_id\": \"00000000-0000-0000-0000-000000000001\",\n \"status\": \"Open\",\n \"start_timestamp\": 1748764800,\n \"end_timestamp\": 1748764800,\n \"type\": \"consecutive injection\",\n \"severity\": \"Critical\",\n \"percentage\": 0,\n \"additional_info\": {},\n \"created_at\": \"2025-06-01T08:00:00Z\",\n \"created_by\": \"00000000-0000-0000-0000-000000000001\",\n \"updated_at\": \"2025-06-01T08:00:00Z\"\n }\n ]\n}" }, { "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/suspicious_activity_logs", "host": [ "{{base_url}}" ], "path": [ "v1", "suspicious_activity_logs" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": false }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only logs whose `updated_at` is on or after this ISO 8601 UTC datetime. When used alone (with `user_id`), filters by `updated_at` only \u2014 no detection-time window. When combined with a date range, must fall within `start_date`/`end_date` (inclusive). Each log includes `updated_at` for watermarking the next poll.", "disabled": true }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "User whose logs to return. Must be an active non-client org member.", "disabled": false }, { "key": "severity", "value": "Critical", "description": "Filter by severity", "disabled": true }, { "key": "status", "value": "Open", "description": "Filter by status", "disabled": true }, { "key": "type", "value": "consecutive injection", "description": "Filter by injection type", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {\n \"start_date\": [\n \"start_date and end_date are required.\"\n ]\n }\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/suspicious_activity_logs", "host": [ "{{base_url}}" ], "path": [ "v1", "suspicious_activity_logs" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": false }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only logs whose `updated_at` is on or after this ISO 8601 UTC datetime. When used alone (with `user_id`), filters by `updated_at` only \u2014 no detection-time window. When combined with a date range, must fall within `start_date`/`end_date` (inclusive). Each log includes `updated_at` for watermarking the next poll.", "disabled": true }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "User whose logs to return. Must be an active non-client org member.", "disabled": false }, { "key": "severity", "value": "Critical", "description": "Filter by severity", "disabled": true }, { "key": "status", "value": "Open", "description": "Filter by status", "disabled": true }, { "key": "type", "value": "consecutive injection", "description": "Filter by injection type", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/suspicious_activity_logs", "host": [ "{{base_url}}" ], "path": [ "v1", "suspicious_activity_logs" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": false }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only logs whose `updated_at` is on or after this ISO 8601 UTC datetime. When used alone (with `user_id`), filters by `updated_at` only \u2014 no detection-time window. When combined with a date range, must fall within `start_date`/`end_date` (inclusive). Each log includes `updated_at` for watermarking the next poll.", "disabled": true }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "User whose logs to return. Must be an active non-client org member.", "disabled": false }, { "key": "severity", "value": "Critical", "description": "Filter by severity", "disabled": true }, { "key": "status", "value": "Open", "description": "Filter by status", "disabled": true }, { "key": "type", "value": "consecutive injection", "description": "Filter by injection type", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/suspicious_activity_logs", "host": [ "{{base_url}}" ], "path": [ "v1", "suspicious_activity_logs" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": false }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only logs whose `updated_at` is on or after this ISO 8601 UTC datetime. When used alone (with `user_id`), filters by `updated_at` only \u2014 no detection-time window. When combined with a date range, must fall within `start_date`/`end_date` (inclusive). Each log includes `updated_at` for watermarking the next poll.", "disabled": true }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "User whose logs to return. Must be an active non-client org member.", "disabled": false }, { "key": "severity", "value": "Critical", "description": "Filter by severity", "disabled": true }, { "key": "status", "value": "Open", "description": "Filter by status", "disabled": true }, { "key": "type", "value": "consecutive injection", "description": "Filter by injection type", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/suspicious_activity_logs", "host": [ "{{base_url}}" ], "path": [ "v1", "suspicious_activity_logs" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": false }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only logs whose `updated_at` is on or after this ISO 8601 UTC datetime. When used alone (with `user_id`), filters by `updated_at` only \u2014 no detection-time window. When combined with a date range, must fall within `start_date`/`end_date` (inclusive). Each log includes `updated_at` for watermarking the next poll.", "disabled": true }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "User whose logs to return. Must be an active non-client org member.", "disabled": false }, { "key": "severity", "value": "Critical", "description": "Filter by severity", "disabled": true }, { "key": "status", "value": "Open", "description": "Filter by status", "disabled": true }, { "key": "type", "value": "consecutive injection", "description": "Filter by injection type", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/suspicious_activity_logs", "host": [ "{{base_url}}" ], "path": [ "v1", "suspicious_activity_logs" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": false }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only logs whose `updated_at` is on or after this ISO 8601 UTC datetime. When used alone (with `user_id`), filters by `updated_at` only \u2014 no detection-time window. When combined with a date range, must fall within `start_date`/`end_date` (inclusive). Each log includes `updated_at` for watermarking the next poll.", "disabled": true }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "User whose logs to return. Must be an active non-client org member.", "disabled": false }, { "key": "severity", "value": "Critical", "description": "Filter by severity", "disabled": true }, { "key": "status", "value": "Open", "description": "Filter by status", "disabled": true }, { "key": "type", "value": "consecutive injection", "description": "Filter by injection type", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] }, { "name": "retrieveSuspiciousActivityLog", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/suspicious_activity_logs/:id", "host": [ "{{base_url}}" ], "path": [ "v1", "suspicious_activity_logs", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] }, "description": "Full detail of a single suspicious activity log, including the nested\nblacklisted app, timesheet (with project/task), and creator profile.\n\nAccess is org-scoped: the log must belong to a timesheet in the calling\norganization. A log from another org returns 404.\n\n`id` must be UUID-shaped or the request never reaches this endpoint \u2014\nit resolves as 404 `ROUTE_NOT_FOUND` (routing-level), not a 400\nvalidation error.\n" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/suspicious_activity_logs/:id", "host": [ "{{base_url}}" ], "path": [ "v1", "suspicious_activity_logs", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"blacklisted_app\": {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"app_name\": \"string\",\n \"app_type\": \"string\",\n \"suspicion_level\": \"Critical\",\n \"process_name\": \"string\",\n \"os_name\": \"string\"\n },\n \"timesheet\": {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"start_timestamp\": 1748764800,\n \"end_timestamp\": 1748764800,\n \"user_id\": \"00000000-0000-0000-0000-000000000001\",\n \"project_id\": \"00000000-0000-0000-0000-000000000001\",\n \"task_id\": \"00000000-0000-0000-0000-000000000001\",\n \"project\": {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"name\": \"string\"\n },\n \"task\": {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"name\": \"string\"\n }\n },\n \"status\": \"Open\",\n \"start_timestamp\": 1748764800,\n \"end_timestamp\": 1748764800,\n \"type\": \"consecutive injection\",\n \"severity\": \"Critical\",\n \"percentage\": 0,\n \"additional_info\": {},\n \"created_at\": \"2025-06-01T08:00:00Z\",\n \"created_by\": {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"email\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"image\": null,\n \"color\": \"string\"\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/suspicious_activity_logs/:id", "host": [ "{{base_url}}" ], "path": [ "v1", "suspicious_activity_logs", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/suspicious_activity_logs/:id", "host": [ "{{base_url}}" ], "path": [ "v1", "suspicious_activity_logs", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/suspicious_activity_logs/:id", "host": [ "{{base_url}}" ], "path": [ "v1", "suspicious_activity_logs", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/suspicious_activity_logs/:id", "host": [ "{{base_url}}" ], "path": [ "v1", "suspicious_activity_logs", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/suspicious_activity_logs/:id", "host": [ "{{base_url}}" ], "path": [ "v1", "suspicious_activity_logs", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] } ] }, { "name": "Leaves", "item": [ { "name": "listLeaveApplications", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_applications", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_applications" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "status", "value": "pending", "description": "Filter by application status", "disabled": true }, { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": true }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": true }, { "key": "leave_type_id", "value": "", "description": "Filter to a specific leave type (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] }, "description": "All active leave applications for the organization.\nFilter by `user_id`, `status`, `start_date`/`end_date` (matched against application\n`start` and `end` fields), or `leave_type_id`.\n\nValid status values: `pending`, `accepted`, `rejected`.\nOffset pagination: default limit 50, max 100.\n" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_applications", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_applications" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "status", "value": "pending", "description": "Filter by application status", "disabled": true }, { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": true }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": true }, { "key": "leave_type_id", "value": "", "description": "Filter to a specific leave type (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"user_id\": \"00000000-0000-0000-0000-000000000001\",\n \"leave_policy_id\": \"00000000-0000-0000-0000-000000000001\",\n \"leave_type_id\": \"00000000-0000-0000-0000-000000000001\",\n \"leave_period_id\": \"00000000-0000-0000-0000-000000000001\",\n \"start\": \"2025-06-01\",\n \"end\": \"2025-06-01\",\n \"day_duration\": \"string\",\n \"duration\": 1.5,\n \"status\": \"pending\",\n \"message\": \"string\",\n \"rejection_reason\": \"string\",\n \"status_changed_at\": \"2025-06-01T08:00:00Z\",\n \"created_at\": \"2025-06-01T08:00:00Z\",\n \"updated_at\": \"2025-06-01T08:00:00Z\"\n }\n ]\n}" }, { "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_applications", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_applications" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "status", "value": "pending", "description": "Filter by application status", "disabled": true }, { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": true }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": true }, { "key": "leave_type_id", "value": "", "description": "Filter to a specific leave type (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {\n \"start_date\": [\n \"start_date and end_date are required.\"\n ]\n }\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_applications", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_applications" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "status", "value": "pending", "description": "Filter by application status", "disabled": true }, { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": true }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": true }, { "key": "leave_type_id", "value": "", "description": "Filter to a specific leave type (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_applications", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_applications" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "status", "value": "pending", "description": "Filter by application status", "disabled": true }, { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": true }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": true }, { "key": "leave_type_id", "value": "", "description": "Filter to a specific leave type (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_applications", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_applications" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "status", "value": "pending", "description": "Filter by application status", "disabled": true }, { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": true }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": true }, { "key": "leave_type_id", "value": "", "description": "Filter to a specific leave type (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_applications", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_applications" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "status", "value": "pending", "description": "Filter by application status", "disabled": true }, { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": true }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": true }, { "key": "leave_type_id", "value": "", "description": "Filter to a specific leave type (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_applications", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_applications" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "status", "value": "pending", "description": "Filter by application status", "disabled": true }, { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": true }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": true }, { "key": "leave_type_id", "value": "", "description": "Filter to a specific leave type (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] }, { "name": "retrieveLeaveApplication", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_applications/:leave_application_id", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_applications", ":leave_application_id" ], "variable": [ { "key": "leave_application_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] }, "description": "Full leave application with nested `leave_type` and `leave_policy`.\n`leave_type` and `leave_policy` are null when no policy is attached to the application.\nReturns 404 if not found or soft-deleted.\n" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_applications/:leave_application_id", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_applications", ":leave_application_id" ], "variable": [ { "key": "leave_application_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"user_id\": \"00000000-0000-0000-0000-000000000001\",\n \"leave_period_id\": \"00000000-0000-0000-0000-000000000001\",\n \"start\": \"2025-06-01\",\n \"end\": \"2025-06-01\",\n \"day_duration\": \"string\",\n \"duration\": 1.5,\n \"status\": \"pending\",\n \"message\": \"string\",\n \"rejection_reason\": \"string\",\n \"status_changed_at\": \"2025-06-01T08:00:00Z\",\n \"created_at\": \"2025-06-01T08:00:00Z\",\n \"leave_type\": {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"name\": \"string\",\n \"color\": \"string\"\n },\n \"leave_policy\": {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"name\": \"string\",\n \"allowance\": 1.5\n }\n}" }, { "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_applications/:leave_application_id", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_applications", ":leave_application_id" ], "variable": [ { "key": "leave_application_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {\n \"start_date\": [\n \"start_date and end_date are required.\"\n ]\n }\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_applications/:leave_application_id", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_applications", ":leave_application_id" ], "variable": [ { "key": "leave_application_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_applications/:leave_application_id", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_applications", ":leave_application_id" ], "variable": [ { "key": "leave_application_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_applications/:leave_application_id", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_applications", ":leave_application_id" ], "variable": [ { "key": "leave_application_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_applications/:leave_application_id", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_applications", ":leave_application_id" ], "variable": [ { "key": "leave_application_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_applications/:leave_application_id", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_applications", ":leave_application_id" ], "variable": [ { "key": "leave_application_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] }, { "name": "listLeaveTypes", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_types", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_types" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] }, "description": "All active leave types for the organization, sorted alphabetically. Offset pagination \u2014 default limit 50, max 100." }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_types", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_types" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"color\": \"string\",\n \"created_at\": \"2025-06-01T08:00:00Z\"\n }\n ]\n}" }, { "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_types", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_types" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {\n \"start_date\": [\n \"start_date and end_date are required.\"\n ]\n }\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_types", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_types" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_types", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_types" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_types", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_types" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_types", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_types" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_types", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_types" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] }, { "name": "listLeavePolicies", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_policies", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_policies" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] }, "description": "All active leave policies for the organization, sorted alphabetically. Offset pagination \u2014 default limit 50, max 100." }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_policies", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_policies" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"leave_type_id\": \"00000000-0000-0000-0000-000000000001\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"allowance\": 1.5,\n \"allow_negative_balance\": true,\n \"require_approval\": true,\n \"carry_over\": true,\n \"max_carry_over\": 1.5,\n \"created_at\": \"2025-06-01T08:00:00Z\"\n }\n ]\n}" }, { "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_policies", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_policies" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {\n \"start_date\": [\n \"start_date and end_date are required.\"\n ]\n }\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_policies", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_policies" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_policies", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_policies" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_policies", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_policies" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_policies", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_policies" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_policies", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_policies" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] }, { "name": "listLeavePeriods", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_periods", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_periods" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] }, "description": "All leave periods for the organization, sorted by start date descending.\n`is_active` indicates the currently active period \u2014 it is NOT a soft-delete flag.\nAll periods are returned regardless of `is_active`.\nOffset pagination \u2014 default limit 50, max 100.\n" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_periods", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_periods" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"name\": \"string\",\n \"start_date\": \"2025-06-01\",\n \"end_date\": \"2025-06-01\",\n \"is_active\": true,\n \"created_at\": \"2025-06-01T08:00:00Z\"\n }\n ]\n}" }, { "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_periods", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_periods" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {\n \"start_date\": [\n \"start_date and end_date are required.\"\n ]\n }\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_periods", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_periods" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_periods", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_periods" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_periods", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_periods" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_periods", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_periods" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_periods", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_periods" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] }, { "name": "listLeaveBalances", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_balances", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_balances" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true } ] }, "description": "Active leave balances for the organization. Filter by `user_id` to scope to one member.\n`used_leave` is computed as `custom_allowance \u2212 remaining_leave`; null when `custom_allowance` is null.\nOffset pagination \u2014 default limit 50, max 100.\n" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_balances", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_balances" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"user_id\": \"00000000-0000-0000-0000-000000000001\",\n \"leave_policy_id\": \"00000000-0000-0000-0000-000000000001\",\n \"leave_period_id\": \"00000000-0000-0000-0000-000000000001\",\n \"custom_allowance\": 1.5,\n \"remaining_leave\": 1.5,\n \"used_leave\": 1.5,\n \"created_at\": \"2025-06-01T08:00:00Z\"\n }\n ]\n}" }, { "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_balances", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_balances" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {\n \"start_date\": [\n \"start_date and end_date are required.\"\n ]\n }\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_balances", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_balances" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_balances", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_balances" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_balances", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_balances" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_balances", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_balances" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_balances", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_balances" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] }, { "name": "listLeaveAssignments", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_assignments", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_assignments" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true } ] }, "description": "Active leave policy assignments for the organization. Filter by `user_id` to scope to one member.\nOffset pagination \u2014 default limit 50, max 100.\n" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_assignments", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_assignments" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"user_id\": \"00000000-0000-0000-0000-000000000001\",\n \"leave_policy_id\": \"00000000-0000-0000-0000-000000000001\",\n \"leave_period_id\": \"00000000-0000-0000-0000-000000000001\",\n \"custom_allowance\": 1.5,\n \"assigned_at\": \"2025-06-01T08:00:00Z\",\n \"created_at\": \"2025-06-01T08:00:00Z\"\n }\n ]\n}" }, { "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_assignments", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_assignments" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {\n \"start_date\": [\n \"start_date and end_date are required.\"\n ]\n }\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_assignments", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_assignments" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_assignments", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_assignments" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_assignments", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_assignments" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_assignments", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_assignments" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_assignments", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_assignments" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] }, { "name": "retrieveLeaveAssignment", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_assignments/:leave_assignment_id", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_assignments", ":leave_assignment_id" ], "variable": [ { "key": "leave_assignment_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] }, "description": "Full leave policy assignment with nested `leave_policy` and `leave_type`.\nReturns 404 if not found or inactive.\n" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_assignments/:leave_assignment_id", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_assignments", ":leave_assignment_id" ], "variable": [ { "key": "leave_assignment_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"user_id\": \"00000000-0000-0000-0000-000000000001\",\n \"leave_period_id\": \"00000000-0000-0000-0000-000000000001\",\n \"custom_allowance\": 1.5,\n \"assigned_at\": \"2025-06-01T08:00:00Z\",\n \"created_at\": \"2025-06-01T08:00:00Z\",\n \"leave_policy\": {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"name\": \"string\",\n \"allowance\": 1.5,\n \"description\": \"string\",\n \"allow_negative_balance\": true,\n \"require_approval\": true,\n \"carry_over\": true,\n \"max_carry_over\": 1.5\n },\n \"leave_type\": {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"name\": \"string\",\n \"color\": \"string\"\n }\n}" }, { "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_assignments/:leave_assignment_id", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_assignments", ":leave_assignment_id" ], "variable": [ { "key": "leave_assignment_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {\n \"start_date\": [\n \"start_date and end_date are required.\"\n ]\n }\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_assignments/:leave_assignment_id", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_assignments", ":leave_assignment_id" ], "variable": [ { "key": "leave_assignment_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_assignments/:leave_assignment_id", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_assignments", ":leave_assignment_id" ], "variable": [ { "key": "leave_assignment_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_assignments/:leave_assignment_id", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_assignments", ":leave_assignment_id" ], "variable": [ { "key": "leave_assignment_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_assignments/:leave_assignment_id", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_assignments", ":leave_assignment_id" ], "variable": [ { "key": "leave_assignment_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/leave_assignments/:leave_assignment_id", "host": [ "{{base_url}}" ], "path": [ "v1", "leave_assignments", ":leave_assignment_id" ], "variable": [ { "key": "leave_assignment_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] } ] }, { "name": "Organization", "item": [ { "name": "retrieveOrganization", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/organizations", "host": [ "{{base_url}}" ], "path": [ "v1", "organizations" ] }, "description": "Retrieve Organization" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/organizations", "host": [ "{{base_url}}" ], "path": [ "v1", "organizations" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"color\": \"string\",\n \"address\": \"string\",\n \"timezone\": \"string\",\n \"plan\": {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"normalized_name\": \"string\"\n },\n \"configuration\": {\n \"currency\": \"string\",\n \"screenshot_track\": true,\n \"screenshot_blur\": true,\n \"screenshot_frequency\": 1,\n \"application_track\": true,\n \"url_track\": true,\n \"keystroke_track\": true,\n \"mouse_track\": true,\n \"user_delete_screenshot\": true,\n \"receive_weekly_email\": true,\n \"ask_instant_screenshot_permission\": true,\n \"allow_user_add_manual_timesheet\": true,\n \"require_manual_timesheet_approval\": true,\n \"show_screenshot_notification\": true,\n \"instant_screenshot\": true,\n \"video_recording\": true,\n \"video_duration\": 1,\n \"date_format\": \"string\",\n \"start_day_of_week\": 1\n },\n \"idle_time_setting\": {\n \"idle_time\": 1,\n \"action\": \"string\"\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/organizations", "host": [ "{{base_url}}" ], "path": [ "v1", "organizations" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/organizations", "host": [ "{{base_url}}" ], "path": [ "v1", "organizations" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/organizations", "host": [ "{{base_url}}" ], "path": [ "v1", "organizations" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/organizations", "host": [ "{{base_url}}" ], "path": [ "v1", "organizations" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/organizations", "host": [ "{{base_url}}" ], "path": [ "v1", "organizations" ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] }, { "name": "listMembers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members", "host": [ "{{base_url}}" ], "path": [ "v1", "members" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] }, "description": "Active members only. Owner listed first, remaining sorted alphabetically.\n\nOffset pagination: default limit 50, max 100.\n" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members", "host": [ "{{base_url}}" ], "path": [ "v1", "members" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"user_id\": \"00000000-0000-0000-0000-000000000001\",\n \"email\": \"user@example.com\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"image\": null,\n \"timezone\": \"string\",\n \"color\": \"string\",\n \"updated_at\": \"2025-06-01T08:00:00Z\"\n }\n ]\n}" }, { "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members", "host": [ "{{base_url}}" ], "path": [ "v1", "members" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {\n \"start_date\": [\n \"start_date and end_date are required.\"\n ]\n }\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members", "host": [ "{{base_url}}" ], "path": [ "v1", "members" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members", "host": [ "{{base_url}}" ], "path": [ "v1", "members" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members", "host": [ "{{base_url}}" ], "path": [ "v1", "members" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members", "host": [ "{{base_url}}" ], "path": [ "v1", "members" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members", "host": [ "{{base_url}}" ], "path": [ "v1", "members" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] }, { "name": "listClients", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/clients", "host": [ "{{base_url}}" ], "path": [ "v1", "clients" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] }, "description": "All clients (active and inactive), sorted alphabetically. `is_active` is included\nin each item so callers can filter locally.\n\nOffset pagination: default limit 50, max 100.\n" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/clients", "host": [ "{{base_url}}" ], "path": [ "v1", "clients" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"name\": \"string\",\n \"color\": \"string\",\n \"email\": \"string\",\n \"office_location\": \"string\",\n \"phone_number\": \"string\",\n \"created_on\": \"2025-06-01\",\n \"updated_at\": \"2025-06-01T08:00:00Z\"\n }\n ]\n}" }, { "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/clients", "host": [ "{{base_url}}" ], "path": [ "v1", "clients" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {\n \"start_date\": [\n \"start_date and end_date are required.\"\n ]\n }\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/clients", "host": [ "{{base_url}}" ], "path": [ "v1", "clients" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/clients", "host": [ "{{base_url}}" ], "path": [ "v1", "clients" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/clients", "host": [ "{{base_url}}" ], "path": [ "v1", "clients" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/clients", "host": [ "{{base_url}}" ], "path": [ "v1", "clients" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/clients", "host": [ "{{base_url}}" ], "path": [ "v1", "clients" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] }, { "name": "retrieveClient", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/clients/:client_id", "host": [ "{{base_url}}" ], "path": [ "v1", "clients", ":client_id" ], "variable": [ { "key": "client_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] }, "description": "`email` is null when stored value is the internal placeholder.\n`office_location` and `phone_number` are null when empty.\nInactive clients resolve normally (404 means the client does not exist).\n" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/clients/:client_id", "host": [ "{{base_url}}" ], "path": [ "v1", "clients", ":client_id" ], "variable": [ { "key": "client_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"name\": \"string\",\n \"color\": \"string\",\n \"email\": \"string\",\n \"is_active\": true,\n \"office_location\": \"string\",\n \"phone_number\": \"string\",\n \"created_on\": \"2025-06-01\",\n \"settings\": {\n \"can_view_screenshots\": true,\n \"can_view_screen_records\": true,\n \"can_view_apps_and_urls\": true,\n \"can_view_attendance\": true,\n \"can_view_dashboard\": true,\n \"can_access_reports\": true,\n \"can_project_invoices_review\": true,\n \"can_view_timesheet_approval\": true,\n \"can_view_timesheet\": true,\n \"can_view_tasks\": true\n }\n}" }, { "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/clients/:client_id", "host": [ "{{base_url}}" ], "path": [ "v1", "clients", ":client_id" ], "variable": [ { "key": "client_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {\n \"start_date\": [\n \"start_date and end_date are required.\"\n ]\n }\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/clients/:client_id", "host": [ "{{base_url}}" ], "path": [ "v1", "clients", ":client_id" ], "variable": [ { "key": "client_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/clients/:client_id", "host": [ "{{base_url}}" ], "path": [ "v1", "clients", ":client_id" ], "variable": [ { "key": "client_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/clients/:client_id", "host": [ "{{base_url}}" ], "path": [ "v1", "clients", ":client_id" ], "variable": [ { "key": "client_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/clients/:client_id", "host": [ "{{base_url}}" ], "path": [ "v1", "clients", ":client_id" ], "variable": [ { "key": "client_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/clients/:client_id", "host": [ "{{base_url}}" ], "path": [ "v1", "clients", ":client_id" ], "variable": [ { "key": "client_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] }, { "name": "listTeams", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/teams", "host": [ "{{base_url}}" ], "path": [ "v1", "teams" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] }, "description": "Active teams sorted alphabetically. Offset pagination \u2014 default limit 50, max 100." }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/teams", "host": [ "{{base_url}}" ], "path": [ "v1", "teams" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"name\": \"string\",\n \"color\": \"string\"\n }\n ]\n}" }, { "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/teams", "host": [ "{{base_url}}" ], "path": [ "v1", "teams" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {\n \"start_date\": [\n \"start_date and end_date are required.\"\n ]\n }\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/teams", "host": [ "{{base_url}}" ], "path": [ "v1", "teams" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/teams", "host": [ "{{base_url}}" ], "path": [ "v1", "teams" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/teams", "host": [ "{{base_url}}" ], "path": [ "v1", "teams" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/teams", "host": [ "{{base_url}}" ], "path": [ "v1", "teams" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/teams", "host": [ "{{base_url}}" ], "path": [ "v1", "teams" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] }, { "name": "listTeamMembers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/teams/:team_id/members", "host": [ "{{base_url}}" ], "path": [ "v1", "teams", ":team_id", "members" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ], "variable": [ { "key": "team_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] }, "description": "Active members of the team who also hold an active organization membership.\nOffset pagination: default limit 50, max 100.\n" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/teams/:team_id/members", "host": [ "{{base_url}}" ], "path": [ "v1", "teams", ":team_id", "members" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ], "variable": [ { "key": "team_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"user_id\": \"00000000-0000-0000-0000-000000000001\",\n \"can_manage\": true\n }\n ]\n}" }, { "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/teams/:team_id/members", "host": [ "{{base_url}}" ], "path": [ "v1", "teams", ":team_id", "members" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ], "variable": [ { "key": "team_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {\n \"start_date\": [\n \"start_date and end_date are required.\"\n ]\n }\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/teams/:team_id/members", "host": [ "{{base_url}}" ], "path": [ "v1", "teams", ":team_id", "members" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ], "variable": [ { "key": "team_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/teams/:team_id/members", "host": [ "{{base_url}}" ], "path": [ "v1", "teams", ":team_id", "members" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ], "variable": [ { "key": "team_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/teams/:team_id/members", "host": [ "{{base_url}}" ], "path": [ "v1", "teams", ":team_id", "members" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ], "variable": [ { "key": "team_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/teams/:team_id/members", "host": [ "{{base_url}}" ], "path": [ "v1", "teams", ":team_id", "members" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ], "variable": [ { "key": "team_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/teams/:team_id/members", "host": [ "{{base_url}}" ], "path": [ "v1", "teams", ":team_id", "members" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ], "variable": [ { "key": "team_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] } ] }, { "name": "Payroll", "item": [ { "name": "listInvoices", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/invoices", "host": [ "{{base_url}}" ], "path": [ "v1", "invoices" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "status", "value": "draft", "description": "Filter by invoice status", "disabled": true }, { "key": "client_id", "value": "", "description": "Filter by client (zero UUID treated as absent)", "disabled": true }, { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": true }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] }, "description": "All invoices including soft-deleted ones. Filter by `status`, `client_id`,\nor `start_date`/`end_date` (filters on `issued_date`).\nOffset pagination: default limit 50, max 100.\n\nValid status values: `draft`, `sent`, `paid`, `partial`.\n" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/invoices", "host": [ "{{base_url}}" ], "path": [ "v1", "invoices" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "status", "value": "draft", "description": "Filter by invoice status", "disabled": true }, { "key": "client_id", "value": "", "description": "Filter by client (zero UUID treated as absent)", "disabled": true }, { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": true }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"status\": \"draft\",\n \"invoice_number\": \"string\",\n \"issued_date\": \"2025-06-01\",\n \"due_date\": \"2025-06-01\",\n \"subject\": \"string\",\n \"po_number\": \"string\",\n \"notes\": \"string\",\n \"currency\": \"string\",\n \"updated_at\": \"2025-06-01T08:00:00Z\"\n }\n ]\n}" }, { "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/invoices", "host": [ "{{base_url}}" ], "path": [ "v1", "invoices" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "status", "value": "draft", "description": "Filter by invoice status", "disabled": true }, { "key": "client_id", "value": "", "description": "Filter by client (zero UUID treated as absent)", "disabled": true }, { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": true }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {\n \"start_date\": [\n \"start_date and end_date are required.\"\n ]\n }\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/invoices", "host": [ "{{base_url}}" ], "path": [ "v1", "invoices" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "status", "value": "draft", "description": "Filter by invoice status", "disabled": true }, { "key": "client_id", "value": "", "description": "Filter by client (zero UUID treated as absent)", "disabled": true }, { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": true }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/invoices", "host": [ "{{base_url}}" ], "path": [ "v1", "invoices" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "status", "value": "draft", "description": "Filter by invoice status", "disabled": true }, { "key": "client_id", "value": "", "description": "Filter by client (zero UUID treated as absent)", "disabled": true }, { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": true }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/invoices", "host": [ "{{base_url}}" ], "path": [ "v1", "invoices" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "status", "value": "draft", "description": "Filter by invoice status", "disabled": true }, { "key": "client_id", "value": "", "description": "Filter by client (zero UUID treated as absent)", "disabled": true }, { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": true }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/invoices", "host": [ "{{base_url}}" ], "path": [ "v1", "invoices" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "status", "value": "draft", "description": "Filter by invoice status", "disabled": true }, { "key": "client_id", "value": "", "description": "Filter by client (zero UUID treated as absent)", "disabled": true }, { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": true }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/invoices", "host": [ "{{base_url}}" ], "path": [ "v1", "invoices" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "status", "value": "draft", "description": "Filter by invoice status", "disabled": true }, { "key": "client_id", "value": "", "description": "Filter by client (zero UUID treated as absent)", "disabled": true }, { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": true }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] }, { "name": "retrieveInvoice", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/invoices/:invoice_id", "host": [ "{{base_url}}" ], "path": [ "v1", "invoices", ":invoice_id" ], "variable": [ { "key": "invoice_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] }, "description": "Full invoice with line items, tax, discount, client, and payment records. Amounts are computed fields." }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/invoices/:invoice_id", "host": [ "{{base_url}}" ], "path": [ "v1", "invoices", ":invoice_id" ], "variable": [ { "key": "invoice_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"status\": \"draft\",\n \"invoice_number\": \"string\",\n \"issued_date\": \"2025-06-01\",\n \"due_date\": \"2025-06-01\",\n \"subject\": \"string\",\n \"po_number\": \"string\",\n \"notes\": \"string\",\n \"currency\": \"string\",\n \"updated_at\": \"2025-06-01T08:00:00Z\",\n \"client_name\": \"string\",\n \"created_at\": \"2025-06-01T08:00:00Z\",\n \"paid_amount\": 1.5,\n \"total_amount\": 1.5,\n \"discounted_amount\": 1.5,\n \"total_tax1\": 1.5,\n \"total_tax2\": 1.5,\n \"client\": {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"name\": \"string\",\n \"color\": \"string\",\n \"email\": \"string\",\n \"office_location\": \"string\",\n \"phone_number\": \"string\",\n \"created_on\": \"2025-06-01\"\n },\n \"tax1\": {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"type\": \"string\",\n \"percent_amount\": 1.5,\n \"fixed_amount\": 1.5,\n \"name\": \"string\"\n },\n \"tax2\": {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"type\": \"string\",\n \"percent_amount\": 1.5,\n \"fixed_amount\": 1.5,\n \"name\": \"string\"\n },\n \"discount\": {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"invoice\": \"00000000-0000-0000-0000-000000000001\",\n \"type\": \"string\",\n \"percent_amount\": 1.5,\n \"fixed_amount\": 1.5,\n \"created_at\": \"2025-06-01T08:00:00Z\",\n \"updated_at\": \"2025-06-01T08:00:00Z\"\n },\n \"items\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"invoice\": \"00000000-0000-0000-0000-000000000001\",\n \"type\": \"string\",\n \"description\": \"string\",\n \"quantity\": 1.5,\n \"unit_price\": 1.5,\n \"tax1\": true,\n \"tax2\": true,\n \"amount\": 1.5,\n \"taxed_amount\": 1.5,\n \"linked_project\": {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"name\": \"string\",\n \"color\": \"string\",\n \"is_active\": true\n }\n }\n ],\n \"payments\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"invoice\": \"00000000-0000-0000-0000-000000000001\",\n \"amount\": 1.5,\n \"date\": \"2025-06-01\",\n \"notes\": \"string\",\n \"recorded_by\": {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"name\": \"string\"\n }\n }\n ]\n}" }, { "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/invoices/:invoice_id", "host": [ "{{base_url}}" ], "path": [ "v1", "invoices", ":invoice_id" ], "variable": [ { "key": "invoice_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {\n \"start_date\": [\n \"start_date and end_date are required.\"\n ]\n }\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/invoices/:invoice_id", "host": [ "{{base_url}}" ], "path": [ "v1", "invoices", ":invoice_id" ], "variable": [ { "key": "invoice_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/invoices/:invoice_id", "host": [ "{{base_url}}" ], "path": [ "v1", "invoices", ":invoice_id" ], "variable": [ { "key": "invoice_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/invoices/:invoice_id", "host": [ "{{base_url}}" ], "path": [ "v1", "invoices", ":invoice_id" ], "variable": [ { "key": "invoice_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/invoices/:invoice_id", "host": [ "{{base_url}}" ], "path": [ "v1", "invoices", ":invoice_id" ], "variable": [ { "key": "invoice_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/invoices/:invoice_id", "host": [ "{{base_url}}" ], "path": [ "v1", "invoices", ":invoice_id" ], "variable": [ { "key": "invoice_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] }, { "name": "listMemberHourlyPaymentLog", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members/:user_id/hourly_payment_logs", "host": [ "{{base_url}}" ], "path": [ "v1", "members", ":user_id", "hourly_payment_logs" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": true }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": true } ], "variable": [ { "key": "user_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] }, "description": "Hourly payment records for the member. Filter by `paid_for_date` using\n`start_date` / `end_date`. Offset pagination: default limit 50, max 100.\n\nMoney values are in major currency units (e.g. dollars, not cents).\n`working_duration` is a formatted string e.g. \"8h 30m\".\n" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members/:user_id/hourly_payment_logs", "host": [ "{{base_url}}" ], "path": [ "v1", "members", ":user_id", "hourly_payment_logs" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": true }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": true } ], "variable": [ { "key": "user_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"paid_by_id\": \"00000000-0000-0000-0000-000000000001\",\n \"paid_by_email\": \"string\",\n \"paid_by_name\": \"string\",\n \"paid_at\": \"2025-06-01\",\n \"paid_for_date\": \"2025-06-01\",\n \"working_duration\": \"string\",\n \"pay_rate\": 1.5,\n \"bill_rate\": 1.5,\n \"total_pay\": 1.5,\n \"total_bill\": 1.5,\n \"currency\": \"string\",\n \"nature_of_payment\": \"string\"\n }\n ]\n}" }, { "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members/:user_id/hourly_payment_logs", "host": [ "{{base_url}}" ], "path": [ "v1", "members", ":user_id", "hourly_payment_logs" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": true }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": true } ], "variable": [ { "key": "user_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {\n \"start_date\": [\n \"start_date and end_date are required.\"\n ]\n }\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members/:user_id/hourly_payment_logs", "host": [ "{{base_url}}" ], "path": [ "v1", "members", ":user_id", "hourly_payment_logs" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": true }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": true } ], "variable": [ { "key": "user_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members/:user_id/hourly_payment_logs", "host": [ "{{base_url}}" ], "path": [ "v1", "members", ":user_id", "hourly_payment_logs" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": true }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": true } ], "variable": [ { "key": "user_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members/:user_id/hourly_payment_logs", "host": [ "{{base_url}}" ], "path": [ "v1", "members", ":user_id", "hourly_payment_logs" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": true }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": true } ], "variable": [ { "key": "user_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members/:user_id/hourly_payment_logs", "host": [ "{{base_url}}" ], "path": [ "v1", "members", ":user_id", "hourly_payment_logs" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": true }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": true } ], "variable": [ { "key": "user_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members/:user_id/hourly_payment_logs", "host": [ "{{base_url}}" ], "path": [ "v1", "members", ":user_id", "hourly_payment_logs" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": true }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": true } ], "variable": [ { "key": "user_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] }, { "name": "listMemberPaymentSettings", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members/:user_id/payment_settings", "host": [ "{{base_url}}" ], "path": [ "v1", "members", ":user_id", "payment_settings" ], "variable": [ { "key": "user_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] }, "description": "All historical pay/bill rate periods, sorted by start DESC.\nReturns a **bare array** (not a paginated envelope).\n`end` is null for the current active period.\n" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members/:user_id/payment_settings", "host": [ "{{base_url}}" ], "path": [ "v1", "members", ":user_id", "payment_settings" ], "variable": [ { "key": "user_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"pay_rate\": 1.5,\n \"bill_rate\": 1.5,\n \"start\": \"2025-06-01\",\n \"end\": \"2025-06-01\",\n \"currency\": \"string\"\n }\n]" }, { "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members/:user_id/payment_settings", "host": [ "{{base_url}}" ], "path": [ "v1", "members", ":user_id", "payment_settings" ], "variable": [ { "key": "user_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {\n \"start_date\": [\n \"start_date and end_date are required.\"\n ]\n }\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members/:user_id/payment_settings", "host": [ "{{base_url}}" ], "path": [ "v1", "members", ":user_id", "payment_settings" ], "variable": [ { "key": "user_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members/:user_id/payment_settings", "host": [ "{{base_url}}" ], "path": [ "v1", "members", ":user_id", "payment_settings" ], "variable": [ { "key": "user_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members/:user_id/payment_settings", "host": [ "{{base_url}}" ], "path": [ "v1", "members", ":user_id", "payment_settings" ], "variable": [ { "key": "user_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members/:user_id/payment_settings", "host": [ "{{base_url}}" ], "path": [ "v1", "members", ":user_id", "payment_settings" ], "variable": [ { "key": "user_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members/:user_id/payment_settings", "host": [ "{{base_url}}" ], "path": [ "v1", "members", ":user_id", "payment_settings" ], "variable": [ { "key": "user_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] }, { "name": "listMemberOneTimePaymentLog", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members/:user_id/one_time_payment_logs", "host": [ "{{base_url}}" ], "path": [ "v1", "members", ":user_id", "one_time_payment_logs" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": true }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": true } ], "variable": [ { "key": "user_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] }, "description": "One-time (bonus/expense) payment records. Filter by `paid_at` using\n`start_date` / `end_date`. Offset pagination: default limit 50, max 100.\n" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members/:user_id/one_time_payment_logs", "host": [ "{{base_url}}" ], "path": [ "v1", "members", ":user_id", "one_time_payment_logs" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": true }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": true } ], "variable": [ { "key": "user_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"paid_by_id\": \"00000000-0000-0000-0000-000000000001\",\n \"paid_by_email\": \"string\",\n \"paid_by_name\": \"string\",\n \"paid_at\": \"2025-06-01\",\n \"paid_amt\": 1.5,\n \"project_name\": \"string\",\n \"project_id\": \"00000000-0000-0000-0000-000000000001\",\n \"currency\": \"string\",\n \"note\": \"string\"\n }\n ]\n}" }, { "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members/:user_id/one_time_payment_logs", "host": [ "{{base_url}}" ], "path": [ "v1", "members", ":user_id", "one_time_payment_logs" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": true }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": true } ], "variable": [ { "key": "user_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {\n \"start_date\": [\n \"start_date and end_date are required.\"\n ]\n }\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members/:user_id/one_time_payment_logs", "host": [ "{{base_url}}" ], "path": [ "v1", "members", ":user_id", "one_time_payment_logs" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": true }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": true } ], "variable": [ { "key": "user_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members/:user_id/one_time_payment_logs", "host": [ "{{base_url}}" ], "path": [ "v1", "members", ":user_id", "one_time_payment_logs" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": true }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": true } ], "variable": [ { "key": "user_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members/:user_id/one_time_payment_logs", "host": [ "{{base_url}}" ], "path": [ "v1", "members", ":user_id", "one_time_payment_logs" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": true }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": true } ], "variable": [ { "key": "user_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members/:user_id/one_time_payment_logs", "host": [ "{{base_url}}" ], "path": [ "v1", "members", ":user_id", "one_time_payment_logs" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": true }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": true } ], "variable": [ { "key": "user_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members/:user_id/one_time_payment_logs", "host": [ "{{base_url}}" ], "path": [ "v1", "members", ":user_id", "one_time_payment_logs" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": true }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": true } ], "variable": [ { "key": "user_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] }, { "name": "listMemberPayables", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members/:user_id/payables", "host": [ "{{base_url}}" ], "path": [ "v1", "members", ":user_id", "payables" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ], "variable": [ { "key": "user_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] }, "description": "Returns net unpaid duration and computed pay/bill amounts per calendar day\nfor a member, within the required date range.\n\nDay boundaries are split in the **organization's local timezone**. Timesheets\nspanning midnight are attributed to the correct calendar day. Already-paid\ndurations (from `timesheetpaymentlogs`) are subtracted before totals are\ncomputed. Days with zero net payable balance are excluded from results and\nfrom `count`.\n\nThe payment rate for each day is the latest `employeepaymentsetting` record\nwhose `created_at` is on or before that day (oldest setting used as fallback).\nDays where the applicable `pay_rate` is `0` are excluded.\n\nMoney values are in major currency units (e.g. dollars, not cents).\n`total_duration` is a formatted string e.g. \"8h 30m\".\n\nOffset pagination: default limit 50, max 100.\n" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members/:user_id/payables", "host": [ "{{base_url}}" ], "path": [ "v1", "members", ":user_id", "payables" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ], "variable": [ { "key": "user_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"currency\": \"string\",\n \"date\": \"2025-06-01\",\n \"total_duration\": \"string\",\n \"pay_rate\": 1.5,\n \"bill_rate\": 1.5,\n \"total_pay\": 1.5,\n \"total_bill\": 1.5\n }\n ]\n}" }, { "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members/:user_id/payables", "host": [ "{{base_url}}" ], "path": [ "v1", "members", ":user_id", "payables" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ], "variable": [ { "key": "user_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {\n \"start_date\": [\n \"start_date and end_date are required.\"\n ]\n }\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members/:user_id/payables", "host": [ "{{base_url}}" ], "path": [ "v1", "members", ":user_id", "payables" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ], "variable": [ { "key": "user_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members/:user_id/payables", "host": [ "{{base_url}}" ], "path": [ "v1", "members", ":user_id", "payables" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ], "variable": [ { "key": "user_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members/:user_id/payables", "host": [ "{{base_url}}" ], "path": [ "v1", "members", ":user_id", "payables" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ], "variable": [ { "key": "user_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members/:user_id/payables", "host": [ "{{base_url}}" ], "path": [ "v1", "members", ":user_id", "payables" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ], "variable": [ { "key": "user_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members/:user_id/payables", "host": [ "{{base_url}}" ], "path": [ "v1", "members", ":user_id", "payables" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ], "variable": [ { "key": "user_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] }, { "name": "getPayablesSummary", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/payables_summary", "host": [ "{{base_url}}" ], "path": [ "v1", "payables_summary" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false } ] }, "description": "Returns the organization-wide net-unpaid total for a required date range,\naggregated across every currently active member (a deactivated or removed\nmember's historical payables are excluded, matching what\n`GET /v1/members/{user_id}/payables/` would 404 on if asked about that\nmember directly). Uses the identical per-day rate lookup and day-boundary\ncomputation as that endpoint for each member, summed into one total - not\na separate calculation.\n\nUnlike every other Payroll endpoint, this is organization-wide: no\n`user_id` path parameter, and no per-member authorization check applies -\nany key with access to this endpoint can see the aggregate total\nregardless of which specific members it would otherwise need a\n`user_id` to query individually.\n\nMoney values are in major currency units (e.g. dollars, not cents).\nNot paginated - returns a single aggregate object. The underlying query\naggregates every day in the requested range, across every member, before\nsumming - keep the range narrow (e.g. a pay period, not multiple years)\nfor a large organization.\n" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/payables_summary", "host": [ "{{base_url}}" ], "path": [ "v1", "payables_summary" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"total_pay\": 1.5,\n \"total_bill\": 1.5,\n \"currency\": \"string\",\n \"start_date\": \"2025-06-01\",\n \"end_date\": \"2025-06-01\",\n \"member_count\": 1\n}" }, { "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/payables_summary", "host": [ "{{base_url}}" ], "path": [ "v1", "payables_summary" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {\n \"start_date\": [\n \"start_date and end_date are required.\"\n ]\n }\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/payables_summary", "host": [ "{{base_url}}" ], "path": [ "v1", "payables_summary" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/payables_summary", "host": [ "{{base_url}}" ], "path": [ "v1", "payables_summary" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/payables_summary", "host": [ "{{base_url}}" ], "path": [ "v1", "payables_summary" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/payables_summary", "host": [ "{{base_url}}" ], "path": [ "v1", "payables_summary" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/payables_summary", "host": [ "{{base_url}}" ], "path": [ "v1", "payables_summary" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] } ] }, { "name": "Projects", "item": [ { "name": "listProjects", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/projects", "host": [ "{{base_url}}" ], "path": [ "v1", "projects" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "created_by", "value": "", "description": "Filter to projects created by this user (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] }, "description": "All projects (active and inactive). `is_active` is present on each item.\nOffset pagination: default limit 50, max 100.\n" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/projects", "host": [ "{{base_url}}" ], "path": [ "v1", "projects" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "created_by", "value": "", "description": "Filter to projects created by this user (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"name\": \"string\",\n \"color\": \"string\",\n \"description\": \"string\",\n \"start_date\": \"2025-06-01\",\n \"deadline\": \"2025-06-01\",\n \"code\": \"string\",\n \"default\": true,\n \"status\": \"string\",\n \"is_active\": true,\n \"updated_at\": \"2025-06-01T08:00:00Z\"\n }\n ]\n}" }, { "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/projects", "host": [ "{{base_url}}" ], "path": [ "v1", "projects" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "created_by", "value": "", "description": "Filter to projects created by this user (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {\n \"start_date\": [\n \"start_date and end_date are required.\"\n ]\n }\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/projects", "host": [ "{{base_url}}" ], "path": [ "v1", "projects" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "created_by", "value": "", "description": "Filter to projects created by this user (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/projects", "host": [ "{{base_url}}" ], "path": [ "v1", "projects" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "created_by", "value": "", "description": "Filter to projects created by this user (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/projects", "host": [ "{{base_url}}" ], "path": [ "v1", "projects" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "created_by", "value": "", "description": "Filter to projects created by this user (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/projects", "host": [ "{{base_url}}" ], "path": [ "v1", "projects" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "created_by", "value": "", "description": "Filter to projects created by this user (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/projects", "host": [ "{{base_url}}" ], "path": [ "v1", "projects" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "created_by", "value": "", "description": "Filter to projects created by this user (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] }, { "name": "retrieveProject", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/projects/:project_id", "host": [ "{{base_url}}" ], "path": [ "v1", "projects", ":project_id" ], "variable": [ { "key": "project_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] }, "description": "Retrieve Project" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/projects/:project_id", "host": [ "{{base_url}}" ], "path": [ "v1", "projects", ":project_id" ], "variable": [ { "key": "project_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"name\": \"string\",\n \"color\": \"string\",\n \"description\": \"string\",\n \"start_date\": \"2025-06-01\",\n \"deadline\": \"2025-06-01\",\n \"code\": \"string\",\n \"default\": true,\n \"status\": \"string\",\n \"is_active\": true,\n \"updated_at\": \"2025-06-01T08:00:00Z\",\n \"created_at\": \"2025-06-01T08:00:00Z\",\n \"client\": {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"name\": \"string\",\n \"color\": \"string\",\n \"email\": \"string\"\n },\n \"budget\": {\n \"budget_type\": \"string\",\n \"budget_amount\": 1.5,\n \"budget_hours\": 1.5,\n \"budget_hourly_based_on\": \"string\"\n },\n \"created_by\": {\n \"user_id\": \"00000000-0000-0000-0000-000000000001\",\n \"email\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"image\": null,\n \"timezone\": \"string\",\n \"color\": \"string\"\n },\n \"updated_by\": {\n \"user_id\": \"00000000-0000-0000-0000-000000000001\",\n \"email\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"image\": null,\n \"timezone\": \"string\",\n \"color\": \"string\"\n }\n}" }, { "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/projects/:project_id", "host": [ "{{base_url}}" ], "path": [ "v1", "projects", ":project_id" ], "variable": [ { "key": "project_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {\n \"start_date\": [\n \"start_date and end_date are required.\"\n ]\n }\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/projects/:project_id", "host": [ "{{base_url}}" ], "path": [ "v1", "projects", ":project_id" ], "variable": [ { "key": "project_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/projects/:project_id", "host": [ "{{base_url}}" ], "path": [ "v1", "projects", ":project_id" ], "variable": [ { "key": "project_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/projects/:project_id", "host": [ "{{base_url}}" ], "path": [ "v1", "projects", ":project_id" ], "variable": [ { "key": "project_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/projects/:project_id", "host": [ "{{base_url}}" ], "path": [ "v1", "projects", ":project_id" ], "variable": [ { "key": "project_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/projects/:project_id", "host": [ "{{base_url}}" ], "path": [ "v1", "projects", ":project_id" ], "variable": [ { "key": "project_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] }, { "name": "listProjectMembers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/projects/:project_id/members", "host": [ "{{base_url}}" ], "path": [ "v1", "projects", ":project_id", "members" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ], "variable": [ { "key": "project_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] }, "description": "Members assigned to a project with per-project permissions. Offset pagination \u2014 default limit 50, max 100." }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/projects/:project_id/members", "host": [ "{{base_url}}" ], "path": [ "v1", "projects", ":project_id", "members" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ], "variable": [ { "key": "project_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"user_id\": \"00000000-0000-0000-0000-000000000001\",\n \"email\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"image\": null,\n \"timezone\": \"string\",\n \"color\": \"string\",\n \"can_manage\": true,\n \"can_view_report\": true\n }\n ]\n}" }, { "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/projects/:project_id/members", "host": [ "{{base_url}}" ], "path": [ "v1", "projects", ":project_id", "members" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ], "variable": [ { "key": "project_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {\n \"start_date\": [\n \"start_date and end_date are required.\"\n ]\n }\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/projects/:project_id/members", "host": [ "{{base_url}}" ], "path": [ "v1", "projects", ":project_id", "members" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ], "variable": [ { "key": "project_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/projects/:project_id/members", "host": [ "{{base_url}}" ], "path": [ "v1", "projects", ":project_id", "members" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ], "variable": [ { "key": "project_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/projects/:project_id/members", "host": [ "{{base_url}}" ], "path": [ "v1", "projects", ":project_id", "members" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ], "variable": [ { "key": "project_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/projects/:project_id/members", "host": [ "{{base_url}}" ], "path": [ "v1", "projects", ":project_id", "members" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ], "variable": [ { "key": "project_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/projects/:project_id/members", "host": [ "{{base_url}}" ], "path": [ "v1", "projects", ":project_id", "members" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ], "variable": [ { "key": "project_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] }, { "name": "listProjectTasks", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/projects/:project_id/tasks", "host": [ "{{base_url}}" ], "path": [ "v1", "projects", ":project_id", "tasks" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ], "variable": [ { "key": "project_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] }, "description": "Tasks for a project. `completed_at` is null unless status is 'complete'. Offset pagination \u2014 default limit 50, max 100. Pass `updated_since` to poll for task changes within this project." }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/projects/:project_id/tasks", "host": [ "{{base_url}}" ], "path": [ "v1", "projects", ":project_id", "tasks" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ], "variable": [ { "key": "project_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"name\": \"string\",\n \"status\": \"string\",\n \"completed_at\": \"2025-06-01T08:00:00Z\",\n \"color\": \"string\",\n \"updated_at\": \"2025-06-01T08:00:00Z\"\n }\n ]\n}" }, { "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/projects/:project_id/tasks", "host": [ "{{base_url}}" ], "path": [ "v1", "projects", ":project_id", "tasks" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ], "variable": [ { "key": "project_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {\n \"start_date\": [\n \"start_date and end_date are required.\"\n ]\n }\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/projects/:project_id/tasks", "host": [ "{{base_url}}" ], "path": [ "v1", "projects", ":project_id", "tasks" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ], "variable": [ { "key": "project_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/projects/:project_id/tasks", "host": [ "{{base_url}}" ], "path": [ "v1", "projects", ":project_id", "tasks" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ], "variable": [ { "key": "project_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/projects/:project_id/tasks", "host": [ "{{base_url}}" ], "path": [ "v1", "projects", ":project_id", "tasks" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ], "variable": [ { "key": "project_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/projects/:project_id/tasks", "host": [ "{{base_url}}" ], "path": [ "v1", "projects", ":project_id", "tasks" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ], "variable": [ { "key": "project_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/projects/:project_id/tasks", "host": [ "{{base_url}}" ], "path": [ "v1", "projects", ":project_id", "tasks" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ], "variable": [ { "key": "project_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] }, { "name": "retrieveProjectBillable", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/projects/:project_id/billable", "host": [ "{{base_url}}" ], "path": [ "v1", "projects", ":project_id", "billable" ], "variable": [ { "key": "project_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] }, "description": "`project_hourly` is populated when `hourly_rate_based_on = 'project_hourly'`.\n`person_hourlies` is populated when `hourly_rate_based_on = 'person_hourly'`.\nAll fields are null when no billable configuration exists.\n" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/projects/:project_id/billable", "host": [ "{{base_url}}" ], "path": [ "v1", "projects", ":project_id", "billable" ], "variable": [ { "key": "project_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"billable_type\": \"string\",\n \"billable_amount\": 1.5,\n \"hourly_rate_based_on\": \"string\",\n \"project_hourly\": {\n \"rate\": 1.5\n },\n \"person_hourlies\": [\n {\n \"rate\": 1.5,\n \"user_id\": \"00000000-0000-0000-0000-000000000001\",\n \"email\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"image\": null,\n \"thumbnail\": null,\n \"color\": \"string\"\n }\n ]\n}" }, { "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/projects/:project_id/billable", "host": [ "{{base_url}}" ], "path": [ "v1", "projects", ":project_id", "billable" ], "variable": [ { "key": "project_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {\n \"start_date\": [\n \"start_date and end_date are required.\"\n ]\n }\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/projects/:project_id/billable", "host": [ "{{base_url}}" ], "path": [ "v1", "projects", ":project_id", "billable" ], "variable": [ { "key": "project_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/projects/:project_id/billable", "host": [ "{{base_url}}" ], "path": [ "v1", "projects", ":project_id", "billable" ], "variable": [ { "key": "project_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/projects/:project_id/billable", "host": [ "{{base_url}}" ], "path": [ "v1", "projects", ":project_id", "billable" ], "variable": [ { "key": "project_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/projects/:project_id/billable", "host": [ "{{base_url}}" ], "path": [ "v1", "projects", ":project_id", "billable" ], "variable": [ { "key": "project_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/projects/:project_id/billable", "host": [ "{{base_url}}" ], "path": [ "v1", "projects", ":project_id", "billable" ], "variable": [ { "key": "project_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] }, { "name": "listClientProjects", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/clients/:client_id/projects", "host": [ "{{base_url}}" ], "path": [ "v1", "clients", ":client_id", "projects" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "created_by", "value": "", "description": "Filter to projects created by this user (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ], "variable": [ { "key": "client_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] }, "description": "Projects belonging to a client. Returns 404 if the client is inactive or does not\nexist in this organization (unlike GET /v1/clients/{id}/ which resolves inactive clients).\nOffset pagination: default limit 50, max 100. Pass `updated_since` to poll for project\nchanges for this client.\n" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/clients/:client_id/projects", "host": [ "{{base_url}}" ], "path": [ "v1", "clients", ":client_id", "projects" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "created_by", "value": "", "description": "Filter to projects created by this user (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ], "variable": [ { "key": "client_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"name\": \"string\",\n \"color\": \"string\",\n \"description\": \"string\",\n \"start_date\": \"2025-06-01\",\n \"deadline\": \"2025-06-01\",\n \"code\": \"string\",\n \"default\": true,\n \"status\": \"string\",\n \"is_active\": true,\n \"updated_at\": \"2025-06-01T08:00:00Z\"\n }\n ]\n}" }, { "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/clients/:client_id/projects", "host": [ "{{base_url}}" ], "path": [ "v1", "clients", ":client_id", "projects" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "created_by", "value": "", "description": "Filter to projects created by this user (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ], "variable": [ { "key": "client_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {\n \"start_date\": [\n \"start_date and end_date are required.\"\n ]\n }\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/clients/:client_id/projects", "host": [ "{{base_url}}" ], "path": [ "v1", "clients", ":client_id", "projects" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "created_by", "value": "", "description": "Filter to projects created by this user (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ], "variable": [ { "key": "client_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/clients/:client_id/projects", "host": [ "{{base_url}}" ], "path": [ "v1", "clients", ":client_id", "projects" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "created_by", "value": "", "description": "Filter to projects created by this user (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ], "variable": [ { "key": "client_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/clients/:client_id/projects", "host": [ "{{base_url}}" ], "path": [ "v1", "clients", ":client_id", "projects" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "created_by", "value": "", "description": "Filter to projects created by this user (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ], "variable": [ { "key": "client_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/clients/:client_id/projects", "host": [ "{{base_url}}" ], "path": [ "v1", "clients", ":client_id", "projects" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "created_by", "value": "", "description": "Filter to projects created by this user (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ], "variable": [ { "key": "client_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/clients/:client_id/projects", "host": [ "{{base_url}}" ], "path": [ "v1", "clients", ":client_id", "projects" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "created_by", "value": "", "description": "Filter to projects created by this user (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ], "variable": [ { "key": "client_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] }, { "name": "listMemberProjects", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members/:user_id/projects", "host": [ "{{base_url}}" ], "path": [ "v1", "members", ":user_id", "projects" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "created_by", "value": "", "description": "Filter to projects created by this user (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ], "variable": [ { "key": "user_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] }, "description": "Projects the member is assigned to. Returns 404 if the user is not an eligible org member.\nOffset pagination: default limit 50, max 100. Pass `updated_since` to poll for project\nchanges for this member.\n" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members/:user_id/projects", "host": [ "{{base_url}}" ], "path": [ "v1", "members", ":user_id", "projects" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "created_by", "value": "", "description": "Filter to projects created by this user (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ], "variable": [ { "key": "user_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"name\": \"string\",\n \"color\": \"string\",\n \"description\": \"string\",\n \"start_date\": \"2025-06-01\",\n \"deadline\": \"2025-06-01\",\n \"code\": \"string\",\n \"default\": true,\n \"status\": \"string\",\n \"is_active\": true,\n \"updated_at\": \"2025-06-01T08:00:00Z\"\n }\n ]\n}" }, { "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members/:user_id/projects", "host": [ "{{base_url}}" ], "path": [ "v1", "members", ":user_id", "projects" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "created_by", "value": "", "description": "Filter to projects created by this user (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ], "variable": [ { "key": "user_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {\n \"start_date\": [\n \"start_date and end_date are required.\"\n ]\n }\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members/:user_id/projects", "host": [ "{{base_url}}" ], "path": [ "v1", "members", ":user_id", "projects" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "created_by", "value": "", "description": "Filter to projects created by this user (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ], "variable": [ { "key": "user_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members/:user_id/projects", "host": [ "{{base_url}}" ], "path": [ "v1", "members", ":user_id", "projects" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "created_by", "value": "", "description": "Filter to projects created by this user (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ], "variable": [ { "key": "user_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members/:user_id/projects", "host": [ "{{base_url}}" ], "path": [ "v1", "members", ":user_id", "projects" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "created_by", "value": "", "description": "Filter to projects created by this user (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ], "variable": [ { "key": "user_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members/:user_id/projects", "host": [ "{{base_url}}" ], "path": [ "v1", "members", ":user_id", "projects" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "created_by", "value": "", "description": "Filter to projects created by this user (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ], "variable": [ { "key": "user_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/members/:user_id/projects", "host": [ "{{base_url}}" ], "path": [ "v1", "members", ":user_id", "projects" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "created_by", "value": "", "description": "Filter to projects created by this user (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ], "variable": [ { "key": "user_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] }, { "name": "listProjectMemberships", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/project_memberships", "host": [ "{{base_url}}" ], "path": [ "v1", "project_memberships" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] }, "description": "All project\u2013member assignments in the organization (active and inactive).\n`is_active` is present on each junction row. Designed for polling integrations \u2014\nuse `updated_since` to fetch only assignments that changed instead of fanning out\nto `/v1/members/{user_id}/projects/` or `/v1/projects/{project_id}/members/`.\nOffset pagination \u2014 default limit 50, max 100.\n" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/project_memberships", "host": [ "{{base_url}}" ], "path": [ "v1", "project_memberships" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"user_id\": \"00000000-0000-0000-0000-000000000001\",\n \"project_id\": \"00000000-0000-0000-0000-000000000001\",\n \"can_manage\": true,\n \"can_view_report\": true,\n \"is_active\": true,\n \"updated_at\": \"2025-06-01T08:00:00Z\"\n }\n ]\n}" }, { "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/project_memberships", "host": [ "{{base_url}}" ], "path": [ "v1", "project_memberships" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {\n \"start_date\": [\n \"start_date and end_date are required.\"\n ]\n }\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/project_memberships", "host": [ "{{base_url}}" ], "path": [ "v1", "project_memberships" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/project_memberships", "host": [ "{{base_url}}" ], "path": [ "v1", "project_memberships" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/project_memberships", "host": [ "{{base_url}}" ], "path": [ "v1", "project_memberships" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/project_memberships", "host": [ "{{base_url}}" ], "path": [ "v1", "project_memberships" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/project_memberships", "host": [ "{{base_url}}" ], "path": [ "v1", "project_memberships" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] }, { "name": "listTasks", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/tasks", "host": [ "{{base_url}}" ], "path": [ "v1", "tasks" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] }, "description": "All tasks in the organization (active and inactive). `is_active` is present on each item.\nDesigned for polling integrations \u2014 use `updated_since` to fetch only tasks that changed\ninstead of fanning out to `/v1/projects/{project_id}/tasks/` per project.\nOffset pagination \u2014 default limit 50, max 100.\n" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/tasks", "host": [ "{{base_url}}" ], "path": [ "v1", "tasks" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"project_id\": \"00000000-0000-0000-0000-000000000001\",\n \"name\": \"string\",\n \"status\": \"string\",\n \"completed_at\": \"2025-06-01T08:00:00Z\",\n \"color\": \"string\",\n \"is_active\": true,\n \"updated_at\": \"2025-06-01T08:00:00Z\"\n }\n ]\n}" }, { "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/tasks", "host": [ "{{base_url}}" ], "path": [ "v1", "tasks" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {\n \"start_date\": [\n \"start_date and end_date are required.\"\n ]\n }\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/tasks", "host": [ "{{base_url}}" ], "path": [ "v1", "tasks" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/tasks", "host": [ "{{base_url}}" ], "path": [ "v1", "tasks" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/tasks", "host": [ "{{base_url}}" ], "path": [ "v1", "tasks" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/tasks", "host": [ "{{base_url}}" ], "path": [ "v1", "tasks" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/tasks", "host": [ "{{base_url}}" ], "path": [ "v1", "tasks" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only records whose `updated_at` is on or after this ISO 8601 UTC datetime. When provided, results are sorted by `(updated_at, id)` ascending instead of the endpoint's default sort. Omitting this parameter leaves all existing behavior (including default sort order) unchanged.", "disabled": true } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] }, { "name": "listTaskMembers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/tasks/:task_id/members", "host": [ "{{base_url}}" ], "path": [ "v1", "tasks", ":task_id", "members" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ], "variable": [ { "key": "task_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] }, "description": "Members assigned to a task who hold an active org membership. Offset pagination." }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/tasks/:task_id/members", "host": [ "{{base_url}}" ], "path": [ "v1", "tasks", ":task_id", "members" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ], "variable": [ { "key": "task_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"user_id\": \"00000000-0000-0000-0000-000000000001\",\n \"email\": \"user@example.com\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"image\": null,\n \"timezone\": \"string\",\n \"color\": \"string\",\n \"updated_at\": \"2025-06-01T08:00:00Z\"\n }\n ]\n}" }, { "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/tasks/:task_id/members", "host": [ "{{base_url}}" ], "path": [ "v1", "tasks", ":task_id", "members" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ], "variable": [ { "key": "task_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {\n \"start_date\": [\n \"start_date and end_date are required.\"\n ]\n }\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/tasks/:task_id/members", "host": [ "{{base_url}}" ], "path": [ "v1", "tasks", ":task_id", "members" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ], "variable": [ { "key": "task_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/tasks/:task_id/members", "host": [ "{{base_url}}" ], "path": [ "v1", "tasks", ":task_id", "members" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ], "variable": [ { "key": "task_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/tasks/:task_id/members", "host": [ "{{base_url}}" ], "path": [ "v1", "tasks", ":task_id", "members" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ], "variable": [ { "key": "task_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/tasks/:task_id/members", "host": [ "{{base_url}}" ], "path": [ "v1", "tasks", ":task_id", "members" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ], "variable": [ { "key": "task_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/tasks/:task_id/members", "host": [ "{{base_url}}" ], "path": [ "v1", "tasks", ":task_id", "members" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ], "variable": [ { "key": "task_id", "value": "00000000-0000-0000-0000-000000000001", "description": "" } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] } ] }, { "name": "Reports", "item": [ { "name": "listTimeActivityReport", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/time_activity_reports", "host": [ "{{base_url}}" ], "path": [ "v1", "time_activity_reports" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 20)", "disabled": true } ] }, "description": "Aggregates tracked time, activity percentage, idle time, active time, and\nneutral time per user per day within the date range.\n\n`user_id` and `team_id` are **mutually exclusive** \u2014 passing both returns 400.\nUnknown `team_id` returns 404.\nDate range max: 31 days. Offset pagination: default limit 20, max 20.\n" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/time_activity_reports", "host": [ "{{base_url}}" ], "path": [ "v1", "time_activity_reports" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 20)", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"user\": {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"email\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"image\": null,\n \"color\": \"string\"\n },\n \"days\": [\n {\n \"date\": \"2025-06-01\",\n \"time_worked\": \"string\",\n \"average_activity_percentage\": 0,\n \"active_time\": \"string\",\n \"neutral_time\": \"string\",\n \"idle_time\": \"string\"\n }\n ]\n }\n ]\n}" }, { "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/time_activity_reports", "host": [ "{{base_url}}" ], "path": [ "v1", "time_activity_reports" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 20)", "disabled": true } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {\n \"start_date\": [\n \"start_date and end_date are required.\"\n ]\n }\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/time_activity_reports", "host": [ "{{base_url}}" ], "path": [ "v1", "time_activity_reports" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 20)", "disabled": true } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/time_activity_reports", "host": [ "{{base_url}}" ], "path": [ "v1", "time_activity_reports" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 20)", "disabled": true } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/time_activity_reports", "host": [ "{{base_url}}" ], "path": [ "v1", "time_activity_reports" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 20)", "disabled": true } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/time_activity_reports", "host": [ "{{base_url}}" ], "path": [ "v1", "time_activity_reports" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 20)", "disabled": true } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/time_activity_reports", "host": [ "{{base_url}}" ], "path": [ "v1", "time_activity_reports" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 20)", "disabled": true } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] }, { "name": "listManualTimesheetReports", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/manual_timesheet_reports", "host": [ "{{base_url}}" ], "path": [ "v1", "manual_timesheet_reports" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 20)", "disabled": true } ] }, "description": "Manually-added timesheet entries, grouped by user then by date (date DESC,\nentries within a date sorted by start time DESC).\n\n`user_id` and `team_id` are **mutually exclusive** \u2014 passing both returns 400.\nUnknown `team_id` returns 404.\nCap: max 500 log entries per user per page; exceeding returns 400.\nDate range max: 31 days. Offset pagination: default limit 20, max 20.\n" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/manual_timesheet_reports", "host": [ "{{base_url}}" ], "path": [ "v1", "manual_timesheet_reports" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 20)", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"user\": {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"email\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"image\": null,\n \"color\": \"string\"\n },\n \"days\": [\n {\n \"date\": \"2025-06-01\",\n \"entries\": [\n null\n ]\n }\n ]\n }\n ]\n}" }, { "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/manual_timesheet_reports", "host": [ "{{base_url}}" ], "path": [ "v1", "manual_timesheet_reports" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 20)", "disabled": true } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {\n \"start_date\": [\n \"start_date and end_date are required.\"\n ]\n }\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/manual_timesheet_reports", "host": [ "{{base_url}}" ], "path": [ "v1", "manual_timesheet_reports" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 20)", "disabled": true } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/manual_timesheet_reports", "host": [ "{{base_url}}" ], "path": [ "v1", "manual_timesheet_reports" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 20)", "disabled": true } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/manual_timesheet_reports", "host": [ "{{base_url}}" ], "path": [ "v1", "manual_timesheet_reports" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 20)", "disabled": true } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/manual_timesheet_reports", "host": [ "{{base_url}}" ], "path": [ "v1", "manual_timesheet_reports" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 20)", "disabled": true } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/manual_timesheet_reports", "host": [ "{{base_url}}" ], "path": [ "v1", "manual_timesheet_reports" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 20)", "disabled": true } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] }, { "name": "listClockInOut", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/clockinouts", "host": [ "{{base_url}}" ], "path": [ "v1", "clockinouts" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 20)", "disabled": true } ] }, "description": "Attendance records (first clock-in and last clock-out per day) grouped by user.\nResults sorted: users with timesheets in range first, then alphabetically.\n\nUnlike the other report endpoints, `user_id` and `team_id` **may be combined**\n(AND semantics). A missing `team_id` returns 200 with empty results (not 404).\nDate range max: 31 days. Offset pagination: default limit 20, max 20.\n" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/clockinouts", "host": [ "{{base_url}}" ], "path": [ "v1", "clockinouts" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 20)", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"user\": {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"email\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"image\": null,\n \"color\": \"string\"\n },\n \"attendance\": [\n {\n \"date\": \"2025-06-01\",\n \"clock_in\": \"2025-06-01T08:00:00Z\",\n \"clock_out\": \"2025-06-01T08:00:00Z\",\n \"duration\": \"string\"\n }\n ]\n }\n ]\n}" }, { "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/clockinouts", "host": [ "{{base_url}}" ], "path": [ "v1", "clockinouts" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 20)", "disabled": true } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {\n \"start_date\": [\n \"start_date and end_date are required.\"\n ]\n }\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/clockinouts", "host": [ "{{base_url}}" ], "path": [ "v1", "clockinouts" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 20)", "disabled": true } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/clockinouts", "host": [ "{{base_url}}" ], "path": [ "v1", "clockinouts" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 20)", "disabled": true } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/clockinouts", "host": [ "{{base_url}}" ], "path": [ "v1", "clockinouts" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 20)", "disabled": true } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/clockinouts", "host": [ "{{base_url}}" ], "path": [ "v1", "clockinouts" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 20)", "disabled": true } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/clockinouts", "host": [ "{{base_url}}" ], "path": [ "v1", "clockinouts" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Range start (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Range end (YYYY-MM-DD, inclusive, max 31-day span)", "disabled": false }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 20)", "disabled": true } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] } ] }, { "name": "Timesheets", "item": [ { "name": "listTimesheetIdleTime", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/timesheet_idle_times", "host": [ "{{base_url}}" ], "path": [ "v1", "timesheet_idle_times" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": false }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only timesheets whose `updated_at` is on or after this ISO 8601 UTC datetime. When used alone, filters by `updated_at` only (no work-overlap window). When combined with a date range, must fall within `start_date`/`end_date` (inclusive). Each timesheet includes `updated_at` for watermarking the next poll.", "disabled": true }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque continuation token from a prior response's pagination.next_cursor", "disabled": true }, { "key": "limit", "value": "10", "description": "Max users per request", "disabled": true } ] }, "description": "Returns timesheets with nested idle time segments, grouped by user.\n\nUses **cursor pagination** \u2014 do not send `page`. Pass `pagination.next_cursor`\nas `cursor` on subsequent calls. Default limit is 10 users per request (max 20).\n\n**Filter modes** (provide at least one):\n- **Date range:** `start_date` + `end_date` (max 31-day span) filter by when work\n overlapped the calendar window. Optional `timezone` overrides org timezone for\n day boundaries.\n- **Incremental:** `updated_since` alone filters by `timesheets.updated_at >=`\n watermark (no work-overlap window).\n- **Combined:** date range plus `updated_since`; watermark must fall within the\n date window (inclusive, using request/org timezone).\n\nPayload cap: at most 1,000 timesheets per response. When a single user exceeds\n1,000 timesheets and is filtered by `user_id`, returns 400.\n\nUnknown `team_id` returns 404 (team exists with no members \u2192 200 empty).\nException: GET /v1/clockinouts/ returns 200 with empty results instead,\nsince it builds its membership roster first.\n" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/timesheet_idle_times", "host": [ "{{base_url}}" ], "path": [ "v1", "timesheet_idle_times" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": false }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only timesheets whose `updated_at` is on or after this ISO 8601 UTC datetime. When used alone, filters by `updated_at` only (no work-overlap window). When combined with a date range, must fall within `start_date`/`end_date` (inclusive). Each timesheet includes `updated_at` for watermarking the next poll.", "disabled": true }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque continuation token from a prior response's pagination.next_cursor", "disabled": true }, { "key": "limit", "value": "10", "description": "Max users per request", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"results\": [\n {\n \"user\": {\n \"user_id\": \"00000000-0000-0000-0000-000000000001\",\n \"email\": \"user@example.com\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"image\": null,\n \"color\": \"string\"\n },\n \"timesheets\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"is_approved\": true,\n \"modified_flag\": true,\n \"start_timestamp\": 1748764800,\n \"end_timestamp\": 1748764800,\n \"is_manual\": true,\n \"updated_at\": \"2025-06-01T08:00:00Z\",\n \"project\": null,\n \"task\": null,\n \"approved_by\": null,\n \"idle_times\": [\n null\n ]\n }\n ]\n }\n ],\n \"pagination\": {\n \"limit\": 10,\n \"timesheets_cap\": 1000,\n \"users_returned\": 1,\n \"timesheets_returned\": 1,\n \"total_users\": 1,\n \"has_more\": true,\n \"next_cursor\": \"string\"\n }\n}" }, { "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/timesheet_idle_times", "host": [ "{{base_url}}" ], "path": [ "v1", "timesheet_idle_times" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": false }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only timesheets whose `updated_at` is on or after this ISO 8601 UTC datetime. When used alone, filters by `updated_at` only (no work-overlap window). When combined with a date range, must fall within `start_date`/`end_date` (inclusive). Each timesheet includes `updated_at` for watermarking the next poll.", "disabled": true }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque continuation token from a prior response's pagination.next_cursor", "disabled": true }, { "key": "limit", "value": "10", "description": "Max users per request", "disabled": true } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {\n \"start_date\": [\n \"start_date and end_date are required.\"\n ]\n }\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/timesheet_idle_times", "host": [ "{{base_url}}" ], "path": [ "v1", "timesheet_idle_times" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": false }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only timesheets whose `updated_at` is on or after this ISO 8601 UTC datetime. When used alone, filters by `updated_at` only (no work-overlap window). When combined with a date range, must fall within `start_date`/`end_date` (inclusive). Each timesheet includes `updated_at` for watermarking the next poll.", "disabled": true }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque continuation token from a prior response's pagination.next_cursor", "disabled": true }, { "key": "limit", "value": "10", "description": "Max users per request", "disabled": true } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/timesheet_idle_times", "host": [ "{{base_url}}" ], "path": [ "v1", "timesheet_idle_times" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": false }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only timesheets whose `updated_at` is on or after this ISO 8601 UTC datetime. When used alone, filters by `updated_at` only (no work-overlap window). When combined with a date range, must fall within `start_date`/`end_date` (inclusive). Each timesheet includes `updated_at` for watermarking the next poll.", "disabled": true }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque continuation token from a prior response's pagination.next_cursor", "disabled": true }, { "key": "limit", "value": "10", "description": "Max users per request", "disabled": true } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/timesheet_idle_times", "host": [ "{{base_url}}" ], "path": [ "v1", "timesheet_idle_times" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": false }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only timesheets whose `updated_at` is on or after this ISO 8601 UTC datetime. When used alone, filters by `updated_at` only (no work-overlap window). When combined with a date range, must fall within `start_date`/`end_date` (inclusive). Each timesheet includes `updated_at` for watermarking the next poll.", "disabled": true }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque continuation token from a prior response's pagination.next_cursor", "disabled": true }, { "key": "limit", "value": "10", "description": "Max users per request", "disabled": true } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/timesheet_idle_times", "host": [ "{{base_url}}" ], "path": [ "v1", "timesheet_idle_times" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": false }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only timesheets whose `updated_at` is on or after this ISO 8601 UTC datetime. When used alone, filters by `updated_at` only (no work-overlap window). When combined with a date range, must fall within `start_date`/`end_date` (inclusive). Each timesheet includes `updated_at` for watermarking the next poll.", "disabled": true }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque continuation token from a prior response's pagination.next_cursor", "disabled": true }, { "key": "limit", "value": "10", "description": "Max users per request", "disabled": true } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/timesheet_idle_times", "host": [ "{{base_url}}" ], "path": [ "v1", "timesheet_idle_times" ], "query": [ { "key": "start_date", "value": "2025-06-01", "description": "Filter start date (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2025-06-30", "description": "Filter end date (YYYY-MM-DD)", "disabled": false }, { "key": "updated_since", "value": "2026-01-01T00:00:00Z", "description": "Return only timesheets whose `updated_at` is on or after this ISO 8601 UTC datetime. When used alone, filters by `updated_at` only (no work-overlap window). When combined with a date range, must fall within `start_date`/`end_date` (inclusive). Each timesheet includes `updated_at` for watermarking the next poll.", "disabled": true }, { "key": "timezone", "value": "America/New_York", "description": "IANA timezone string; overrides organization timezone for day boundaries", "disabled": true }, { "key": "user_id", "value": "", "description": "Filter to a specific user (zero UUID treated as absent)", "disabled": true }, { "key": "team_id", "value": "", "description": "Filter to members of a specific team (zero UUID treated as absent).\nReturns 404 when the team does not exist in the organization, except on\nGET /v1/clockinouts/ (200 with empty results \u2014 clockinout builds its\nmembership roster first, so \"no members match\" is a valid empty state\nrather than a lookup failure).\n", "disabled": true }, { "key": "project_id", "value": "", "description": "Filter to a specific project (zero UUID treated as absent)", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque continuation token from a prior response's pagination.next_cursor", "disabled": true }, { "key": "limit", "value": "10", "description": "Max users per request", "disabled": true } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] }, { "name": "listLiveTrackingMembers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/live_tracking_members", "host": [ "{{base_url}}" ], "path": [ "v1", "live_tracking_members" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] }, "description": "Returns organization members currently tracking time (\"online\" right\nnow), determined by a live signal (not a Postgres column) \u2014 members\nwith no active tracking session are simply absent from `results`.\n\nNo team/client-portal visibility scoping: always the full organization.\n`start_time` is always in the organization's own timezone (no\n`timezone` override, unlike GET /v1/timesheet_idle_times/).\n\nOffset pagination: default limit 50, max 100.\n" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/live_tracking_members", "host": [ "{{base_url}}" ], "path": [ "v1", "live_tracking_members" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"user\": {\n \"user_id\": \"00000000-0000-0000-0000-000000000001\",\n \"email\": \"user@example.com\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"image\": null,\n \"timezone\": \"string\",\n \"color\": \"string\"\n },\n \"project\": {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"name\": \"string\"\n },\n \"task\": {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"name\": \"string\"\n },\n \"start_time\": \"2025-06-01T08:00:00Z\"\n }\n ]\n}" }, { "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/live_tracking_members", "host": [ "{{base_url}}" ], "path": [ "v1", "live_tracking_members" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {\n \"start_date\": [\n \"start_date and end_date are required.\"\n ]\n }\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/live_tracking_members", "host": [ "{{base_url}}" ], "path": [ "v1", "live_tracking_members" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/live_tracking_members", "host": [ "{{base_url}}" ], "path": [ "v1", "live_tracking_members" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/live_tracking_members", "host": [ "{{base_url}}" ], "path": [ "v1", "live_tracking_members" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/live_tracking_members", "host": [ "{{base_url}}" ], "path": [ "v1", "live_tracking_members" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/live_tracking_members", "host": [ "{{base_url}}" ], "path": [ "v1", "live_tracking_members" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] }, { "name": "listMemberLatestActivities", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/member_latest_activities", "host": [ "{{base_url}}" ], "path": [ "v1", "member_latest_activities" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] }, "description": "Returns, for every active, non-client org member who is currently\nOFFLINE, their most recent tracked session \u2014 however old, no time\ncap. A member with no tracking history at all still gets a row,\nwith `project`/`task`/`start_time`/`end_time` all `null` (a\nplaceholder row) \u2014 never omitted.\n\nMembers currently online are excluded entirely: this endpoint and\nGET /v1/live_tracking_members/ together cover every active org\nmember exactly once, with no overlap and no gaps.\n\nNo screenshot data.\n\nNo team/client-portal visibility scoping: always the full\norganization. `start_time`/`end_time` are always in the\norganization's own timezone (no `timezone` override).\n\nOffset pagination: default limit 50, max 100.\n" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/member_latest_activities", "host": [ "{{base_url}}" ], "path": [ "v1", "member_latest_activities" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"user\": {\n \"user_id\": \"00000000-0000-0000-0000-000000000001\",\n \"email\": \"user@example.com\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"image\": null,\n \"timezone\": \"string\",\n \"color\": \"string\"\n },\n \"project\": {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"name\": \"string\"\n },\n \"task\": {\n \"id\": \"00000000-0000-0000-0000-000000000001\",\n \"name\": \"string\"\n },\n \"start_time\": \"2025-06-01T08:00:00Z\",\n \"end_time\": \"2025-06-01T08:00:00Z\"\n }\n ]\n}" }, { "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/member_latest_activities", "host": [ "{{base_url}}" ], "path": [ "v1", "member_latest_activities" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {\n \"start_date\": [\n \"start_date and end_date are required.\"\n ]\n }\n }\n}" }, { "name": "401 Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/member_latest_activities", "host": [ "{{base_url}}" ], "path": [ "v1", "member_latest_activities" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid or missing API key.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/member_latest_activities", "host": [ "{{base_url}}" ], "path": [ "v1", "member_latest_activities" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"RESOURCE_NOT_FOUND\",\n \"message\": \"Resource not found.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "429 Too Many Requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/member_latest_activities", "host": [ "{{base_url}}" ], "path": [ "v1", "member_latest_activities" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"start_date and end_date are required.\",\n \"request_id\": \"req_abc123\",\n \"details\": {},\n \"retry_after_seconds\": 30\n }\n}" }, { "name": "500 Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/member_latest_activities", "host": [ "{{base_url}}" ], "path": [ "v1", "member_latest_activities" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"An unexpected error occurred.\",\n \"request_id\": \"req_abc123\"\n }\n}" }, { "name": "503", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-APPLOYE-API-KEY", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/v1/member_latest_activities", "host": [ "{{base_url}}" ], "path": [ "v1", "member_latest_activities" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)", "disabled": true }, { "key": "limit", "value": "10", "description": "Items per page (max 100)", "disabled": true } ] } }, "status": "", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"SERVICE_UNAVAILABLE\",\n \"message\": \"Service temporarily unavailable.\",\n \"request_id\": \"req_abc123\",\n \"retry_after_seconds\": 5\n }\n}" } ] } ] } ] }