{ "auth": { "apikey": [ { "key": "key", "type": "string", "value": "apikey" }, { "key": "value", "type": "string", "value": "{{apiKey}}" }, { "key": "in", "type": "string", "value": "header" } ], "type": "apikey" }, "event": [], "info": { "_postman_id": "06e91542-22e5-437d-ae41-26d0df1de394", "description": { "content": "ProWorkflow Management API - REST API for managing projects, companies, contacts, invoices, quotes, and related business data\n\nContact Support:\n Name: API Support\n Email: support@proworkflow.com", "type": "text/plain" }, "name": "ProWorkflow API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "description": "", "item": [ { "event": [], "id": "1b92bcac-5c3e-4cee-bb87-6e577d022973", "name": "/companies", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Companies based on the filters specified. The fields parameter allows you to choose which data fields to return for each Company.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/companies", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- code - Company code identifier\n- contacts - Associated contacts as a JSON array [{id, firstname, lastname}] (use contactdetails field or query param to include email, phone, image)\n- contactdetails - Alias for contacts field with email, phone, and image included\n- email - Primary email address\n- fax - Fax number\n- image - Company logo/image URL\n- lastmodifiedutc - Last modified date in ISO8601 format (UTC)\n- maincompanylocationid - ID of the primary company location\n- name - Company name\n- phone - Primary phone number\n- tags - Company tags as a JSON array [{id, name, color}]\n- type - Company type (client, contractor, staff, other)\n- website - Company website URL", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "code,name,type" }, { "description": { "content": "Return contact details (email, image, phone)", "type": "text/plain" }, "disabled": true, "key": "contactdetails", "value": "false" }, { "description": { "content": "Include the company's locations array in each result", "type": "text/plain" }, "disabled": true, "key": "includelocations", "value": "false" }, { "description": { "content": "Deprecated: use name, code, email, or q+qfields instead. Search by name or code. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use code or q+qfields instead. Search by code. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use email or q+qfields instead. Search by email. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact code match", "type": "text/plain" }, "disabled": true, "key": "code", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact email match", "type": "text/plain" }, "disabled": true, "key": "email", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,code,email)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "email" }, { "description": { "content": "Company Type. \n- client - Client Companies\n- contractor - Contractor Companies\n- other - Other Companies\n- staff - Staff Companies (This can only be one of client,contractor,other,staff)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "client" }, { "description": { "content": "Tag ID or List of Tag IDs. \n- tagid/s - Companies with at least one of the specified Tag ID/s Example: 1,2,3", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only). \n- divisionid - Companies in specified Division Example: 1", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Companies added/edited on or after this date (UTC time). \n- Specific date \u0026 time - Date in ISO8601 (yyyy-mm-ddThh:mm) format Example: 2014-01-18T13:20\n- Xn/h/d/w/m - X minutes/hours/days/weeks/months ago Example: 12h", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Companies added/edited on or before this date (UTC time). \n- Specific date \u0026 time - Date in ISO8601 (yyyy-mm-ddThh:mm) format Example: 2014-01-18T13:20\n- Xn/h/d/w/m - X minutes/hours/days/weeks/months ago Example: 12h", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Companies with ID less than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Companies with ID greater than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,code)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"code\": \"\u003cstring\u003e\",\n \"contacts\": [\n {\n \"email\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"workphone\": \"\u003cstring\u003e\"\n },\n {\n \"email\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"workphone\": \"\u003cstring\u003e\"\n }\n ],\n \"email\": \"\u003cstring\u003e\",\n \"fax\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"locations\": [\n {\n \"active\": \"\u003cboolean\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"countryid\": \"\u003cinteger\u003e\",\n \"deliveryinstructions\": \"\u003cstring\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"formattedaddress\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"latitude\": \"\u003cnumber\u003e\",\n \"longitude\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"phone2\": \"\u003cstring\u003e\",\n \"placeid\": \"\u003cstring\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"suburb\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n },\n {\n \"active\": \"\u003cboolean\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"countryid\": \"\u003cinteger\u003e\",\n \"deliveryinstructions\": \"\u003cstring\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"formattedaddress\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"latitude\": \"\u003cnumber\u003e\",\n \"longitude\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"phone2\": \"\u003cstring\u003e\",\n \"placeid\": \"\u003cstring\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"suburb\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n }\n ],\n \"maincompanylocationid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"tags\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"type\": \"\u003cstring\u003e\",\n \"website\": \"\u003cstring\u003e\"\n },\n {\n \"code\": \"\u003cstring\u003e\",\n \"contacts\": [\n {\n \"email\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"workphone\": \"\u003cstring\u003e\"\n },\n {\n \"email\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"workphone\": \"\u003cstring\u003e\"\n }\n ],\n \"email\": \"\u003cstring\u003e\",\n \"fax\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"locations\": [\n {\n \"active\": \"\u003cboolean\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"countryid\": \"\u003cinteger\u003e\",\n \"deliveryinstructions\": \"\u003cstring\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"formattedaddress\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"latitude\": \"\u003cnumber\u003e\",\n \"longitude\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"phone2\": \"\u003cstring\u003e\",\n \"placeid\": \"\u003cstring\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"suburb\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n },\n {\n \"active\": \"\u003cboolean\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"countryid\": \"\u003cinteger\u003e\",\n \"deliveryinstructions\": \"\u003cstring\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"formattedaddress\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"latitude\": \"\u003cnumber\u003e\",\n \"longitude\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"phone2\": \"\u003cstring\u003e\",\n \"placeid\": \"\u003cstring\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"suburb\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n }\n ],\n \"maincompanylocationid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"tags\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"type\": \"\u003cstring\u003e\",\n \"website\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "031a470d-3476-4ae3-b217-dcc5a08c13f0", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- code - Company code identifier\n- contacts - Associated contacts as a JSON array [{id, firstname, lastname}] (use contactdetails field or query param to include email, phone, image)\n- contactdetails - Alias for contacts field with email, phone, and image included\n- email - Primary email address\n- fax - Fax number\n- image - Company logo/image URL\n- lastmodifiedutc - Last modified date in ISO8601 format (UTC)\n- maincompanylocationid - ID of the primary company location\n- name - Company name\n- phone - Primary phone number\n- tags - Company tags as a JSON array [{id, name, color}]\n- type - Company type (client, contractor, staff, other)\n- website - Company website URL", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "code,name,type" }, { "description": { "content": "Return contact details (email, image, phone)", "type": "text/plain" }, "disabled": true, "key": "contactdetails", "value": "false" }, { "description": { "content": "Include the company's locations array in each result", "type": "text/plain" }, "disabled": true, "key": "includelocations", "value": "false" }, { "description": { "content": "Deprecated: use name, code, email, or q+qfields instead. Search by name or code. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use code or q+qfields instead. Search by code. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use email or q+qfields instead. Search by email. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact code match", "type": "text/plain" }, "disabled": true, "key": "code", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact email match", "type": "text/plain" }, "disabled": true, "key": "email", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,code,email)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "email" }, { "description": { "content": "Company Type. \n- client - Client Companies\n- contractor - Contractor Companies\n- other - Other Companies\n- staff - Staff Companies (This can only be one of client,contractor,other,staff)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "client" }, { "description": { "content": "Tag ID or List of Tag IDs. \n- tagid/s - Companies with at least one of the specified Tag ID/s Example: 1,2,3", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only). \n- divisionid - Companies in specified Division Example: 1", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Companies added/edited on or after this date (UTC time). \n- Specific date \u0026 time - Date in ISO8601 (yyyy-mm-ddThh:mm) format Example: 2014-01-18T13:20\n- Xn/h/d/w/m - X minutes/hours/days/weeks/months ago Example: 12h", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Companies added/edited on or before this date (UTC time). \n- Specific date \u0026 time - Date in ISO8601 (yyyy-mm-ddThh:mm) format Example: 2014-01-18T13:20\n- Xn/h/d/w/m - X minutes/hours/days/weeks/months ago Example: 12h", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Companies with ID less than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Companies with ID greater than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,code)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "dba6031a-7e04-4e70-8dd8-c0e6567dfa33", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- code - Company code identifier\n- contacts - Associated contacts as a JSON array [{id, firstname, lastname}] (use contactdetails field or query param to include email, phone, image)\n- contactdetails - Alias for contacts field with email, phone, and image included\n- email - Primary email address\n- fax - Fax number\n- image - Company logo/image URL\n- lastmodifiedutc - Last modified date in ISO8601 format (UTC)\n- maincompanylocationid - ID of the primary company location\n- name - Company name\n- phone - Primary phone number\n- tags - Company tags as a JSON array [{id, name, color}]\n- type - Company type (client, contractor, staff, other)\n- website - Company website URL", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "code,name,type" }, { "description": { "content": "Return contact details (email, image, phone)", "type": "text/plain" }, "disabled": true, "key": "contactdetails", "value": "false" }, { "description": { "content": "Include the company's locations array in each result", "type": "text/plain" }, "disabled": true, "key": "includelocations", "value": "false" }, { "description": { "content": "Deprecated: use name, code, email, or q+qfields instead. Search by name or code. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use code or q+qfields instead. Search by code. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use email or q+qfields instead. Search by email. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact code match", "type": "text/plain" }, "disabled": true, "key": "code", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact email match", "type": "text/plain" }, "disabled": true, "key": "email", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,code,email)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "email" }, { "description": { "content": "Company Type. \n- client - Client Companies\n- contractor - Contractor Companies\n- other - Other Companies\n- staff - Staff Companies (This can only be one of client,contractor,other,staff)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "client" }, { "description": { "content": "Tag ID or List of Tag IDs. \n- tagid/s - Companies with at least one of the specified Tag ID/s Example: 1,2,3", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only). \n- divisionid - Companies in specified Division Example: 1", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Companies added/edited on or after this date (UTC time). \n- Specific date \u0026 time - Date in ISO8601 (yyyy-mm-ddThh:mm) format Example: 2014-01-18T13:20\n- Xn/h/d/w/m - X minutes/hours/days/weeks/months ago Example: 12h", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Companies added/edited on or before this date (UTC time). \n- Specific date \u0026 time - Date in ISO8601 (yyyy-mm-ddThh:mm) format Example: 2014-01-18T13:20\n- Xn/h/d/w/m - X minutes/hours/days/weeks/months ago Example: 12h", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Companies with ID less than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Companies with ID greater than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,code)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "920b85f5-6194-47e6-9ab9-139e2af9d06d", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- code - Company code identifier\n- contacts - Associated contacts as a JSON array [{id, firstname, lastname}] (use contactdetails field or query param to include email, phone, image)\n- contactdetails - Alias for contacts field with email, phone, and image included\n- email - Primary email address\n- fax - Fax number\n- image - Company logo/image URL\n- lastmodifiedutc - Last modified date in ISO8601 format (UTC)\n- maincompanylocationid - ID of the primary company location\n- name - Company name\n- phone - Primary phone number\n- tags - Company tags as a JSON array [{id, name, color}]\n- type - Company type (client, contractor, staff, other)\n- website - Company website URL", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "code,name,type" }, { "description": { "content": "Return contact details (email, image, phone)", "type": "text/plain" }, "disabled": true, "key": "contactdetails", "value": "false" }, { "description": { "content": "Include the company's locations array in each result", "type": "text/plain" }, "disabled": true, "key": "includelocations", "value": "false" }, { "description": { "content": "Deprecated: use name, code, email, or q+qfields instead. Search by name or code. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use code or q+qfields instead. Search by code. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use email or q+qfields instead. Search by email. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact code match", "type": "text/plain" }, "disabled": true, "key": "code", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact email match", "type": "text/plain" }, "disabled": true, "key": "email", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,code,email)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "email" }, { "description": { "content": "Company Type. \n- client - Client Companies\n- contractor - Contractor Companies\n- other - Other Companies\n- staff - Staff Companies (This can only be one of client,contractor,other,staff)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "client" }, { "description": { "content": "Tag ID or List of Tag IDs. \n- tagid/s - Companies with at least one of the specified Tag ID/s Example: 1,2,3", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only). \n- divisionid - Companies in specified Division Example: 1", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Companies added/edited on or after this date (UTC time). \n- Specific date \u0026 time - Date in ISO8601 (yyyy-mm-ddThh:mm) format Example: 2014-01-18T13:20\n- Xn/h/d/w/m - X minutes/hours/days/weeks/months ago Example: 12h", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Companies added/edited on or before this date (UTC time). \n- Specific date \u0026 time - Date in ISO8601 (yyyy-mm-ddThh:mm) format Example: 2014-01-18T13:20\n- Xn/h/d/w/m - X minutes/hours/days/weeks/months ago Example: 12h", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Companies with ID less than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Companies with ID greater than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,code)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "0b430cd0-1a20-4cb3-b212-9419d5cd2007", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- code - Company code identifier\n- contacts - Associated contacts as a JSON array [{id, firstname, lastname}] (use contactdetails field or query param to include email, phone, image)\n- contactdetails - Alias for contacts field with email, phone, and image included\n- email - Primary email address\n- fax - Fax number\n- image - Company logo/image URL\n- lastmodifiedutc - Last modified date in ISO8601 format (UTC)\n- maincompanylocationid - ID of the primary company location\n- name - Company name\n- phone - Primary phone number\n- tags - Company tags as a JSON array [{id, name, color}]\n- type - Company type (client, contractor, staff, other)\n- website - Company website URL", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "code,name,type" }, { "description": { "content": "Return contact details (email, image, phone)", "type": "text/plain" }, "disabled": true, "key": "contactdetails", "value": "false" }, { "description": { "content": "Include the company's locations array in each result", "type": "text/plain" }, "disabled": true, "key": "includelocations", "value": "false" }, { "description": { "content": "Deprecated: use name, code, email, or q+qfields instead. Search by name or code. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use code or q+qfields instead. Search by code. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use email or q+qfields instead. Search by email. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact code match", "type": "text/plain" }, "disabled": true, "key": "code", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact email match", "type": "text/plain" }, "disabled": true, "key": "email", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,code,email)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "email" }, { "description": { "content": "Company Type. \n- client - Client Companies\n- contractor - Contractor Companies\n- other - Other Companies\n- staff - Staff Companies (This can only be one of client,contractor,other,staff)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "client" }, { "description": { "content": "Tag ID or List of Tag IDs. \n- tagid/s - Companies with at least one of the specified Tag ID/s Example: 1,2,3", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only). \n- divisionid - Companies in specified Division Example: 1", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Companies added/edited on or after this date (UTC time). \n- Specific date \u0026 time - Date in ISO8601 (yyyy-mm-ddThh:mm) format Example: 2014-01-18T13:20\n- Xn/h/d/w/m - X minutes/hours/days/weeks/months ago Example: 12h", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Companies added/edited on or before this date (UTC time). \n- Specific date \u0026 time - Date in ISO8601 (yyyy-mm-ddThh:mm) format Example: 2014-01-18T13:20\n- Xn/h/d/w/m - X minutes/hours/days/weeks/months ago Example: 12h", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Companies with ID less than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Companies with ID greater than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,code)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "82a2f875-f893-4d5b-8684-515984dcba92", "name": "/companies", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"avatarname\": \"\u003cstring\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companies\": [\n {\n \"value\": \"\u003cCircular reference to #/components/schemas/handlers.CreateCompanyPayload detected\u003e\"\n },\n {\n \"value\": \"\u003cCircular reference to #/components/schemas/handlers.CreateCompanyPayload detected\u003e\"\n }\n ],\n \"creatorid\": \"\u003cinteger\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"facebook\": \"\u003cstring\u003e\",\n \"fax\": \"\u003cstring\u003e\",\n \"isperson\": \"\u003cboolean\u003e\",\n \"linkedin\": \"\u003cstring\u003e\",\n \"maincompanylocationid\": \"\u003cinteger\u003e\",\n \"maincontactid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"tagid\": \"\u003cstring\u003e\",\n \"twitter\": \"\u003cstring\u003e\",\n \"type\": \"other\",\n \"website\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Creates one or more companies. Can accept a single company object or an array of companies in the 'companies' field.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/companies", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9a8ec71d-7f8e-4f20-ac84-25ffca5006d4", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"avatarname\": \"\u003cstring\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companies\": [\n {\n \"value\": \"\u003cCircular reference to #/components/schemas/handlers.CreateCompanyPayload detected\u003e\"\n },\n {\n \"value\": \"\u003cCircular reference to #/components/schemas/handlers.CreateCompanyPayload detected\u003e\"\n }\n ],\n \"creatorid\": \"\u003cinteger\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"facebook\": \"\u003cstring\u003e\",\n \"fax\": \"\u003cstring\u003e\",\n \"isperson\": \"\u003cboolean\u003e\",\n \"linkedin\": \"\u003cstring\u003e\",\n \"maincompanylocationid\": \"\u003cinteger\u003e\",\n \"maincontactid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"tagid\": \"\u003cstring\u003e\",\n \"twitter\": \"\u003cstring\u003e\",\n \"type\": \"other\",\n \"website\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies" ], "query": [], "variable": [] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c6b8b5f4-9ed9-4512-8acc-5713f595816c", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"avatarname\": \"\u003cstring\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companies\": [\n {\n \"value\": \"\u003cCircular reference to #/components/schemas/handlers.CreateCompanyPayload detected\u003e\"\n },\n {\n \"value\": \"\u003cCircular reference to #/components/schemas/handlers.CreateCompanyPayload detected\u003e\"\n }\n ],\n \"creatorid\": \"\u003cinteger\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"facebook\": \"\u003cstring\u003e\",\n \"fax\": \"\u003cstring\u003e\",\n \"isperson\": \"\u003cboolean\u003e\",\n \"linkedin\": \"\u003cstring\u003e\",\n \"maincompanylocationid\": \"\u003cinteger\u003e\",\n \"maincontactid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"tagid\": \"\u003cstring\u003e\",\n \"twitter\": \"\u003cstring\u003e\",\n \"type\": \"other\",\n \"website\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ceb63350-b80e-40a9-8f9d-3082fa8033ca", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"avatarname\": \"\u003cstring\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companies\": [\n {\n \"value\": \"\u003cCircular reference to #/components/schemas/handlers.CreateCompanyPayload detected\u003e\"\n },\n {\n \"value\": \"\u003cCircular reference to #/components/schemas/handlers.CreateCompanyPayload detected\u003e\"\n }\n ],\n \"creatorid\": \"\u003cinteger\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"facebook\": \"\u003cstring\u003e\",\n \"fax\": \"\u003cstring\u003e\",\n \"isperson\": \"\u003cboolean\u003e\",\n \"linkedin\": \"\u003cstring\u003e\",\n \"maincompanylocationid\": \"\u003cinteger\u003e\",\n \"maincontactid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"tagid\": \"\u003cstring\u003e\",\n \"twitter\": \"\u003cstring\u003e\",\n \"type\": \"other\",\n \"website\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "227b0f9d-c9ba-40f8-bdc0-238c4f805516", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"avatarname\": \"\u003cstring\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companies\": [\n {\n \"value\": \"\u003cCircular reference to #/components/schemas/handlers.CreateCompanyPayload detected\u003e\"\n },\n {\n \"value\": \"\u003cCircular reference to #/components/schemas/handlers.CreateCompanyPayload detected\u003e\"\n }\n ],\n \"creatorid\": \"\u003cinteger\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"facebook\": \"\u003cstring\u003e\",\n \"fax\": \"\u003cstring\u003e\",\n \"isperson\": \"\u003cboolean\u003e\",\n \"linkedin\": \"\u003cstring\u003e\",\n \"maincompanylocationid\": \"\u003cinteger\u003e\",\n \"maincontactid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"tagid\": \"\u003cstring\u003e\",\n \"twitter\": \"\u003cstring\u003e\",\n \"type\": \"other\",\n \"website\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "fc2d11f7-7194-46d8-9397-d7d31e05b2ad", "name": "/companies/client", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Client Companies based on the specified filters. Equivalent to GET /companies with type=client.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/companies/client", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", "client" ], "query": [ { "description": { "content": "Comma-separated list of fields to return", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "code,name,type" }, { "description": { "content": "Return contact details (email, image, phone)", "type": "text/plain" }, "disabled": true, "key": "contactdetails", "value": "false" }, { "description": { "content": "Search string. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by code. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by email. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Tag ID or comma-separated list of Tag IDs", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified from date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified to date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter companies with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter companies with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,code)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"code\": \"\u003cstring\u003e\",\n \"contacts\": [\n {\n \"email\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"workphone\": \"\u003cstring\u003e\"\n },\n {\n \"email\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"workphone\": \"\u003cstring\u003e\"\n }\n ],\n \"email\": \"\u003cstring\u003e\",\n \"fax\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"locations\": [\n {\n \"active\": \"\u003cboolean\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"countryid\": \"\u003cinteger\u003e\",\n \"deliveryinstructions\": \"\u003cstring\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"formattedaddress\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"latitude\": \"\u003cnumber\u003e\",\n \"longitude\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"phone2\": \"\u003cstring\u003e\",\n \"placeid\": \"\u003cstring\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"suburb\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n },\n {\n \"active\": \"\u003cboolean\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"countryid\": \"\u003cinteger\u003e\",\n \"deliveryinstructions\": \"\u003cstring\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"formattedaddress\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"latitude\": \"\u003cnumber\u003e\",\n \"longitude\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"phone2\": \"\u003cstring\u003e\",\n \"placeid\": \"\u003cstring\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"suburb\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n }\n ],\n \"maincompanylocationid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"tags\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"type\": \"\u003cstring\u003e\",\n \"website\": \"\u003cstring\u003e\"\n },\n {\n \"code\": \"\u003cstring\u003e\",\n \"contacts\": [\n {\n \"email\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"workphone\": \"\u003cstring\u003e\"\n },\n {\n \"email\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"workphone\": \"\u003cstring\u003e\"\n }\n ],\n \"email\": \"\u003cstring\u003e\",\n \"fax\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"locations\": [\n {\n \"active\": \"\u003cboolean\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"countryid\": \"\u003cinteger\u003e\",\n \"deliveryinstructions\": \"\u003cstring\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"formattedaddress\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"latitude\": \"\u003cnumber\u003e\",\n \"longitude\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"phone2\": \"\u003cstring\u003e\",\n \"placeid\": \"\u003cstring\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"suburb\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n },\n {\n \"active\": \"\u003cboolean\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"countryid\": \"\u003cinteger\u003e\",\n \"deliveryinstructions\": \"\u003cstring\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"formattedaddress\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"latitude\": \"\u003cnumber\u003e\",\n \"longitude\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"phone2\": \"\u003cstring\u003e\",\n \"placeid\": \"\u003cstring\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"suburb\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n }\n ],\n \"maincompanylocationid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"tags\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"type\": \"\u003cstring\u003e\",\n \"website\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "bec89e22-e3d4-4e34-b875-109a45bc7cee", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", "client" ], "query": [ { "description": { "content": "Comma-separated list of fields to return", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "code,name,type" }, { "description": { "content": "Return contact details (email, image, phone)", "type": "text/plain" }, "disabled": true, "key": "contactdetails", "value": "false" }, { "description": { "content": "Search string. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by code. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by email. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Tag ID or comma-separated list of Tag IDs", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified from date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified to date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter companies with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter companies with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,code)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3c10b9d9-f6d6-4296-be1c-120d63cbf76a", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", "client" ], "query": [ { "description": { "content": "Comma-separated list of fields to return", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "code,name,type" }, { "description": { "content": "Return contact details (email, image, phone)", "type": "text/plain" }, "disabled": true, "key": "contactdetails", "value": "false" }, { "description": { "content": "Search string. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by code. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by email. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Tag ID or comma-separated list of Tag IDs", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified from date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified to date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter companies with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter companies with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,code)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b81f9d2d-36ab-4a46-9322-38c072de2026", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", "client" ], "query": [ { "description": { "content": "Comma-separated list of fields to return", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "code,name,type" }, { "description": { "content": "Return contact details (email, image, phone)", "type": "text/plain" }, "disabled": true, "key": "contactdetails", "value": "false" }, { "description": { "content": "Search string. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by code. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by email. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Tag ID or comma-separated list of Tag IDs", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified from date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified to date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter companies with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter companies with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,code)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ab36fe46-25ad-4cd3-8419-50a70e3bd6d0", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", "client" ], "query": [ { "description": { "content": "Comma-separated list of fields to return", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "code,name,type" }, { "description": { "content": "Return contact details (email, image, phone)", "type": "text/plain" }, "disabled": true, "key": "contactdetails", "value": "false" }, { "description": { "content": "Search string. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by code. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by email. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Tag ID or comma-separated list of Tag IDs", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified from date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified to date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter companies with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter companies with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,code)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "c13d78df-418a-44d4-88a3-a329d4400cbd", "name": "/companies/contractor", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Contractor Companies based on the specified filters. Equivalent to GET /companies with type=contractor.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/companies/contractor", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", "contractor" ], "query": [ { "description": { "content": "Comma-separated list of fields to return", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "code,name,type" }, { "description": { "content": "Return contact details (email, image, phone)", "type": "text/plain" }, "disabled": true, "key": "contactdetails", "value": "false" }, { "description": { "content": "Deprecated: use name, code, email, or q+qfields instead. Search by name or code. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use code or q+qfields instead. Search by code. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use email or q+qfields instead. Search by email. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact code match", "type": "text/plain" }, "disabled": true, "key": "code", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact email match", "type": "text/plain" }, "disabled": true, "key": "email", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,code,email)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "email" }, { "description": { "content": "Tag ID or comma-separated list of Tag IDs", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified from date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified to date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter companies with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter companies with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,code)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"code\": \"\u003cstring\u003e\",\n \"contacts\": [\n {\n \"email\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"workphone\": \"\u003cstring\u003e\"\n },\n {\n \"email\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"workphone\": \"\u003cstring\u003e\"\n }\n ],\n \"email\": \"\u003cstring\u003e\",\n \"fax\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"locations\": [\n {\n \"active\": \"\u003cboolean\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"countryid\": \"\u003cinteger\u003e\",\n \"deliveryinstructions\": \"\u003cstring\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"formattedaddress\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"latitude\": \"\u003cnumber\u003e\",\n \"longitude\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"phone2\": \"\u003cstring\u003e\",\n \"placeid\": \"\u003cstring\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"suburb\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n },\n {\n \"active\": \"\u003cboolean\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"countryid\": \"\u003cinteger\u003e\",\n \"deliveryinstructions\": \"\u003cstring\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"formattedaddress\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"latitude\": \"\u003cnumber\u003e\",\n \"longitude\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"phone2\": \"\u003cstring\u003e\",\n \"placeid\": \"\u003cstring\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"suburb\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n }\n ],\n \"maincompanylocationid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"tags\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"type\": \"\u003cstring\u003e\",\n \"website\": \"\u003cstring\u003e\"\n },\n {\n \"code\": \"\u003cstring\u003e\",\n \"contacts\": [\n {\n \"email\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"workphone\": \"\u003cstring\u003e\"\n },\n {\n \"email\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"workphone\": \"\u003cstring\u003e\"\n }\n ],\n \"email\": \"\u003cstring\u003e\",\n \"fax\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"locations\": [\n {\n \"active\": \"\u003cboolean\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"countryid\": \"\u003cinteger\u003e\",\n \"deliveryinstructions\": \"\u003cstring\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"formattedaddress\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"latitude\": \"\u003cnumber\u003e\",\n \"longitude\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"phone2\": \"\u003cstring\u003e\",\n \"placeid\": \"\u003cstring\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"suburb\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n },\n {\n \"active\": \"\u003cboolean\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"countryid\": \"\u003cinteger\u003e\",\n \"deliveryinstructions\": \"\u003cstring\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"formattedaddress\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"latitude\": \"\u003cnumber\u003e\",\n \"longitude\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"phone2\": \"\u003cstring\u003e\",\n \"placeid\": \"\u003cstring\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"suburb\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n }\n ],\n \"maincompanylocationid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"tags\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"type\": \"\u003cstring\u003e\",\n \"website\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b3129591-8792-4ec1-8954-d6b536d0d789", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", "contractor" ], "query": [ { "description": { "content": "Comma-separated list of fields to return", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "code,name,type" }, { "description": { "content": "Return contact details (email, image, phone)", "type": "text/plain" }, "disabled": true, "key": "contactdetails", "value": "false" }, { "description": { "content": "Deprecated: use name, code, email, or q+qfields instead. Search by name or code. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use code or q+qfields instead. Search by code. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use email or q+qfields instead. Search by email. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact code match", "type": "text/plain" }, "disabled": true, "key": "code", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact email match", "type": "text/plain" }, "disabled": true, "key": "email", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,code,email)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "email" }, { "description": { "content": "Tag ID or comma-separated list of Tag IDs", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified from date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified to date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter companies with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter companies with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,code)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "0efe1fbb-29ba-45fb-9d78-f2b7a18e6feb", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", "contractor" ], "query": [ { "description": { "content": "Comma-separated list of fields to return", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "code,name,type" }, { "description": { "content": "Return contact details (email, image, phone)", "type": "text/plain" }, "disabled": true, "key": "contactdetails", "value": "false" }, { "description": { "content": "Deprecated: use name, code, email, or q+qfields instead. Search by name or code. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use code or q+qfields instead. Search by code. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use email or q+qfields instead. Search by email. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact code match", "type": "text/plain" }, "disabled": true, "key": "code", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact email match", "type": "text/plain" }, "disabled": true, "key": "email", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,code,email)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "email" }, { "description": { "content": "Tag ID or comma-separated list of Tag IDs", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified from date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified to date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter companies with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter companies with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,code)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ba8643f7-557d-4073-8e54-6ae73835152a", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", "contractor" ], "query": [ { "description": { "content": "Comma-separated list of fields to return", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "code,name,type" }, { "description": { "content": "Return contact details (email, image, phone)", "type": "text/plain" }, "disabled": true, "key": "contactdetails", "value": "false" }, { "description": { "content": "Deprecated: use name, code, email, or q+qfields instead. Search by name or code. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use code or q+qfields instead. Search by code. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use email or q+qfields instead. Search by email. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact code match", "type": "text/plain" }, "disabled": true, "key": "code", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact email match", "type": "text/plain" }, "disabled": true, "key": "email", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,code,email)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "email" }, { "description": { "content": "Tag ID or comma-separated list of Tag IDs", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified from date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified to date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter companies with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter companies with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,code)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4e9f91a7-4de2-4e13-85fd-6a27154b8bb1", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", "contractor" ], "query": [ { "description": { "content": "Comma-separated list of fields to return", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "code,name,type" }, { "description": { "content": "Return contact details (email, image, phone)", "type": "text/plain" }, "disabled": true, "key": "contactdetails", "value": "false" }, { "description": { "content": "Deprecated: use name, code, email, or q+qfields instead. Search by name or code. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use code or q+qfields instead. Search by code. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use email or q+qfields instead. Search by email. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact code match", "type": "text/plain" }, "disabled": true, "key": "code", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact email match", "type": "text/plain" }, "disabled": true, "key": "email", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,code,email)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "email" }, { "description": { "content": "Tag ID or comma-separated list of Tag IDs", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified from date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified to date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter companies with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter companies with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,code)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "7d504269-6f4b-4ef0-b68f-2cf6cd2e59b7", "name": "/companies/staff", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Staff Companies based on the specified filters. Equivalent to GET /companies with type=staff.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/companies/staff", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", "staff" ], "query": [ { "description": { "content": "Comma-separated list of fields to return", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "code,name,type" }, { "description": { "content": "Return contact details (email, image, phone)", "type": "text/plain" }, "disabled": true, "key": "contactdetails", "value": "false" }, { "description": { "content": "Deprecated: use name, code, email, or q+qfields instead. Search by name or code. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use code or q+qfields instead. Search by code. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use email or q+qfields instead. Search by email. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact code match", "type": "text/plain" }, "disabled": true, "key": "code", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact email match", "type": "text/plain" }, "disabled": true, "key": "email", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,code,email)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "email" }, { "description": { "content": "Tag ID or comma-separated list of Tag IDs", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified from date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified to date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter companies with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter companies with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,code)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"code\": \"\u003cstring\u003e\",\n \"contacts\": [\n {\n \"email\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"workphone\": \"\u003cstring\u003e\"\n },\n {\n \"email\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"workphone\": \"\u003cstring\u003e\"\n }\n ],\n \"email\": \"\u003cstring\u003e\",\n \"fax\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"locations\": [\n {\n \"active\": \"\u003cboolean\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"countryid\": \"\u003cinteger\u003e\",\n \"deliveryinstructions\": \"\u003cstring\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"formattedaddress\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"latitude\": \"\u003cnumber\u003e\",\n \"longitude\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"phone2\": \"\u003cstring\u003e\",\n \"placeid\": \"\u003cstring\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"suburb\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n },\n {\n \"active\": \"\u003cboolean\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"countryid\": \"\u003cinteger\u003e\",\n \"deliveryinstructions\": \"\u003cstring\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"formattedaddress\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"latitude\": \"\u003cnumber\u003e\",\n \"longitude\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"phone2\": \"\u003cstring\u003e\",\n \"placeid\": \"\u003cstring\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"suburb\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n }\n ],\n \"maincompanylocationid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"tags\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"type\": \"\u003cstring\u003e\",\n \"website\": \"\u003cstring\u003e\"\n },\n {\n \"code\": \"\u003cstring\u003e\",\n \"contacts\": [\n {\n \"email\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"workphone\": \"\u003cstring\u003e\"\n },\n {\n \"email\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"workphone\": \"\u003cstring\u003e\"\n }\n ],\n \"email\": \"\u003cstring\u003e\",\n \"fax\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"locations\": [\n {\n \"active\": \"\u003cboolean\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"countryid\": \"\u003cinteger\u003e\",\n \"deliveryinstructions\": \"\u003cstring\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"formattedaddress\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"latitude\": \"\u003cnumber\u003e\",\n \"longitude\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"phone2\": \"\u003cstring\u003e\",\n \"placeid\": \"\u003cstring\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"suburb\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n },\n {\n \"active\": \"\u003cboolean\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"countryid\": \"\u003cinteger\u003e\",\n \"deliveryinstructions\": \"\u003cstring\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"formattedaddress\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"latitude\": \"\u003cnumber\u003e\",\n \"longitude\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"phone2\": \"\u003cstring\u003e\",\n \"placeid\": \"\u003cstring\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"suburb\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n }\n ],\n \"maincompanylocationid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"tags\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"type\": \"\u003cstring\u003e\",\n \"website\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "459fbd15-c94b-4b61-a55a-3c52b8f09120", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", "staff" ], "query": [ { "description": { "content": "Comma-separated list of fields to return", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "code,name,type" }, { "description": { "content": "Return contact details (email, image, phone)", "type": "text/plain" }, "disabled": true, "key": "contactdetails", "value": "false" }, { "description": { "content": "Deprecated: use name, code, email, or q+qfields instead. Search by name or code. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use code or q+qfields instead. Search by code. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use email or q+qfields instead. Search by email. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact code match", "type": "text/plain" }, "disabled": true, "key": "code", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact email match", "type": "text/plain" }, "disabled": true, "key": "email", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,code,email)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "email" }, { "description": { "content": "Tag ID or comma-separated list of Tag IDs", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified from date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified to date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter companies with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter companies with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,code)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "eed20efd-a149-4d13-b9fc-b579385bbdd1", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", "staff" ], "query": [ { "description": { "content": "Comma-separated list of fields to return", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "code,name,type" }, { "description": { "content": "Return contact details (email, image, phone)", "type": "text/plain" }, "disabled": true, "key": "contactdetails", "value": "false" }, { "description": { "content": "Deprecated: use name, code, email, or q+qfields instead. Search by name or code. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use code or q+qfields instead. Search by code. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use email or q+qfields instead. Search by email. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact code match", "type": "text/plain" }, "disabled": true, "key": "code", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact email match", "type": "text/plain" }, "disabled": true, "key": "email", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,code,email)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "email" }, { "description": { "content": "Tag ID or comma-separated list of Tag IDs", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified from date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified to date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter companies with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter companies with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,code)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3f723639-ecf3-4f93-9617-9d850158e73c", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", "staff" ], "query": [ { "description": { "content": "Comma-separated list of fields to return", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "code,name,type" }, { "description": { "content": "Return contact details (email, image, phone)", "type": "text/plain" }, "disabled": true, "key": "contactdetails", "value": "false" }, { "description": { "content": "Deprecated: use name, code, email, or q+qfields instead. Search by name or code. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use code or q+qfields instead. Search by code. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use email or q+qfields instead. Search by email. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact code match", "type": "text/plain" }, "disabled": true, "key": "code", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact email match", "type": "text/plain" }, "disabled": true, "key": "email", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,code,email)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "email" }, { "description": { "content": "Tag ID or comma-separated list of Tag IDs", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified from date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified to date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter companies with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter companies with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,code)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "586f7110-5ffb-48d7-9735-458c5fb71a74", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", "staff" ], "query": [ { "description": { "content": "Comma-separated list of fields to return", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "code,name,type" }, { "description": { "content": "Return contact details (email, image, phone)", "type": "text/plain" }, "disabled": true, "key": "contactdetails", "value": "false" }, { "description": { "content": "Deprecated: use name, code, email, or q+qfields instead. Search by name or code. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use code or q+qfields instead. Search by code. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use email or q+qfields instead. Search by email. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact code match", "type": "text/plain" }, "disabled": true, "key": "code", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact email match", "type": "text/plain" }, "disabled": true, "key": "email", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,code,email)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "email" }, { "description": { "content": "Tag ID or comma-separated list of Tag IDs", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified from date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified to date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter companies with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter companies with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,code)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "5ea6afbb-ae01-4a29-8375-f00f0f7f902a", "name": "/companies/tags", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Adds one or more Tags to one or more Companies.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/companies/tags", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", "tags" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c278d67c-11be-421e-8c3e-170df6265f7d", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", "tags" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7a8af009-1a2f-4a1f-aa58-cbaf1258e39f", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", "tags" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "037a8c71-808a-4659-bf1f-0765cf73eaa3", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", "tags" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "72f50969-7444-4f91-bd5f-a7fa47740aff", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", "tags" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "b55ba49d-9e24-4f8d-a500-ed7556bb804e", "name": "/companies/tags", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Removes one or more Tags from one or more Companies.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/companies/tags", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", "tags" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e92d6138-3efb-47b8-846c-20f2daa320db", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", "tags" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "444b75fa-6ac6-4550-b454-ab7b2616ae0c", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", "tags" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "574b5d3c-b013-481e-b496-41f7d711c815", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", "tags" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5231f7b4-b36b-4af2-8d81-05d7312a31e5", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", "tags" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "e26e42ce-7f38-4b9a-a470-a28025adf77c", "name": "/companies/:companyid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns details for a single company", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/companies/:companyid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"code\": \"\u003cstring\u003e\",\n \"contacts\": [\n {\n \"email\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"workphone\": \"\u003cstring\u003e\"\n },\n {\n \"email\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"workphone\": \"\u003cstring\u003e\"\n }\n ],\n \"email\": \"\u003cstring\u003e\",\n \"fax\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"locations\": [\n {\n \"active\": \"\u003cboolean\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"countryid\": \"\u003cinteger\u003e\",\n \"deliveryinstructions\": \"\u003cstring\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"formattedaddress\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"latitude\": \"\u003cnumber\u003e\",\n \"longitude\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"phone2\": \"\u003cstring\u003e\",\n \"placeid\": \"\u003cstring\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"suburb\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n },\n {\n \"active\": \"\u003cboolean\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"countryid\": \"\u003cinteger\u003e\",\n \"deliveryinstructions\": \"\u003cstring\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"formattedaddress\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"latitude\": \"\u003cnumber\u003e\",\n \"longitude\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"phone2\": \"\u003cstring\u003e\",\n \"placeid\": \"\u003cstring\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"suburb\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n }\n ],\n \"maincompanylocationid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"tags\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"type\": \"\u003cstring\u003e\",\n \"website\": \"\u003cstring\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "76be9052-fe51-4910-a6cc-c8b58c038b1f", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d9222922-f4c4-4a6d-8b20-65a2eb2daf49", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "76b6c56e-3c38-4f6a-b545-6ef1f3e292cf", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b1ed1167-beca-4639-959f-7eccf5767385", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "7a02a6d8-1a98-43e3-9e05-a69f47d6f1ee", "name": "/companies/:companyid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"avatarname\": \"\u003cstring\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"creatorid\": \"\u003cinteger\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"facebook\": \"\u003cstring\u003e\",\n \"fax\": \"\u003cstring\u003e\",\n \"isperson\": \"\u003cboolean\u003e\",\n \"linkedin\": \"\u003cstring\u003e\",\n \"maincompanylocationid\": \"\u003cinteger\u003e\",\n \"maincontactid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"tagid\": \"\u003cstring\u003e\",\n \"twitter\": \"\u003cstring\u003e\",\n \"type\": \"other\",\n \"website\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Updates an existing company", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/companies/:companyid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "08a7511b-66b7-46c4-848d-d295e5f2b173", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"avatarname\": \"\u003cstring\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"creatorid\": \"\u003cinteger\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"facebook\": \"\u003cstring\u003e\",\n \"fax\": \"\u003cstring\u003e\",\n \"isperson\": \"\u003cboolean\u003e\",\n \"linkedin\": \"\u003cstring\u003e\",\n \"maincompanylocationid\": \"\u003cinteger\u003e\",\n \"maincontactid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"tagid\": \"\u003cstring\u003e\",\n \"twitter\": \"\u003cstring\u003e\",\n \"type\": \"other\",\n \"website\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2ca6e724-cfc7-47e7-ae03-97bff55d0ad5", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"avatarname\": \"\u003cstring\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"creatorid\": \"\u003cinteger\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"facebook\": \"\u003cstring\u003e\",\n \"fax\": \"\u003cstring\u003e\",\n \"isperson\": \"\u003cboolean\u003e\",\n \"linkedin\": \"\u003cstring\u003e\",\n \"maincompanylocationid\": \"\u003cinteger\u003e\",\n \"maincontactid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"tagid\": \"\u003cstring\u003e\",\n \"twitter\": \"\u003cstring\u003e\",\n \"type\": \"other\",\n \"website\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "154bd5fd-e028-4696-87fc-43895ce00dba", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"avatarname\": \"\u003cstring\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"creatorid\": \"\u003cinteger\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"facebook\": \"\u003cstring\u003e\",\n \"fax\": \"\u003cstring\u003e\",\n \"isperson\": \"\u003cboolean\u003e\",\n \"linkedin\": \"\u003cstring\u003e\",\n \"maincompanylocationid\": \"\u003cinteger\u003e\",\n \"maincontactid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"tagid\": \"\u003cstring\u003e\",\n \"twitter\": \"\u003cstring\u003e\",\n \"type\": \"other\",\n \"website\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "fb93bed0-686f-41e7-a10a-1165ca0649aa", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"avatarname\": \"\u003cstring\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"creatorid\": \"\u003cinteger\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"facebook\": \"\u003cstring\u003e\",\n \"fax\": \"\u003cstring\u003e\",\n \"isperson\": \"\u003cboolean\u003e\",\n \"linkedin\": \"\u003cstring\u003e\",\n \"maincompanylocationid\": \"\u003cinteger\u003e\",\n \"maincontactid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"tagid\": \"\u003cstring\u003e\",\n \"twitter\": \"\u003cstring\u003e\",\n \"type\": \"other\",\n \"website\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9a61ec41-fff2-406c-afca-3fce1a0f12bb", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"avatarname\": \"\u003cstring\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"creatorid\": \"\u003cinteger\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"facebook\": \"\u003cstring\u003e\",\n \"fax\": \"\u003cstring\u003e\",\n \"isperson\": \"\u003cboolean\u003e\",\n \"linkedin\": \"\u003cstring\u003e\",\n \"maincompanylocationid\": \"\u003cinteger\u003e\",\n \"maincontactid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"tagid\": \"\u003cstring\u003e\",\n \"twitter\": \"\u003cstring\u003e\",\n \"type\": \"other\",\n \"website\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "d2439117-a1b2-4146-b0d0-bef4fd3947de", "name": "/companies/:companyid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Soft deletes a company (marks as deleted)", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/companies/:companyid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid" ], "query": [ { "description": { "content": "Also delete company contacts (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "deletecontacts", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "43b00753-ac31-4e79-b95b-161e1766a469", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid" ], "query": [ { "description": { "content": "Also delete company contacts (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "deletecontacts", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2d297619-cd50-439c-a8fb-3442886658bb", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid" ], "query": [ { "description": { "content": "Also delete company contacts (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "deletecontacts", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "303688fe-b5a6-45a5-863f-d8ab738af024", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid" ], "query": [ { "description": { "content": "Also delete company contacts (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "deletecontacts", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2113dec6-2e53-4daf-a520-554a0bab5091", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid" ], "query": [ { "description": { "content": "Also delete company contacts (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "deletecontacts", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "7035f343-36e4-4533-9698-31bc0fe82b35", "name": "/companies/:companyid/invoices", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Invoices for the specified Company. Supports the same filters as GET /invoices, scoped to the given company.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/companies/:companyid/invoices", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "invoices" ], "query": [ { "description": { "content": "Comma-separated fields to return", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "number,title,company,status,totals,projectid,invoiceddate,duedate" }, { "description": { "content": "Search by number or title. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by invoice number. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by invoice title. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchtitle", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoice status (This can only be one of draft,submitted,authorised,paid,voided,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "all" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Project category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectcategoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project manager Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date from (ISO8601 or relative: 12h, 5d)", "type": "text/plain" }, "disabled": true, "key": "invoiceddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "invoiceddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Paid date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "paiddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Paid date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "paiddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total minimum", "type": "text/plain" }, "disabled": true, "key": "grandtotalfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total maximum", "type": "text/plain" }, "disabled": true, "key": "grandtotalto", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified from in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified to in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter invoices with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter invoices with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Invoice IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,invoiceddate,duedate,companyname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"clientcontactname\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"customfieldname\": \"\u003cstring\u003e\",\n \"customfieldvalue\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"emaileddate\": \"\u003cstring\u003e\",\n \"emailedto\": \"\u003cstring\u003e\",\n \"emailedtoclient\": \"\u003cboolean\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoicedby\": \"\u003cstring\u003e\",\n \"invoiceddate\": \"\u003cstring\u003e\",\n \"invoicetermid\": \"\u003cinteger\u003e\",\n \"itemsDiscount\": \"\u003cnumber\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"pagetitle\": \"\u003cstring\u003e\",\n \"paid\": \"\u003cboolean\u003e\",\n \"paiddate\": \"\u003cstring\u003e\",\n \"paymentterms\": \"\u003cstring\u003e\",\n \"phases\": [\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n }\n ],\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n },\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n }\n ],\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n }\n ],\n \"projectid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"projectnumbers\": \"\u003cstring\u003e\",\n \"projecttitles\": \"\u003cstring\u003e\",\n \"purchaseordernumber\": \"\u003cstring\u003e\",\n \"showcostbreakdown\": \"\u003cboolean\u003e\",\n \"showitemdescription\": \"\u003cboolean\u003e\",\n \"showphases\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"taxable\": \"\u003cboolean\u003e\",\n \"taxrate\": \"\u003cnumber\u003e\",\n \"taxtotal\": \"\u003cnumber\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n },\n {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"clientcontactname\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"customfieldname\": \"\u003cstring\u003e\",\n \"customfieldvalue\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"emaileddate\": \"\u003cstring\u003e\",\n \"emailedto\": \"\u003cstring\u003e\",\n \"emailedtoclient\": \"\u003cboolean\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoicedby\": \"\u003cstring\u003e\",\n \"invoiceddate\": \"\u003cstring\u003e\",\n \"invoicetermid\": \"\u003cinteger\u003e\",\n \"itemsDiscount\": \"\u003cnumber\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"pagetitle\": \"\u003cstring\u003e\",\n \"paid\": \"\u003cboolean\u003e\",\n \"paiddate\": \"\u003cstring\u003e\",\n \"paymentterms\": \"\u003cstring\u003e\",\n \"phases\": [\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n }\n ],\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n },\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n }\n ],\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n }\n ],\n \"projectid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"projectnumbers\": \"\u003cstring\u003e\",\n \"projecttitles\": \"\u003cstring\u003e\",\n \"purchaseordernumber\": \"\u003cstring\u003e\",\n \"showcostbreakdown\": \"\u003cboolean\u003e\",\n \"showitemdescription\": \"\u003cboolean\u003e\",\n \"showphases\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"taxable\": \"\u003cboolean\u003e\",\n \"taxrate\": \"\u003cnumber\u003e\",\n \"taxtotal\": \"\u003cnumber\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b4ae38a8-f1de-4486-81a6-9b5feed3dce9", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "invoices" ], "query": [ { "description": { "content": "Comma-separated fields to return", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "number,title,company,status,totals,projectid,invoiceddate,duedate" }, { "description": { "content": "Search by number or title. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by invoice number. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by invoice title. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchtitle", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoice status (This can only be one of draft,submitted,authorised,paid,voided,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "all" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Project category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectcategoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project manager Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date from (ISO8601 or relative: 12h, 5d)", "type": "text/plain" }, "disabled": true, "key": "invoiceddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "invoiceddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Paid date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "paiddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Paid date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "paiddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total minimum", "type": "text/plain" }, "disabled": true, "key": "grandtotalfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total maximum", "type": "text/plain" }, "disabled": true, "key": "grandtotalto", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified from in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified to in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter invoices with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter invoices with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Invoice IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,invoiceddate,duedate,companyname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7259833e-2454-4836-a5c6-10ddf1ae0cbd", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "invoices" ], "query": [ { "description": { "content": "Comma-separated fields to return", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "number,title,company,status,totals,projectid,invoiceddate,duedate" }, { "description": { "content": "Search by number or title. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by invoice number. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by invoice title. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchtitle", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoice status (This can only be one of draft,submitted,authorised,paid,voided,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "all" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Project category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectcategoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project manager Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date from (ISO8601 or relative: 12h, 5d)", "type": "text/plain" }, "disabled": true, "key": "invoiceddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "invoiceddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Paid date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "paiddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Paid date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "paiddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total minimum", "type": "text/plain" }, "disabled": true, "key": "grandtotalfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total maximum", "type": "text/plain" }, "disabled": true, "key": "grandtotalto", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified from in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified to in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter invoices with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter invoices with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Invoice IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,invoiceddate,duedate,companyname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "44cd2a96-9837-4f24-8740-5d2741e9d065", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "invoices" ], "query": [ { "description": { "content": "Comma-separated fields to return", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "number,title,company,status,totals,projectid,invoiceddate,duedate" }, { "description": { "content": "Search by number or title. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by invoice number. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by invoice title. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchtitle", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoice status (This can only be one of draft,submitted,authorised,paid,voided,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "all" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Project category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectcategoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project manager Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date from (ISO8601 or relative: 12h, 5d)", "type": "text/plain" }, "disabled": true, "key": "invoiceddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "invoiceddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Paid date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "paiddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Paid date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "paiddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total minimum", "type": "text/plain" }, "disabled": true, "key": "grandtotalfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total maximum", "type": "text/plain" }, "disabled": true, "key": "grandtotalto", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified from in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified to in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter invoices with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter invoices with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Invoice IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,invoiceddate,duedate,companyname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "938f276c-6e98-46e4-b44a-8bb620f246c4", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "invoices" ], "query": [ { "description": { "content": "Comma-separated fields to return", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "number,title,company,status,totals,projectid,invoiceddate,duedate" }, { "description": { "content": "Search by number or title. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by invoice number. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by invoice title. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchtitle", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoice status (This can only be one of draft,submitted,authorised,paid,voided,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "all" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Project category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectcategoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project manager Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date from (ISO8601 or relative: 12h, 5d)", "type": "text/plain" }, "disabled": true, "key": "invoiceddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "invoiceddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Paid date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "paiddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Paid date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "paiddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total minimum", "type": "text/plain" }, "disabled": true, "key": "grandtotalfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total maximum", "type": "text/plain" }, "disabled": true, "key": "grandtotalto", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified from in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified to in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter invoices with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter invoices with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Invoice IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,invoiceddate,duedate,companyname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] }, { "event": [], "id": "2d795d60-f748-42d6-a650-1f7ed8eab0fb", "name": "/companies/:companyid/items", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Items for a Company based on the specified filters. The fields parameter allows you to choose which data fields to return for each Item.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/companies/:companyid/items", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: title, code, number, description, status, priority, percentcomplete, position, project, company, dates, time, billable, workstageid, parentid, phasename, assignedto, tags, lastmodified, all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "title,status,priority" }, { "description": { "content": "Search by name or code. Use ! prefix for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by status (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "active" }, { "description": { "content": "Filter by priority (1=Very High to 5=Very Low)", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Contact IDs assigned to item, or 'me'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Mode for contacts filter (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Tag ID or list of Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Items modified on or after this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Items modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Items with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Items with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,title,code,priority,startdate,duedate,completedate,status,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "title" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"actualInLabour\": \"\u003cnumber\u003e\",\n \"actualInTotal\": \"\u003cnumber\u003e\",\n \"actualInTotalTax\": \"\u003cnumber\u003e\",\n \"actualOutLabour\": \"\u003cnumber\u003e\",\n \"actualProfit\": \"\u003cnumber\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"contacts\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cstring\u003e\",\n \"createdatetime\": \"\u003cstring\u003e\",\n \"creatorid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"dependenttaskid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"discountRate\": \"\u003cnumber\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScoreId\": \"\u003cinteger\u003e\",\n \"estBillAmount\": \"\u003cnumber\u003e\",\n \"estBillAmountTax\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"impactScoreId\": \"\u003cinteger\u003e\",\n \"importanceScoreId\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inTaxRate\": \"\u003cnumber\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoicedAmount\": \"\u003cnumber\u003e\",\n \"invoicedAmountTax\": \"\u003cnumber\u003e\",\n \"invoiceitemid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"isDiscountPercent\": \"\u003cboolean\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"manualPercentageComplete\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"number\": \"\u003cinteger\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outTaxRate\": \"\u003cnumber\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"paidAmount\": \"\u003cnumber\u003e\",\n \"paidAmountTax\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"phasename\": \"\u003cstring\u003e\",\n \"prerequisiteid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedBillAmount\": \"\u003cnumber\u003e\",\n \"projectedBillAmountTax\": \"\u003cnumber\u003e\",\n \"projectedGrossMargin\": \"\u003cnumber\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"projectedOutLabour\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"projectedTimeManual\": \"\u003cnumber\u003e\",\n \"projectedTimeSpent\": \"\u003cnumber\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"quoteitemid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cinteger\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tags\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"uniquetoken\": \"\u003cstring\u003e\",\n \"urgencyScoreId\": \"\u003cinteger\u003e\"\n },\n {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"actualInLabour\": \"\u003cnumber\u003e\",\n \"actualInTotal\": \"\u003cnumber\u003e\",\n \"actualInTotalTax\": \"\u003cnumber\u003e\",\n \"actualOutLabour\": \"\u003cnumber\u003e\",\n \"actualProfit\": \"\u003cnumber\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"contacts\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cstring\u003e\",\n \"createdatetime\": \"\u003cstring\u003e\",\n \"creatorid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"dependenttaskid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"discountRate\": \"\u003cnumber\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScoreId\": \"\u003cinteger\u003e\",\n \"estBillAmount\": \"\u003cnumber\u003e\",\n \"estBillAmountTax\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"impactScoreId\": \"\u003cinteger\u003e\",\n \"importanceScoreId\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inTaxRate\": \"\u003cnumber\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoicedAmount\": \"\u003cnumber\u003e\",\n \"invoicedAmountTax\": \"\u003cnumber\u003e\",\n \"invoiceitemid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"isDiscountPercent\": \"\u003cboolean\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"manualPercentageComplete\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"number\": \"\u003cinteger\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outTaxRate\": \"\u003cnumber\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"paidAmount\": \"\u003cnumber\u003e\",\n \"paidAmountTax\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"phasename\": \"\u003cstring\u003e\",\n \"prerequisiteid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedBillAmount\": \"\u003cnumber\u003e\",\n \"projectedBillAmountTax\": \"\u003cnumber\u003e\",\n \"projectedGrossMargin\": \"\u003cnumber\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"projectedOutLabour\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"projectedTimeManual\": \"\u003cnumber\u003e\",\n \"projectedTimeSpent\": \"\u003cnumber\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"quoteitemid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cinteger\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tags\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"uniquetoken\": \"\u003cstring\u003e\",\n \"urgencyScoreId\": \"\u003cinteger\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "047a0def-1763-48b5-8cae-979c587b706b", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: title, code, number, description, status, priority, percentcomplete, position, project, company, dates, time, billable, workstageid, parentid, phasename, assignedto, tags, lastmodified, all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "title,status,priority" }, { "description": { "content": "Search by name or code. Use ! prefix for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by status (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "active" }, { "description": { "content": "Filter by priority (1=Very High to 5=Very Low)", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Contact IDs assigned to item, or 'me'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Mode for contacts filter (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Tag ID or list of Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Items modified on or after this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Items modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Items with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Items with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,title,code,priority,startdate,duedate,completedate,status,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "title" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8a186634-e762-40a1-a155-bbf10acbb425", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: title, code, number, description, status, priority, percentcomplete, position, project, company, dates, time, billable, workstageid, parentid, phasename, assignedto, tags, lastmodified, all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "title,status,priority" }, { "description": { "content": "Search by name or code. Use ! prefix for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by status (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "active" }, { "description": { "content": "Filter by priority (1=Very High to 5=Very Low)", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Contact IDs assigned to item, or 'me'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Mode for contacts filter (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Tag ID or list of Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Items modified on or after this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Items modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Items with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Items with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,title,code,priority,startdate,duedate,completedate,status,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "title" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5ef45160-e6a8-4235-abd9-c4123027af53", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: title, code, number, description, status, priority, percentcomplete, position, project, company, dates, time, billable, workstageid, parentid, phasename, assignedto, tags, lastmodified, all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "title,status,priority" }, { "description": { "content": "Search by name or code. Use ! prefix for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by status (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "active" }, { "description": { "content": "Filter by priority (1=Very High to 5=Very Low)", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Contact IDs assigned to item, or 'me'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Mode for contacts filter (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Tag ID or list of Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Items modified on or after this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Items modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Items with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Items with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,title,code,priority,startdate,duedate,completedate,status,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "title" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "873c6c59-45d7-45ba-aeb8-a7d83f1118d0", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: title, code, number, description, status, priority, percentcomplete, position, project, company, dates, time, billable, workstageid, parentid, phasename, assignedto, tags, lastmodified, all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "title,status,priority" }, { "description": { "content": "Search by name or code. Use ! prefix for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by status (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "active" }, { "description": { "content": "Filter by priority (1=Very High to 5=Very Low)", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Contact IDs assigned to item, or 'me'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Mode for contacts filter (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Tag ID or list of Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Items modified on or after this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Items modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Items with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Items with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,title,code,priority,startdate,duedate,completedate,status,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "title" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "eb0142c5-3842-4403-b1ad-dc98006dc869", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: title, code, number, description, status, priority, percentcomplete, position, project, company, dates, time, billable, workstageid, parentid, phasename, assignedto, tags, lastmodified, all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "title,status,priority" }, { "description": { "content": "Search by name or code. Use ! prefix for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by status (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "active" }, { "description": { "content": "Filter by priority (1=Very High to 5=Very Low)", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Contact IDs assigned to item, or 'me'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Mode for contacts filter (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Tag ID or list of Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Items modified on or after this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Items modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Items with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Items with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,title,code,priority,startdate,duedate,completedate,status,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "title" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "77ddab89-a376-4926-a9a7-ccc708f03b38", "name": "/companies/:companyid/locations", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns the locations belonging to the specified Company.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/companies/:companyid/locations", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "locations" ], "query": [ { "description": { "content": "Comma-separated fields to return (or 'all')", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,companyid" }, { "description": { "content": "Search by name. Prefix with ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by active status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "active", "value": "true" }, { "description": { "content": "Locations modified on or after this date (UTC). ISO8601 or relative (12h, 5d)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Locations modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,code)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"active\": \"\u003cboolean\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"countryid\": \"\u003cinteger\u003e\",\n \"deliveryinstructions\": \"\u003cstring\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"formattedaddress\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"latitude\": \"\u003cnumber\u003e\",\n \"longitude\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"phone2\": \"\u003cstring\u003e\",\n \"placeid\": \"\u003cstring\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"suburb\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n },\n {\n \"active\": \"\u003cboolean\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"countryid\": \"\u003cinteger\u003e\",\n \"deliveryinstructions\": \"\u003cstring\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"formattedaddress\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"latitude\": \"\u003cnumber\u003e\",\n \"longitude\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"phone2\": \"\u003cstring\u003e\",\n \"placeid\": \"\u003cstring\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"suburb\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "42a4bbaa-1eb1-44fa-8e28-8b2c6f1a19ad", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "locations" ], "query": [ { "description": { "content": "Comma-separated fields to return (or 'all')", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,companyid" }, { "description": { "content": "Search by name. Prefix with ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by active status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "active", "value": "true" }, { "description": { "content": "Locations modified on or after this date (UTC). ISO8601 or relative (12h, 5d)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Locations modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,code)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ccfc345d-f2e7-48fe-81e8-8bdb8d172ae5", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "locations" ], "query": [ { "description": { "content": "Comma-separated fields to return (or 'all')", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,companyid" }, { "description": { "content": "Search by name. Prefix with ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by active status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "active", "value": "true" }, { "description": { "content": "Locations modified on or after this date (UTC). ISO8601 or relative (12h, 5d)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Locations modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,code)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ed587b66-a31c-48df-b328-8682e994ebff", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "locations" ], "query": [ { "description": { "content": "Comma-separated fields to return (or 'all')", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,companyid" }, { "description": { "content": "Search by name. Prefix with ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by active status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "active", "value": "true" }, { "description": { "content": "Locations modified on or after this date (UTC). ISO8601 or relative (12h, 5d)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Locations modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,code)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7f0f88d6-4268-4df4-a09b-1f6fa7b453cb", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "locations" ], "query": [ { "description": { "content": "Comma-separated fields to return (or 'all')", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,companyid" }, { "description": { "content": "Search by name. Prefix with ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by active status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "active", "value": "true" }, { "description": { "content": "Locations modified on or after this date (UTC). ISO8601 or relative (12h, 5d)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Locations modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,code)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "b45ae4d0-5035-4546-b758-e23f2a3bf1ae", "name": "/companies/:companyid/locations", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"active\": \"\u003cboolean\u003e\",\n \"addressLine1\": \"\u003cstring\u003e\",\n \"addressLine2\": \"\u003cstring\u003e\",\n \"addressLine3\": \"\u003cstring\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"countryid\": \"\u003cinteger\u003e\",\n \"deliveryInstructions\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"formattedAddress\": \"\u003cstring\u003e\",\n \"latitude\": \"\u003cnumber\u003e\",\n \"longitude\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"phone2\": \"\u003cstring\u003e\",\n \"placeid\": \"\u003cstring\u003e\",\n \"stateRegion\": \"\u003cstring\u003e\",\n \"suburb\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Creates a new location and associates it with the specified Company.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/companies/:companyid/locations", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "locations" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "81936be9-d202-4716-8ad3-d1e195965e0f", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"active\": \"\u003cboolean\u003e\",\n \"addressLine1\": \"\u003cstring\u003e\",\n \"addressLine2\": \"\u003cstring\u003e\",\n \"addressLine3\": \"\u003cstring\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"countryid\": \"\u003cinteger\u003e\",\n \"deliveryInstructions\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"formattedAddress\": \"\u003cstring\u003e\",\n \"latitude\": \"\u003cnumber\u003e\",\n \"longitude\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"phone2\": \"\u003cstring\u003e\",\n \"placeid\": \"\u003cstring\u003e\",\n \"stateRegion\": \"\u003cstring\u003e\",\n \"suburb\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "locations" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5a843adb-6bf7-4606-b767-cde1c071bb17", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"active\": \"\u003cboolean\u003e\",\n \"addressLine1\": \"\u003cstring\u003e\",\n \"addressLine2\": \"\u003cstring\u003e\",\n \"addressLine3\": \"\u003cstring\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"countryid\": \"\u003cinteger\u003e\",\n \"deliveryInstructions\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"formattedAddress\": \"\u003cstring\u003e\",\n \"latitude\": \"\u003cnumber\u003e\",\n \"longitude\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"phone2\": \"\u003cstring\u003e\",\n \"placeid\": \"\u003cstring\u003e\",\n \"stateRegion\": \"\u003cstring\u003e\",\n \"suburb\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "locations" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f9cba5ae-f92c-4f17-80b8-28bf0c39a6a1", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"active\": \"\u003cboolean\u003e\",\n \"addressLine1\": \"\u003cstring\u003e\",\n \"addressLine2\": \"\u003cstring\u003e\",\n \"addressLine3\": \"\u003cstring\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"countryid\": \"\u003cinteger\u003e\",\n \"deliveryInstructions\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"formattedAddress\": \"\u003cstring\u003e\",\n \"latitude\": \"\u003cnumber\u003e\",\n \"longitude\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"phone2\": \"\u003cstring\u003e\",\n \"placeid\": \"\u003cstring\u003e\",\n \"stateRegion\": \"\u003cstring\u003e\",\n \"suburb\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "locations" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f2ac2384-120e-45bb-be86-48cce468f78f", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"active\": \"\u003cboolean\u003e\",\n \"addressLine1\": \"\u003cstring\u003e\",\n \"addressLine2\": \"\u003cstring\u003e\",\n \"addressLine3\": \"\u003cstring\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"countryid\": \"\u003cinteger\u003e\",\n \"deliveryInstructions\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"formattedAddress\": \"\u003cstring\u003e\",\n \"latitude\": \"\u003cnumber\u003e\",\n \"longitude\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"phone2\": \"\u003cstring\u003e\",\n \"placeid\": \"\u003cstring\u003e\",\n \"stateRegion\": \"\u003cstring\u003e\",\n \"suburb\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "locations" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] }, { "event": [], "id": "d6b54f68-6490-47bf-afea-b75e1909d7de", "name": "/companies/:companyid/locations/:locationid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a single location belonging to the specified Company.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/companies/:companyid/locations/:locationid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "locations", ":locationid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Company Location ID", "type": "text/plain" }, "disabled": false, "key": "locationid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"active\": \"\u003cboolean\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"countryid\": \"\u003cinteger\u003e\",\n \"deliveryinstructions\": \"\u003cstring\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"formattedaddress\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"latitude\": \"\u003cnumber\u003e\",\n \"longitude\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"phone2\": \"\u003cstring\u003e\",\n \"placeid\": \"\u003cstring\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"suburb\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "0fd31a8e-37fa-43f8-a44a-3ca60f9d4b04", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "locations", ":locationid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Company Location ID", "type": "text/plain" }, "disabled": false, "key": "locationid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "429d07df-712d-4063-bf52-94e515b1e538", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "locations", ":locationid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Company Location ID", "type": "text/plain" }, "disabled": false, "key": "locationid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "85e41da9-5411-4ffc-a977-72ed4d70e497", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "locations", ":locationid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Company Location ID", "type": "text/plain" }, "disabled": false, "key": "locationid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "bfb54820-a30a-4f3c-927e-3604714611d3", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "locations", ":locationid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Company Location ID", "type": "text/plain" }, "disabled": false, "key": "locationid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "af655cc5-1962-4c87-ad1e-e5fe99bbd04b", "name": "/companies/:companyid/locations/:locationid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"active\": \"\u003cboolean\u003e\",\n \"addressLine1\": \"\u003cstring\u003e\",\n \"addressLine2\": \"\u003cstring\u003e\",\n \"addressLine3\": \"\u003cstring\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"countryid\": \"\u003cinteger\u003e\",\n \"deliveryInstructions\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"formattedAddress\": \"\u003cstring\u003e\",\n \"latitude\": \"\u003cnumber\u003e\",\n \"longitude\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"phone2\": \"\u003cstring\u003e\",\n \"placeid\": \"\u003cstring\u003e\",\n \"stateRegion\": \"\u003cstring\u003e\",\n \"suburb\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Updates an existing location belonging to the specified Company.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/companies/:companyid/locations/:locationid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "locations", ":locationid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Company Location ID", "type": "text/plain" }, "disabled": false, "key": "locationid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "abacce1e-c4dc-4134-add1-69ca8794438e", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"active\": \"\u003cboolean\u003e\",\n \"addressLine1\": \"\u003cstring\u003e\",\n \"addressLine2\": \"\u003cstring\u003e\",\n \"addressLine3\": \"\u003cstring\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"countryid\": \"\u003cinteger\u003e\",\n \"deliveryInstructions\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"formattedAddress\": \"\u003cstring\u003e\",\n \"latitude\": \"\u003cnumber\u003e\",\n \"longitude\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"phone2\": \"\u003cstring\u003e\",\n \"placeid\": \"\u003cstring\u003e\",\n \"stateRegion\": \"\u003cstring\u003e\",\n \"suburb\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "locations", ":locationid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Company Location ID", "type": "text/plain" }, "disabled": false, "key": "locationid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7dc496ec-29c5-4dbf-be4a-382942ae59ce", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"active\": \"\u003cboolean\u003e\",\n \"addressLine1\": \"\u003cstring\u003e\",\n \"addressLine2\": \"\u003cstring\u003e\",\n \"addressLine3\": \"\u003cstring\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"countryid\": \"\u003cinteger\u003e\",\n \"deliveryInstructions\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"formattedAddress\": \"\u003cstring\u003e\",\n \"latitude\": \"\u003cnumber\u003e\",\n \"longitude\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"phone2\": \"\u003cstring\u003e\",\n \"placeid\": \"\u003cstring\u003e\",\n \"stateRegion\": \"\u003cstring\u003e\",\n \"suburb\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "locations", ":locationid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Company Location ID", "type": "text/plain" }, "disabled": false, "key": "locationid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e7dd75a9-9900-404a-ae63-30288d32501b", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"active\": \"\u003cboolean\u003e\",\n \"addressLine1\": \"\u003cstring\u003e\",\n \"addressLine2\": \"\u003cstring\u003e\",\n \"addressLine3\": \"\u003cstring\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"countryid\": \"\u003cinteger\u003e\",\n \"deliveryInstructions\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"formattedAddress\": \"\u003cstring\u003e\",\n \"latitude\": \"\u003cnumber\u003e\",\n \"longitude\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"phone2\": \"\u003cstring\u003e\",\n \"placeid\": \"\u003cstring\u003e\",\n \"stateRegion\": \"\u003cstring\u003e\",\n \"suburb\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "locations", ":locationid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Company Location ID", "type": "text/plain" }, "disabled": false, "key": "locationid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3a94f12c-9004-4f1f-b9c4-8d5ae48f9e90", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"active\": \"\u003cboolean\u003e\",\n \"addressLine1\": \"\u003cstring\u003e\",\n \"addressLine2\": \"\u003cstring\u003e\",\n \"addressLine3\": \"\u003cstring\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"countryid\": \"\u003cinteger\u003e\",\n \"deliveryInstructions\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"formattedAddress\": \"\u003cstring\u003e\",\n \"latitude\": \"\u003cnumber\u003e\",\n \"longitude\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"phone2\": \"\u003cstring\u003e\",\n \"placeid\": \"\u003cstring\u003e\",\n \"stateRegion\": \"\u003cstring\u003e\",\n \"suburb\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "locations", ":locationid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Company Location ID", "type": "text/plain" }, "disabled": false, "key": "locationid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "340d74bd-0310-470a-903b-5403fc0d4df9", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"active\": \"\u003cboolean\u003e\",\n \"addressLine1\": \"\u003cstring\u003e\",\n \"addressLine2\": \"\u003cstring\u003e\",\n \"addressLine3\": \"\u003cstring\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"countryid\": \"\u003cinteger\u003e\",\n \"deliveryInstructions\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"formattedAddress\": \"\u003cstring\u003e\",\n \"latitude\": \"\u003cnumber\u003e\",\n \"longitude\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"phone\": \"\u003cstring\u003e\",\n \"phone2\": \"\u003cstring\u003e\",\n \"placeid\": \"\u003cstring\u003e\",\n \"stateRegion\": \"\u003cstring\u003e\",\n \"suburb\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "locations", ":locationid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Company Location ID", "type": "text/plain" }, "disabled": false, "key": "locationid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "02dbcfe5-99d1-4dbf-a2a7-d136b9012bdc", "name": "/companies/:companyid/locations/:locationid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Soft-deletes a location belonging to the specified Company.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/companies/:companyid/locations/:locationid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "locations", ":locationid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Company Location ID", "type": "text/plain" }, "disabled": false, "key": "locationid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "da571550-8bd1-4f4e-af66-56d2b6cbdb18", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "locations", ":locationid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Company Location ID", "type": "text/plain" }, "disabled": false, "key": "locationid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4923c80b-0651-464e-ba1c-02a2f7940f78", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "locations", ":locationid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Company Location ID", "type": "text/plain" }, "disabled": false, "key": "locationid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3d63708e-aac8-482f-a3e4-52ab3baf1521", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "locations", ":locationid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Company Location ID", "type": "text/plain" }, "disabled": false, "key": "locationid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "96d8a84a-b9d0-4562-bf36-5c59eb92af21", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "locations", ":locationid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Company Location ID", "type": "text/plain" }, "disabled": false, "key": "locationid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "db4b7ce8-c0f0-4544-9ed9-c67d002ebffb", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "locations", ":locationid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Company Location ID", "type": "text/plain" }, "disabled": false, "key": "locationid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "5b2fe7c0-5ea7-4027-a42c-91f55d9e2fd1", "name": "/companies/:companyid/notes", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Notes for a Company.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/companies/:companyid/notes", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "notes" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available fields: \n- note - Note content\n- company - Company ID\n- creator - Creator ID and name (shorthand for creatorid + creatorname)\n- creatorid - Creator contact ID\n- creatorname - Creator full name\n- datecreated - Date created\n- lastmodifiedutc - Last modified date (UTC)", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "note,creator,datecreated" }, { "description": { "content": "Search note content. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Notes modified on or after this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Notes modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,datecreated)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "datecreated" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "desc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"companyid\": \"\u003cinteger\u003e\",\n \"creatorid\": \"\u003cinteger\u003e\",\n \"creatorname\": \"\u003cstring\u003e\",\n \"datecreated\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"note\": \"\u003cstring\u003e\"\n },\n {\n \"companyid\": \"\u003cinteger\u003e\",\n \"creatorid\": \"\u003cinteger\u003e\",\n \"creatorname\": \"\u003cstring\u003e\",\n \"datecreated\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"note\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e035d4ff-3ccf-43f9-951c-3f4e3bd565cb", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "notes" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available fields: \n- note - Note content\n- company - Company ID\n- creator - Creator ID and name (shorthand for creatorid + creatorname)\n- creatorid - Creator contact ID\n- creatorname - Creator full name\n- datecreated - Date created\n- lastmodifiedutc - Last modified date (UTC)", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "note,creator,datecreated" }, { "description": { "content": "Search note content. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Notes modified on or after this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Notes modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,datecreated)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "datecreated" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "desc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d9ffb931-0ea4-4bd2-bbd2-4cea89690381", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "notes" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available fields: \n- note - Note content\n- company - Company ID\n- creator - Creator ID and name (shorthand for creatorid + creatorname)\n- creatorid - Creator contact ID\n- creatorname - Creator full name\n- datecreated - Date created\n- lastmodifiedutc - Last modified date (UTC)", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "note,creator,datecreated" }, { "description": { "content": "Search note content. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Notes modified on or after this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Notes modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,datecreated)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "datecreated" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "desc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2813f624-7c81-44a1-80c2-15a99ca4cce8", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "notes" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available fields: \n- note - Note content\n- company - Company ID\n- creator - Creator ID and name (shorthand for creatorid + creatorname)\n- creatorid - Creator contact ID\n- creatorname - Creator full name\n- datecreated - Date created\n- lastmodifiedutc - Last modified date (UTC)", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "note,creator,datecreated" }, { "description": { "content": "Search note content. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Notes modified on or after this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Notes modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,datecreated)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "datecreated" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "desc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2ba0d39a-25cb-4ba4-8663-b691236d8b9b", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "notes" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available fields: \n- note - Note content\n- company - Company ID\n- creator - Creator ID and name (shorthand for creatorid + creatorname)\n- creatorid - Creator contact ID\n- creatorname - Creator full name\n- datecreated - Date created\n- lastmodifiedutc - Last modified date (UTC)", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "note,creator,datecreated" }, { "description": { "content": "Search note content. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Notes modified on or after this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Notes modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,datecreated)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "datecreated" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "desc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] }, { "event": [], "id": "d4b791ac-a620-48d9-a5ac-3e95a9053607", "name": "/companies/:companyid/notes", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"note\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Creates one or more Notes for a specified Company.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/companies/:companyid/notes", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "notes" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c3c868f1-e749-4fd8-98da-41dbfbc043d4", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"note\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "notes" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9b4739c0-c5ae-4624-b0ec-3e92bfca1e85", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"note\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "notes" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5ac5d571-510c-46b4-83d3-36f6c63fd486", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"note\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "notes" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "affc7138-6737-40bf-87c9-299275934503", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"note\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "notes" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3ba61c7a-d1f1-4ad2-900d-49a4c998ca27", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"note\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "notes" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "363abf91-3905-4bdc-9ea4-34172fd63ff2", "name": "/companies/:companyid/notes/:noteid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a single Note for a Company by ID.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/companies/:companyid/notes/:noteid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "notes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"companyid\": \"\u003cinteger\u003e\",\n \"creatorid\": \"\u003cinteger\u003e\",\n \"creatorname\": \"\u003cstring\u003e\",\n \"datecreated\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"note\": \"\u003cstring\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5f8fc0a3-4d0d-4462-a3c2-7fab08ba65fc", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "notes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b89fb4a3-e321-45ed-a7e3-b5402eaefd0e", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "notes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d56b8edc-61fb-4900-b903-13a0e38fe404", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "notes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "076483e6-e455-45fc-b93a-8e2654b62bf7", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "notes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "eab7c5f7-6e64-464c-ad8f-67fb879f91f1", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "notes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "85319ec9-6f21-4902-a0bb-ecb138da08b1", "name": "/companies/:companyid/notes/:noteid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"note\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Updates a Company Note.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/companies/:companyid/notes/:noteid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "notes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e93d3869-31f8-45f7-8dac-ab72d2b05198", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"note\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "notes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "954f8309-339b-4166-847b-6f04703cabfc", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"note\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "notes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a1af5e2d-acdf-46ea-bb46-c05689f0331d", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"note\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "notes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "fc92849d-9c60-4e12-8612-2c083b0f55cd", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"note\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "notes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7805bf7d-8f39-42c4-9d8c-3213c5e52531", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"note\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "notes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "d76245e1-a235-4465-837f-c75f9c6ded05", "name": "/companies/:companyid/notes/:noteid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Soft deletes a Company Note.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/companies/:companyid/notes/:noteid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "notes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ad14f839-0644-4501-8c8e-e84339aba8e2", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "notes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f744225a-8fe3-49f5-bc6e-e747f0a72ae4", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "notes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "0eeea50d-31dd-4567-87ae-e09d1ef87d54", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "notes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "38f34cf6-2884-4730-980a-e839c184d51d", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "notes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b002cebf-6c59-4e67-8a42-017818f7f6b9", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "notes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "01666149-9391-400a-94fd-9479ac8ff0ff", "name": "/companies/:companyid/projects", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Projects for the specified Company. Supports the same filters as GET /projects, scoped to the given company.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/companies/:companyid/projects", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "projects" ], "query": [ { "description": { "content": "Comma-separated fields to return", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "title,number,company,startdate,duedate" }, { "description": { "content": "Search by number or title. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by project number. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Project status (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "deleted" }, { "description": { "content": "Manager Contact IDs (comma-separated). Use ! for negation, or 'me'/'all'", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Contact IDs (comma-separated). Use ! for negation, or 'me'/'all'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts filter mode (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Team IDs (comma-separated, Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "teamid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group IDs (comma-separated, Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Priority values 1-5 (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Workstage IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Start date from (yyyy-mm-dd or relative: +/-Xd/w/m/y)", "type": "text/plain" }, "disabled": true, "key": "startdatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Start date to (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "startdateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date to (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Complete date from (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "completedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Complete date to (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "completedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified from in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified to in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter projects with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter projects with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,startdate,duedate,completedate,companyname,categoryname,priority)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"actualInLabour\": \"\u003cnumber\u003e\",\n \"actualInTotal\": \"\u003cnumber\u003e\",\n \"actualInTotalTax\": \"\u003cnumber\u003e\",\n \"actualOutLabour\": \"\u003cnumber\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billtotal\": \"\u003cnumber\u003e\",\n \"bookmarks\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"url\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"url\": \"\u003cstring\u003e\"\n }\n ],\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"burn\": \"\u003cnumber\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"categoryname\": \"\u003cstring\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"clients\": [\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"clienttype\": \"\u003cstring\u003e\",\n \"clientviewalltasks\": \"\u003cboolean\u003e\",\n \"clientviewtime\": \"\u003cboolean\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"contractorid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"contractors\": [\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"createdate\": \"\u003cstring\u003e\",\n \"customfieldoptionid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"customfields\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"value\": \"\u003cstring\u003e\",\n \"valuename\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"value\": \"\u003cstring\u003e\",\n \"valuename\": \"\u003cstring\u003e\"\n }\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"estBillAmount\": \"\u003cnumber\u003e\",\n \"estBillAmountTax\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"files\": [\n {\n \"description\": \"\u003cstring\u003e\",\n \"folderid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"modified\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"uniquetoken\": \"\u003cstring\u003e\"\n },\n {\n \"description\": \"\u003cstring\u003e\",\n \"folderid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"modified\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"uniquetoken\": \"\u003cstring\u003e\"\n }\n ],\n \"folders\": [\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"modified\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"modified\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"groupid\": \"\u003cinteger\u003e\",\n \"groupname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"internalclientcontactid\": \"\u003cinteger\u003e\",\n \"internalclientgroupid\": \"\u003cinteger\u003e\",\n \"internalclientgroupname\": \"\u003cstring\u003e\",\n \"internalclientteamid\": \"\u003cinteger\u003e\",\n \"internalclientteamname\": \"\u003cstring\u003e\",\n \"invoiced\": \"\u003cboolean\u003e\",\n \"invoicedAmount\": \"\u003cnumber\u003e\",\n \"invoicedAmountTax\": \"\u003cnumber\u003e\",\n \"invoices\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoicedate\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"paid\": \"\u003cboolean\u003e\",\n \"paiddate\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoicedate\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"paid\": \"\u003cboolean\u003e\",\n \"paiddate\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\"\n }\n ],\n \"invoicetotal\": \"\u003cnumber\u003e\",\n \"itemDueDate\": \"\u003cstring\u003e\",\n \"itemStartDate\": \"\u003cstring\u003e\",\n \"itemsActive\": \"\u003cinteger\u003e\",\n \"itemsCompleted\": \"\u003cinteger\u003e\",\n \"itemsDiscount\": \"\u003cnumber\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"managerfirstname\": \"\u003cstring\u003e\",\n \"managerid\": \"\u003cinteger\u003e\",\n \"managerlastname\": \"\u003cstring\u003e\",\n \"messages\": [\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"replycount\": \"\u003cinteger\u003e\",\n \"senddate\": \"\u003cstring\u003e\",\n \"senderid\": \"\u003cinteger\u003e\",\n \"shortdetails\": \"\u003cstring\u003e\",\n \"subject\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"replycount\": \"\u003cinteger\u003e\",\n \"senddate\": \"\u003cstring\u003e\",\n \"senderid\": \"\u003cinteger\u003e\",\n \"shortdetails\": \"\u003cstring\u003e\",\n \"subject\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"notification\": \"\u003cboolean\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"paid\": \"\u003cboolean\u003e\",\n \"paidAmountTax\": \"\u003cnumber\u003e\",\n \"paidamount\": \"\u003cnumber\u003e\",\n \"percentcomplete\": \"\u003cinteger\u003e\",\n \"phases\": [\n {\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n }\n ],\n \"name\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n },\n {\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n }\n ],\n \"name\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n }\n ],\n \"priority\": \"\u003cinteger\u003e\",\n \"privatenotes\": \"\u003cstring\u003e\",\n \"projectedBillAmount\": \"\u003cnumber\u003e\",\n \"projectedBillAmountTax\": \"\u003cnumber\u003e\",\n \"projectedGrossMargin\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"projectedTimeManual\": \"\u003cnumber\u003e\",\n \"projectedTimeSpent\": \"\u003cnumber\u003e\",\n \"projectnotes\": [\n {\n \"content\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n },\n {\n \"content\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n }\n ],\n \"purchaseorder\": \"\u003cstring\u003e\",\n \"staff\": [\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"staffid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"staffviewalltasks\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cnumber\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tags\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"teamid\": \"\u003cinteger\u003e\",\n \"teamname\": \"\u003cstring\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\",\n \"timerecords\": [\n {\n \"accountedfor\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"endtime\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"notes\": \"\u003cstring\u003e\",\n \"running\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n },\n {\n \"accountedfor\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"endtime\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"notes\": \"\u003cstring\u003e\",\n \"running\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n }\n ],\n \"timetracked\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\",\n \"workstagename\": \"\u003cstring\u003e\",\n \"workstages\": [\n {\n \"active\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"setdatetime\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\"\n },\n {\n \"active\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"setdatetime\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\"\n }\n ]\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"actualInLabour\": \"\u003cnumber\u003e\",\n \"actualInTotal\": \"\u003cnumber\u003e\",\n \"actualInTotalTax\": \"\u003cnumber\u003e\",\n \"actualOutLabour\": \"\u003cnumber\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billtotal\": \"\u003cnumber\u003e\",\n \"bookmarks\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"url\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"url\": \"\u003cstring\u003e\"\n }\n ],\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"burn\": \"\u003cnumber\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"categoryname\": \"\u003cstring\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"clients\": [\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"clienttype\": \"\u003cstring\u003e\",\n \"clientviewalltasks\": \"\u003cboolean\u003e\",\n \"clientviewtime\": \"\u003cboolean\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"contractorid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"contractors\": [\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"createdate\": \"\u003cstring\u003e\",\n \"customfieldoptionid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"customfields\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"value\": \"\u003cstring\u003e\",\n \"valuename\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"value\": \"\u003cstring\u003e\",\n \"valuename\": \"\u003cstring\u003e\"\n }\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"estBillAmount\": \"\u003cnumber\u003e\",\n \"estBillAmountTax\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"files\": [\n {\n \"description\": \"\u003cstring\u003e\",\n \"folderid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"modified\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"uniquetoken\": \"\u003cstring\u003e\"\n },\n {\n \"description\": \"\u003cstring\u003e\",\n \"folderid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"modified\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"uniquetoken\": \"\u003cstring\u003e\"\n }\n ],\n \"folders\": [\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"modified\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"modified\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"groupid\": \"\u003cinteger\u003e\",\n \"groupname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"internalclientcontactid\": \"\u003cinteger\u003e\",\n \"internalclientgroupid\": \"\u003cinteger\u003e\",\n \"internalclientgroupname\": \"\u003cstring\u003e\",\n \"internalclientteamid\": \"\u003cinteger\u003e\",\n \"internalclientteamname\": \"\u003cstring\u003e\",\n \"invoiced\": \"\u003cboolean\u003e\",\n \"invoicedAmount\": \"\u003cnumber\u003e\",\n \"invoicedAmountTax\": \"\u003cnumber\u003e\",\n \"invoices\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoicedate\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"paid\": \"\u003cboolean\u003e\",\n \"paiddate\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoicedate\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"paid\": \"\u003cboolean\u003e\",\n \"paiddate\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\"\n }\n ],\n \"invoicetotal\": \"\u003cnumber\u003e\",\n \"itemDueDate\": \"\u003cstring\u003e\",\n \"itemStartDate\": \"\u003cstring\u003e\",\n \"itemsActive\": \"\u003cinteger\u003e\",\n \"itemsCompleted\": \"\u003cinteger\u003e\",\n \"itemsDiscount\": \"\u003cnumber\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"managerfirstname\": \"\u003cstring\u003e\",\n \"managerid\": \"\u003cinteger\u003e\",\n \"managerlastname\": \"\u003cstring\u003e\",\n \"messages\": [\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"replycount\": \"\u003cinteger\u003e\",\n \"senddate\": \"\u003cstring\u003e\",\n \"senderid\": \"\u003cinteger\u003e\",\n \"shortdetails\": \"\u003cstring\u003e\",\n \"subject\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"replycount\": \"\u003cinteger\u003e\",\n \"senddate\": \"\u003cstring\u003e\",\n \"senderid\": \"\u003cinteger\u003e\",\n \"shortdetails\": \"\u003cstring\u003e\",\n \"subject\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"notification\": \"\u003cboolean\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"paid\": \"\u003cboolean\u003e\",\n \"paidAmountTax\": \"\u003cnumber\u003e\",\n \"paidamount\": \"\u003cnumber\u003e\",\n \"percentcomplete\": \"\u003cinteger\u003e\",\n \"phases\": [\n {\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n }\n ],\n \"name\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n },\n {\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n }\n ],\n \"name\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n }\n ],\n \"priority\": \"\u003cinteger\u003e\",\n \"privatenotes\": \"\u003cstring\u003e\",\n \"projectedBillAmount\": \"\u003cnumber\u003e\",\n \"projectedBillAmountTax\": \"\u003cnumber\u003e\",\n \"projectedGrossMargin\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"projectedTimeManual\": \"\u003cnumber\u003e\",\n \"projectedTimeSpent\": \"\u003cnumber\u003e\",\n \"projectnotes\": [\n {\n \"content\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n },\n {\n \"content\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n }\n ],\n \"purchaseorder\": \"\u003cstring\u003e\",\n \"staff\": [\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"staffid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"staffviewalltasks\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cnumber\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tags\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"teamid\": \"\u003cinteger\u003e\",\n \"teamname\": \"\u003cstring\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\",\n \"timerecords\": [\n {\n \"accountedfor\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"endtime\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"notes\": \"\u003cstring\u003e\",\n \"running\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n },\n {\n \"accountedfor\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"endtime\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"notes\": \"\u003cstring\u003e\",\n \"running\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n }\n ],\n \"timetracked\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\",\n \"workstagename\": \"\u003cstring\u003e\",\n \"workstages\": [\n {\n \"active\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"setdatetime\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\"\n },\n {\n \"active\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"setdatetime\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\"\n }\n ]\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c4c2fcc7-3b66-47fd-977d-d39be62a3f9b", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "projects" ], "query": [ { "description": { "content": "Comma-separated fields to return", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "title,number,company,startdate,duedate" }, { "description": { "content": "Search by number or title. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by project number. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Project status (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "deleted" }, { "description": { "content": "Manager Contact IDs (comma-separated). Use ! for negation, or 'me'/'all'", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Contact IDs (comma-separated). Use ! for negation, or 'me'/'all'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts filter mode (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Team IDs (comma-separated, Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "teamid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group IDs (comma-separated, Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Priority values 1-5 (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Workstage IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Start date from (yyyy-mm-dd or relative: +/-Xd/w/m/y)", "type": "text/plain" }, "disabled": true, "key": "startdatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Start date to (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "startdateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date to (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Complete date from (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "completedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Complete date to (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "completedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified from in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified to in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter projects with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter projects with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,startdate,duedate,completedate,companyname,categoryname,priority)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8bffb211-6bee-4b2f-b5e9-632a3d15590a", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "projects" ], "query": [ { "description": { "content": "Comma-separated fields to return", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "title,number,company,startdate,duedate" }, { "description": { "content": "Search by number or title. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by project number. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Project status (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "deleted" }, { "description": { "content": "Manager Contact IDs (comma-separated). Use ! for negation, or 'me'/'all'", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Contact IDs (comma-separated). Use ! for negation, or 'me'/'all'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts filter mode (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Team IDs (comma-separated, Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "teamid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group IDs (comma-separated, Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Priority values 1-5 (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Workstage IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Start date from (yyyy-mm-dd or relative: +/-Xd/w/m/y)", "type": "text/plain" }, "disabled": true, "key": "startdatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Start date to (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "startdateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date to (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Complete date from (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "completedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Complete date to (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "completedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified from in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified to in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter projects with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter projects with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,startdate,duedate,completedate,companyname,categoryname,priority)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "76166cd1-2d8a-4aef-b60d-8512cd2753f6", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "projects" ], "query": [ { "description": { "content": "Comma-separated fields to return", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "title,number,company,startdate,duedate" }, { "description": { "content": "Search by number or title. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by project number. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Project status (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "deleted" }, { "description": { "content": "Manager Contact IDs (comma-separated). Use ! for negation, or 'me'/'all'", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Contact IDs (comma-separated). Use ! for negation, or 'me'/'all'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts filter mode (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Team IDs (comma-separated, Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "teamid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group IDs (comma-separated, Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Priority values 1-5 (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Workstage IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Start date from (yyyy-mm-dd or relative: +/-Xd/w/m/y)", "type": "text/plain" }, "disabled": true, "key": "startdatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Start date to (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "startdateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date to (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Complete date from (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "completedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Complete date to (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "completedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified from in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified to in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter projects with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter projects with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,startdate,duedate,completedate,companyname,categoryname,priority)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "73088538-1347-4db7-b11b-84f5beb93d1b", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "projects" ], "query": [ { "description": { "content": "Comma-separated fields to return", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "title,number,company,startdate,duedate" }, { "description": { "content": "Search by number or title. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by project number. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Project status (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "deleted" }, { "description": { "content": "Manager Contact IDs (comma-separated). Use ! for negation, or 'me'/'all'", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Contact IDs (comma-separated). Use ! for negation, or 'me'/'all'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts filter mode (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Team IDs (comma-separated, Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "teamid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group IDs (comma-separated, Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Priority values 1-5 (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Workstage IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Start date from (yyyy-mm-dd or relative: +/-Xd/w/m/y)", "type": "text/plain" }, "disabled": true, "key": "startdatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Start date to (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "startdateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date to (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Complete date from (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "completedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Complete date to (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "completedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified from in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified to in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter projects with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter projects with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,startdate,duedate,completedate,companyname,categoryname,priority)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] }, { "event": [], "id": "b1436996-7352-445b-92af-2c6f359a57e3", "name": "/companies/:companyid/projects", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"number\": \"\u003cstring\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Creates one or more Projects for a specified Company.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/companies/:companyid/projects", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "projects" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a267eb49-2298-4e6b-8a67-31fb5f7958a3", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"number\": \"\u003cstring\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "projects" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9dc79a3e-eea8-4f44-a36a-7aed8757416d", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"number\": \"\u003cstring\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "projects" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e6efe119-1ae7-4ea5-9cd7-b5b7e2194317", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"number\": \"\u003cstring\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "projects" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "95d90f36-8028-4f23-a98c-3b35ef7c5a7e", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"number\": \"\u003cstring\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "projects" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "657c72e1-ec5d-49aa-a3b6-2413ceddba54", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"number\": \"\u003cstring\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "projects" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "42c96b7d-e895-4ce0-831d-f29be7ae7e47", "name": "/companies/:companyid/quotes", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Quotes for the specified Company. Supports the same filters as GET /quotes, scoped to the given company.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/companies/:companyid/quotes", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "quotes" ], "query": [ { "description": { "content": "Comma-separated fields to return", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "number,title,company,status,totals,quoteddate" }, { "description": { "content": "Search by number or title. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by quote number. Supports ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by quote title. Supports ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchtitle", "value": "\u003cstring\u003e" }, { "description": { "content": "Quote status (This can only be one of pending,sent,accepted,addedtoproject,declined,expired,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "sent" }, { "description": { "content": "Quote type (This can only be one of estimate,quote,all)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "quote" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project manager Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Project category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectcategoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Quoted date from (ISO8601 or relative: 12h, 5d)", "type": "text/plain" }, "disabled": true, "key": "quoteddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Quoted date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "quoteddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Approved date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "approveddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Approved date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "approveddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Valid to date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "validtodatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Valid to date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "validtodateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total minimum", "type": "text/plain" }, "disabled": true, "key": "grandtotalfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total maximum", "type": "text/plain" }, "disabled": true, "key": "grandtotalto", "value": "\u003cstring\u003e" }, { "description": { "content": "Group results by (This can only be one of company,project,status,day,week,month,year)", "type": "text/plain" }, "disabled": true, "key": "subtotals", "value": "status" }, { "description": { "content": "Date field for subtotals grouping (This can only be one of quoted,approved)", "type": "text/plain" }, "disabled": true, "key": "subtotalsdateoption", "value": "approved" }, { "description": { "content": "Last modified from in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified to in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter quotes with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter quotes with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Quote IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,quoteddate,validtodate,companyname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"approveddate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"clientcontactname\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"customfieldname\": \"\u003cstring\u003e\",\n \"customfieldvalue\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"emaileddate\": \"\u003cstring\u003e\",\n \"emailedto\": \"\u003cstring\u003e\",\n \"emailedtoclient\": \"\u003cboolean\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"pagetitle\": \"\u003cstring\u003e\",\n \"phases\": [\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\"\n }\n ],\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n },\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\"\n }\n ],\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n }\n ],\n \"projectid\": \"\u003cinteger\u003e\",\n \"quotedate\": \"\u003cstring\u003e\",\n \"quotedby\": \"\u003cstring\u003e\",\n \"showcostbreakdown\": \"\u003cboolean\u003e\",\n \"showitemdescription\": \"\u003cboolean\u003e\",\n \"showphases\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"taxable\": \"\u003cboolean\u003e\",\n \"taxrate\": \"\u003cnumber\u003e\",\n \"taxtotal\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"validdate\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n },\n {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"approveddate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"clientcontactname\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"customfieldname\": \"\u003cstring\u003e\",\n \"customfieldvalue\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"emaileddate\": \"\u003cstring\u003e\",\n \"emailedto\": \"\u003cstring\u003e\",\n \"emailedtoclient\": \"\u003cboolean\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"pagetitle\": \"\u003cstring\u003e\",\n \"phases\": [\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\"\n }\n ],\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n },\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\"\n }\n ],\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n }\n ],\n \"projectid\": \"\u003cinteger\u003e\",\n \"quotedate\": \"\u003cstring\u003e\",\n \"quotedby\": \"\u003cstring\u003e\",\n \"showcostbreakdown\": \"\u003cboolean\u003e\",\n \"showitemdescription\": \"\u003cboolean\u003e\",\n \"showphases\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"taxable\": \"\u003cboolean\u003e\",\n \"taxrate\": \"\u003cnumber\u003e\",\n \"taxtotal\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"validdate\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ba3868eb-d2c2-4f25-81a2-692dbd4ca418", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "quotes" ], "query": [ { "description": { "content": "Comma-separated fields to return", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "number,title,company,status,totals,quoteddate" }, { "description": { "content": "Search by number or title. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by quote number. Supports ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by quote title. Supports ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchtitle", "value": "\u003cstring\u003e" }, { "description": { "content": "Quote status (This can only be one of pending,sent,accepted,addedtoproject,declined,expired,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "sent" }, { "description": { "content": "Quote type (This can only be one of estimate,quote,all)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "quote" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project manager Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Project category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectcategoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Quoted date from (ISO8601 or relative: 12h, 5d)", "type": "text/plain" }, "disabled": true, "key": "quoteddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Quoted date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "quoteddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Approved date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "approveddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Approved date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "approveddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Valid to date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "validtodatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Valid to date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "validtodateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total minimum", "type": "text/plain" }, "disabled": true, "key": "grandtotalfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total maximum", "type": "text/plain" }, "disabled": true, "key": "grandtotalto", "value": "\u003cstring\u003e" }, { "description": { "content": "Group results by (This can only be one of company,project,status,day,week,month,year)", "type": "text/plain" }, "disabled": true, "key": "subtotals", "value": "status" }, { "description": { "content": "Date field for subtotals grouping (This can only be one of quoted,approved)", "type": "text/plain" }, "disabled": true, "key": "subtotalsdateoption", "value": "approved" }, { "description": { "content": "Last modified from in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified to in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter quotes with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter quotes with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Quote IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,quoteddate,validtodate,companyname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a73f32df-acac-4785-bd6a-1094067dcca0", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "quotes" ], "query": [ { "description": { "content": "Comma-separated fields to return", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "number,title,company,status,totals,quoteddate" }, { "description": { "content": "Search by number or title. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by quote number. Supports ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by quote title. Supports ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchtitle", "value": "\u003cstring\u003e" }, { "description": { "content": "Quote status (This can only be one of pending,sent,accepted,addedtoproject,declined,expired,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "sent" }, { "description": { "content": "Quote type (This can only be one of estimate,quote,all)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "quote" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project manager Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Project category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectcategoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Quoted date from (ISO8601 or relative: 12h, 5d)", "type": "text/plain" }, "disabled": true, "key": "quoteddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Quoted date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "quoteddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Approved date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "approveddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Approved date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "approveddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Valid to date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "validtodatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Valid to date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "validtodateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total minimum", "type": "text/plain" }, "disabled": true, "key": "grandtotalfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total maximum", "type": "text/plain" }, "disabled": true, "key": "grandtotalto", "value": "\u003cstring\u003e" }, { "description": { "content": "Group results by (This can only be one of company,project,status,day,week,month,year)", "type": "text/plain" }, "disabled": true, "key": "subtotals", "value": "status" }, { "description": { "content": "Date field for subtotals grouping (This can only be one of quoted,approved)", "type": "text/plain" }, "disabled": true, "key": "subtotalsdateoption", "value": "approved" }, { "description": { "content": "Last modified from in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified to in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter quotes with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter quotes with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Quote IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,quoteddate,validtodate,companyname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "08f8032d-94e7-4958-ba4a-b470631f8910", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "quotes" ], "query": [ { "description": { "content": "Comma-separated fields to return", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "number,title,company,status,totals,quoteddate" }, { "description": { "content": "Search by number or title. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by quote number. Supports ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by quote title. Supports ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchtitle", "value": "\u003cstring\u003e" }, { "description": { "content": "Quote status (This can only be one of pending,sent,accepted,addedtoproject,declined,expired,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "sent" }, { "description": { "content": "Quote type (This can only be one of estimate,quote,all)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "quote" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project manager Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Project category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectcategoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Quoted date from (ISO8601 or relative: 12h, 5d)", "type": "text/plain" }, "disabled": true, "key": "quoteddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Quoted date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "quoteddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Approved date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "approveddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Approved date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "approveddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Valid to date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "validtodatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Valid to date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "validtodateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total minimum", "type": "text/plain" }, "disabled": true, "key": "grandtotalfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total maximum", "type": "text/plain" }, "disabled": true, "key": "grandtotalto", "value": "\u003cstring\u003e" }, { "description": { "content": "Group results by (This can only be one of company,project,status,day,week,month,year)", "type": "text/plain" }, "disabled": true, "key": "subtotals", "value": "status" }, { "description": { "content": "Date field for subtotals grouping (This can only be one of quoted,approved)", "type": "text/plain" }, "disabled": true, "key": "subtotalsdateoption", "value": "approved" }, { "description": { "content": "Last modified from in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified to in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter quotes with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter quotes with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Quote IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,quoteddate,validtodate,companyname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "60a9d1b2-da8b-4052-ae7d-e80372bdb8a5", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "quotes" ], "query": [ { "description": { "content": "Comma-separated fields to return", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "number,title,company,status,totals,quoteddate" }, { "description": { "content": "Search by number or title. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by quote number. Supports ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by quote title. Supports ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchtitle", "value": "\u003cstring\u003e" }, { "description": { "content": "Quote status (This can only be one of pending,sent,accepted,addedtoproject,declined,expired,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "sent" }, { "description": { "content": "Quote type (This can only be one of estimate,quote,all)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "quote" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project manager Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Project category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectcategoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Quoted date from (ISO8601 or relative: 12h, 5d)", "type": "text/plain" }, "disabled": true, "key": "quoteddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Quoted date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "quoteddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Approved date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "approveddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Approved date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "approveddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Valid to date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "validtodatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Valid to date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "validtodateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total minimum", "type": "text/plain" }, "disabled": true, "key": "grandtotalfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total maximum", "type": "text/plain" }, "disabled": true, "key": "grandtotalto", "value": "\u003cstring\u003e" }, { "description": { "content": "Group results by (This can only be one of company,project,status,day,week,month,year)", "type": "text/plain" }, "disabled": true, "key": "subtotals", "value": "status" }, { "description": { "content": "Date field for subtotals grouping (This can only be one of quoted,approved)", "type": "text/plain" }, "disabled": true, "key": "subtotalsdateoption", "value": "approved" }, { "description": { "content": "Last modified from in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified to in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter quotes with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter quotes with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Quote IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,quoteddate,validtodate,companyname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] }, { "event": [], "id": "881f8408-3dfb-46b1-8cfd-5dc62558e082", "name": "/companies/:companyid/summary", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a summary of Contacts, Invoices, Projects, Quotes and Phases for the specified Company in a single request.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/companies/:companyid/summary", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "summary" ], "query": [ { "description": { "content": "Comma-separated data types to include, or 'all'", "type": "text/plain" }, "disabled": true, "key": "types", "value": "all" }, { "description": { "content": "Return total result count per section (useful with pagination) (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "includetotals", "value": "false" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size per section (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"contacts\": [\n {\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"workphone\": \"\u003cstring\u003e\"\n },\n {\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"workphone\": \"\u003cstring\u003e\"\n }\n ],\n \"invoices\": [\n {\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"taxtotal\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\"\n },\n {\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"taxtotal\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\"\n }\n ],\n \"phases\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\"\n }\n ],\n \"projects\": [\n {\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"title\": \"\u003cstring\u003e\"\n },\n {\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"title\": \"\u003cstring\u003e\"\n }\n ],\n \"quotes\": [\n {\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"taxtotal\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\"\n },\n {\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"taxtotal\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\"\n }\n ],\n \"totals\": {\n \"contacts\": \"\u003cinteger\u003e\",\n \"invoices\": \"\u003cinteger\u003e\",\n \"phases\": \"\u003cinteger\u003e\",\n \"projects\": \"\u003cinteger\u003e\",\n \"quotes\": \"\u003cinteger\u003e\"\n }\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c6e61ffa-bf16-402c-b1d2-2ac979e3262b", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "summary" ], "query": [ { "description": { "content": "Comma-separated data types to include, or 'all'", "type": "text/plain" }, "disabled": true, "key": "types", "value": "all" }, { "description": { "content": "Return total result count per section (useful with pagination) (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "includetotals", "value": "false" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size per section (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8d622382-dc51-47e7-9cf9-e861eab48dc9", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "summary" ], "query": [ { "description": { "content": "Comma-separated data types to include, or 'all'", "type": "text/plain" }, "disabled": true, "key": "types", "value": "all" }, { "description": { "content": "Return total result count per section (useful with pagination) (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "includetotals", "value": "false" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size per section (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c11e6e4d-33da-4559-b2c9-0fbd1365033e", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "summary" ], "query": [ { "description": { "content": "Comma-separated data types to include, or 'all'", "type": "text/plain" }, "disabled": true, "key": "types", "value": "all" }, { "description": { "content": "Return total result count per section (useful with pagination) (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "includetotals", "value": "false" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size per section (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "382a9345-d429-4d01-9f64-777b294cff31", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "summary" ], "query": [ { "description": { "content": "Comma-separated data types to include, or 'all'", "type": "text/plain" }, "disabled": true, "key": "types", "value": "all" }, { "description": { "content": "Return total result count per section (useful with pagination) (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "includetotals", "value": "false" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size per section (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] }, { "event": [], "id": "bc9e60dd-6502-4ee3-8ea8-a9f243dfbac9", "name": "/companies/:companyid/tags", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of tags linked to the specified Company.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/companies/:companyid/tags", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "tags" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available fields: \n- name - Tag name\n- color - Tag color (hex)\n- sortorder - Display sort order\n- lastmodifiedutc - Last modified date (UTC)", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,color" }, { "description": { "content": "Search by tag name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Tags modified on or after this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Tags modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of name,sortorder,lastmodifiedutc)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cinteger\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cinteger\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d3c1e2a2-5a5b-465e-8dcf-87c489903b82", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "tags" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available fields: \n- name - Tag name\n- color - Tag color (hex)\n- sortorder - Display sort order\n- lastmodifiedutc - Last modified date (UTC)", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,color" }, { "description": { "content": "Search by tag name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Tags modified on or after this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Tags modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of name,sortorder,lastmodifiedutc)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "700ed52c-4b18-4c83-8971-9afdf8f530a2", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "tags" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available fields: \n- name - Tag name\n- color - Tag color (hex)\n- sortorder - Display sort order\n- lastmodifiedutc - Last modified date (UTC)", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,color" }, { "description": { "content": "Search by tag name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Tags modified on or after this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Tags modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of name,sortorder,lastmodifiedutc)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c288b7ee-a73a-4f17-9cb7-8f0c97aee8dd", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "tags" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available fields: \n- name - Tag name\n- color - Tag color (hex)\n- sortorder - Display sort order\n- lastmodifiedutc - Last modified date (UTC)", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,color" }, { "description": { "content": "Search by tag name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Tags modified on or after this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Tags modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of name,sortorder,lastmodifiedutc)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "679f10f8-6b33-4589-872b-601449c91a71", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "tags" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available fields: \n- name - Tag name\n- color - Tag color (hex)\n- sortorder - Display sort order\n- lastmodifiedutc - Last modified date (UTC)", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,color" }, { "description": { "content": "Search by tag name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Tags modified on or after this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Tags modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of name,sortorder,lastmodifiedutc)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] }, { "event": [], "id": "8fa24965-4947-4a62-a6ea-e89d78b49130", "name": "/companies/:companyid/tags", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Updates the tags linked to a Company.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/companies/:companyid/tags", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "tags" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3f0ded57-85e2-4e08-8c9e-adba0febcf65", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "tags" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "151e3b66-4422-46c3-bf3f-566972607041", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "tags" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4f811487-02bc-48ef-9101-7ce397c7b8a6", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "tags" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "fa9816fe-80f5-4b96-9856-fb0bd8c8cce9", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "tags" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3c638bd3-e294-462f-8c73-f880aeb9452e", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "tags" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "45940a5d-413e-4e86-a127-214da4c6c665", "name": "/companies/:companyid/time", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Time Records for the specified Company. No default date range is applied — all time for the company is returned unless trackedfrom/trackedto are specified.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/companies/:companyid/time", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "time" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: contact, item, project, company, dates, timetracked, notes, billable, lastmodified", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "contact,item,dates,timetracked" }, { "description": { "content": "Contact filter: contact IDs (comma-separated), 'me', or 'all'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project Category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or after this date. Accepts yyyy-mm-dd or relative: -6d, -1w", "type": "text/plain" }, "disabled": true, "key": "trackedfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or before this date. Accepts yyyy-mm-dd or relative: +0d", "type": "text/plain" }, "disabled": true, "key": "trackedto", "value": "\u003cstring\u003e" }, { "description": { "content": "Billable filter (This can only be one of billable,nonbillable,all)", "type": "text/plain" }, "disabled": true, "key": "billable", "value": "all" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Filter by item activeworkstate (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Search by notes. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchnotes", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by item name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchitem", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or after this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Time Record IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,date,projectid,itemid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"accountedfor\": \"\u003cboolean\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"contactname\": \"\u003cstring\u003e\",\n \"endtime\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"itemname\": \"\u003cstring\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"notes\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeallocationid\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n },\n {\n \"accountedfor\": \"\u003cboolean\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"contactname\": \"\u003cstring\u003e\",\n \"endtime\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"itemname\": \"\u003cstring\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"notes\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeallocationid\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8b1a7748-f71e-4527-b343-8744d0491d1e", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "time" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: contact, item, project, company, dates, timetracked, notes, billable, lastmodified", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "contact,item,dates,timetracked" }, { "description": { "content": "Contact filter: contact IDs (comma-separated), 'me', or 'all'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project Category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or after this date. Accepts yyyy-mm-dd or relative: -6d, -1w", "type": "text/plain" }, "disabled": true, "key": "trackedfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or before this date. Accepts yyyy-mm-dd or relative: +0d", "type": "text/plain" }, "disabled": true, "key": "trackedto", "value": "\u003cstring\u003e" }, { "description": { "content": "Billable filter (This can only be one of billable,nonbillable,all)", "type": "text/plain" }, "disabled": true, "key": "billable", "value": "all" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Filter by item activeworkstate (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Search by notes. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchnotes", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by item name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchitem", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or after this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Time Record IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,date,projectid,itemid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8c3b4531-94b7-42ef-a6e9-3407cf07e076", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "time" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: contact, item, project, company, dates, timetracked, notes, billable, lastmodified", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "contact,item,dates,timetracked" }, { "description": { "content": "Contact filter: contact IDs (comma-separated), 'me', or 'all'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project Category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or after this date. Accepts yyyy-mm-dd or relative: -6d, -1w", "type": "text/plain" }, "disabled": true, "key": "trackedfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or before this date. Accepts yyyy-mm-dd or relative: +0d", "type": "text/plain" }, "disabled": true, "key": "trackedto", "value": "\u003cstring\u003e" }, { "description": { "content": "Billable filter (This can only be one of billable,nonbillable,all)", "type": "text/plain" }, "disabled": true, "key": "billable", "value": "all" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Filter by item activeworkstate (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Search by notes. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchnotes", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by item name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchitem", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or after this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Time Record IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,date,projectid,itemid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e35eac96-3779-4ba2-9727-b76367696fba", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "time" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: contact, item, project, company, dates, timetracked, notes, billable, lastmodified", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "contact,item,dates,timetracked" }, { "description": { "content": "Contact filter: contact IDs (comma-separated), 'me', or 'all'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project Category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or after this date. Accepts yyyy-mm-dd or relative: -6d, -1w", "type": "text/plain" }, "disabled": true, "key": "trackedfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or before this date. Accepts yyyy-mm-dd or relative: +0d", "type": "text/plain" }, "disabled": true, "key": "trackedto", "value": "\u003cstring\u003e" }, { "description": { "content": "Billable filter (This can only be one of billable,nonbillable,all)", "type": "text/plain" }, "disabled": true, "key": "billable", "value": "all" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Filter by item activeworkstate (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Search by notes. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchnotes", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by item name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchitem", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or after this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Time Record IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,date,projectid,itemid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "07819961-e124-44f6-9099-ce2bdff1ee11", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "time" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: contact, item, project, company, dates, timetracked, notes, billable, lastmodified", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "contact,item,dates,timetracked" }, { "description": { "content": "Contact filter: contact IDs (comma-separated), 'me', or 'all'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project Category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or after this date. Accepts yyyy-mm-dd or relative: -6d, -1w", "type": "text/plain" }, "disabled": true, "key": "trackedfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or before this date. Accepts yyyy-mm-dd or relative: +0d", "type": "text/plain" }, "disabled": true, "key": "trackedto", "value": "\u003cstring\u003e" }, { "description": { "content": "Billable filter (This can only be one of billable,nonbillable,all)", "type": "text/plain" }, "disabled": true, "key": "billable", "value": "all" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Filter by item activeworkstate (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Search by notes. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchnotes", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by item name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchitem", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or after this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Time Record IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,date,projectid,itemid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] } ], "name": "companies" }, { "description": "", "item": [ { "event": [], "id": "ef6fe536-bbf7-4aef-976f-a7f5841fb0a4", "name": "/companies/:companyid/contacts", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Contacts belonging to the specified Company. Supports the same filters as GET /contacts.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/companies/:companyid/contacts", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "contacts" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available fields: firstname, lastname, company, title, phone, fax, email, address, type, image, lastmodified, tags, groups, teams, roles", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "firstname,lastname,type" }, { "description": { "content": "Search by name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by email. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Role IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "roleid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "true" }, { "description": { "content": "Login access filter (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "true" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or after this date (ISO8601 or relative: 12h, 5d)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or after this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,firstname,lastname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "lastname" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"allowlogin\": \"\u003cboolean\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"defaulthourlyrateid\": \"\u003cinteger\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"fax\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"groups\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"ianatimezone\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"notes\": [\n {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n },\n {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n }\n ],\n \"payrate\": \"\u003cnumber\u003e\",\n \"payratemultiplier\": \"\u003cnumber\u003e\",\n \"pending\": \"\u003cboolean\u003e\",\n \"roles\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"state\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\",\n \"tags\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"teams\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"title\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"username\": \"\u003cstring\u003e\",\n \"workphone\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n },\n {\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"allowlogin\": \"\u003cboolean\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"defaulthourlyrateid\": \"\u003cinteger\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"fax\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"groups\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"ianatimezone\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"notes\": [\n {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n },\n {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n }\n ],\n \"payrate\": \"\u003cnumber\u003e\",\n \"payratemultiplier\": \"\u003cnumber\u003e\",\n \"pending\": \"\u003cboolean\u003e\",\n \"roles\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"state\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\",\n \"tags\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"teams\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"title\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"username\": \"\u003cstring\u003e\",\n \"workphone\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "358e6bc2-b1b9-4395-af6e-38834b43e0fa", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "contacts" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available fields: firstname, lastname, company, title, phone, fax, email, address, type, image, lastmodified, tags, groups, teams, roles", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "firstname,lastname,type" }, { "description": { "content": "Search by name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by email. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Role IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "roleid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "true" }, { "description": { "content": "Login access filter (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "true" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or after this date (ISO8601 or relative: 12h, 5d)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or after this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,firstname,lastname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "lastname" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "55ef848b-997f-4907-be66-727e054f6eb1", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "contacts" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available fields: firstname, lastname, company, title, phone, fax, email, address, type, image, lastmodified, tags, groups, teams, roles", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "firstname,lastname,type" }, { "description": { "content": "Search by name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by email. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Role IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "roleid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "true" }, { "description": { "content": "Login access filter (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "true" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or after this date (ISO8601 or relative: 12h, 5d)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or after this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,firstname,lastname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "lastname" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "93585f5e-b451-4e5e-9c64-143c44977230", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "contacts" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available fields: firstname, lastname, company, title, phone, fax, email, address, type, image, lastmodified, tags, groups, teams, roles", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "firstname,lastname,type" }, { "description": { "content": "Search by name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by email. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Role IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "roleid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "true" }, { "description": { "content": "Login access filter (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "true" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or after this date (ISO8601 or relative: 12h, 5d)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or after this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,firstname,lastname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "lastname" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8943a6ce-9278-440a-b538-4ad153828f86", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "contacts" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available fields: firstname, lastname, company, title, phone, fax, email, address, type, image, lastmodified, tags, groups, teams, roles", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "firstname,lastname,type" }, { "description": { "content": "Search by name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by email. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Role IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "roleid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "true" }, { "description": { "content": "Login access filter (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "true" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or after this date (ISO8601 or relative: 12h, 5d)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or after this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,firstname,lastname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "lastname" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] }, { "event": [], "id": "a92284fc-a06c-4fdc-b20e-1987ff337342", "name": "/companies/:companyid/contacts", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Creates one or more Contacts and associates them with the specified Company.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/companies/:companyid/contacts", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "contacts" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f9f47ae1-3237-4413-91e6-f54e76097407", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "contacts" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "70023787-88b5-41d3-ac19-dd76790edfdb", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "contacts" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "43fe1269-76df-426d-a87d-9fcdbe6ed93c", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "contacts" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7c566597-fa64-46c9-8267-687671f107e3", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "contacts" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4b053b0f-056f-42ae-86b0-715b7a5d388a", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "contacts" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "03f309b5-7ed5-47f4-ae5d-2a54bc287e6c", "name": "/contacts", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "View Contacts. Returns a list of Contacts based on the filters specified.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/contacts", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- address - Postal address (computed: combines address1, address2, address3 into a single string)\n- company - Associated company ID and name\n- image - Contact profile image URL\n- lastmodified - Last modified date in ISO8601 format (UTC)\n- name - Contact full name (firstname + lastname)\n- notes - Contact notes as a JSON array [{id, content, date, authorid, authorname}]\n- payrate - Pay rate, pay rate multiplier, and default hourly rate ID\n- roles - Contact roles as a JSON array [{id, name, color}]\n- status - Contact status (active, inactive)\n- timezone - IANA timezone identifier\n- type - Contact type (client, contractor, staff, other)", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,company,type" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use email or q+qfields instead. Search by email. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match (firstname + lastname)", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact email match", "type": "text/plain" }, "disabled": true, "key": "email", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,email)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "email" }, { "description": { "content": "Contact Type. \n- client - Client Contacts\n- contractor - Contractor Contacts\n- other - Other Contacts\n- staff - Staff Contacts (This can only be one of client,contractor,staff,other)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "client" }, { "description": { "content": "Tag ID or List of Tag IDs. \n- tagid/s - Contacts with at least one of the specified Tag ID/s Example: 1,2,3", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Role ID or List of Role IDs. \n- roleid/s - Contacts with at least one of the specified Role ID/s Example: 1,2,3", "type": "text/plain" }, "disabled": true, "key": "roleid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group ID or List of Group IDs (comma-separated). Contacts with at least one of the specified Group IDs", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Pending status. \n- true - Pending Contacts\n- false - Active Contacts (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "false" }, { "description": { "content": "Login status. \n- true - Contacts with Login Access\n- false - Contacts without Login Access (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "true" }, { "description": { "content": "Division ID (Advanced plan only). \n- divisionid - Contacts in specified Division Example: 1", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company ID. \n- companyid - Contacts in specified Company Example: 1", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts added/edited on or after this date (UTC time). \n- Specific date \u0026 time - Date in ISO8601 (yyyy-mm-ddThh:mm) format Example: 2014-01-18T13:20\n- Xn/h/d/w/m - X minutes/hours/days/weeks/months ago Example: 12h", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts added/edited on or before this date (UTC time). \n- Specific date \u0026 time - Date in ISO8601 (yyyy-mm-ddThh:mm) format Example: 2014-01-18T13:20\n- Xn/h/d/w/m - X minutes/hours/days/weeks/months ago Example: 12h", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts with ID greater than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts with ID less than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,firstname,lastname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "firstname" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"allowlogin\": \"\u003cboolean\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"defaulthourlyrateid\": \"\u003cinteger\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"fax\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"groups\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"ianatimezone\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"notes\": [\n {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n },\n {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n }\n ],\n \"payrate\": \"\u003cnumber\u003e\",\n \"payratemultiplier\": \"\u003cnumber\u003e\",\n \"pending\": \"\u003cboolean\u003e\",\n \"roles\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"state\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\",\n \"tags\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"teams\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"title\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"username\": \"\u003cstring\u003e\",\n \"workphone\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n },\n {\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"allowlogin\": \"\u003cboolean\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"defaulthourlyrateid\": \"\u003cinteger\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"fax\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"groups\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"ianatimezone\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"notes\": [\n {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n },\n {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n }\n ],\n \"payrate\": \"\u003cnumber\u003e\",\n \"payratemultiplier\": \"\u003cnumber\u003e\",\n \"pending\": \"\u003cboolean\u003e\",\n \"roles\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"state\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\",\n \"tags\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"teams\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"title\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"username\": \"\u003cstring\u003e\",\n \"workphone\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "58686319-ad1c-4511-8ea6-620d448ae7b5", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- address - Postal address (computed: combines address1, address2, address3 into a single string)\n- company - Associated company ID and name\n- image - Contact profile image URL\n- lastmodified - Last modified date in ISO8601 format (UTC)\n- name - Contact full name (firstname + lastname)\n- notes - Contact notes as a JSON array [{id, content, date, authorid, authorname}]\n- payrate - Pay rate, pay rate multiplier, and default hourly rate ID\n- roles - Contact roles as a JSON array [{id, name, color}]\n- status - Contact status (active, inactive)\n- timezone - IANA timezone identifier\n- type - Contact type (client, contractor, staff, other)", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,company,type" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use email or q+qfields instead. Search by email. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match (firstname + lastname)", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact email match", "type": "text/plain" }, "disabled": true, "key": "email", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,email)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "email" }, { "description": { "content": "Contact Type. \n- client - Client Contacts\n- contractor - Contractor Contacts\n- other - Other Contacts\n- staff - Staff Contacts (This can only be one of client,contractor,staff,other)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "client" }, { "description": { "content": "Tag ID or List of Tag IDs. \n- tagid/s - Contacts with at least one of the specified Tag ID/s Example: 1,2,3", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Role ID or List of Role IDs. \n- roleid/s - Contacts with at least one of the specified Role ID/s Example: 1,2,3", "type": "text/plain" }, "disabled": true, "key": "roleid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group ID or List of Group IDs (comma-separated). Contacts with at least one of the specified Group IDs", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Pending status. \n- true - Pending Contacts\n- false - Active Contacts (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "false" }, { "description": { "content": "Login status. \n- true - Contacts with Login Access\n- false - Contacts without Login Access (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "true" }, { "description": { "content": "Division ID (Advanced plan only). \n- divisionid - Contacts in specified Division Example: 1", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company ID. \n- companyid - Contacts in specified Company Example: 1", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts added/edited on or after this date (UTC time). \n- Specific date \u0026 time - Date in ISO8601 (yyyy-mm-ddThh:mm) format Example: 2014-01-18T13:20\n- Xn/h/d/w/m - X minutes/hours/days/weeks/months ago Example: 12h", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts added/edited on or before this date (UTC time). \n- Specific date \u0026 time - Date in ISO8601 (yyyy-mm-ddThh:mm) format Example: 2014-01-18T13:20\n- Xn/h/d/w/m - X minutes/hours/days/weeks/months ago Example: 12h", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts with ID greater than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts with ID less than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,firstname,lastname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "firstname" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f1a60406-b6c4-4414-854a-428501666c72", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- address - Postal address (computed: combines address1, address2, address3 into a single string)\n- company - Associated company ID and name\n- image - Contact profile image URL\n- lastmodified - Last modified date in ISO8601 format (UTC)\n- name - Contact full name (firstname + lastname)\n- notes - Contact notes as a JSON array [{id, content, date, authorid, authorname}]\n- payrate - Pay rate, pay rate multiplier, and default hourly rate ID\n- roles - Contact roles as a JSON array [{id, name, color}]\n- status - Contact status (active, inactive)\n- timezone - IANA timezone identifier\n- type - Contact type (client, contractor, staff, other)", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,company,type" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use email or q+qfields instead. Search by email. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match (firstname + lastname)", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact email match", "type": "text/plain" }, "disabled": true, "key": "email", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,email)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "email" }, { "description": { "content": "Contact Type. \n- client - Client Contacts\n- contractor - Contractor Contacts\n- other - Other Contacts\n- staff - Staff Contacts (This can only be one of client,contractor,staff,other)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "client" }, { "description": { "content": "Tag ID or List of Tag IDs. \n- tagid/s - Contacts with at least one of the specified Tag ID/s Example: 1,2,3", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Role ID or List of Role IDs. \n- roleid/s - Contacts with at least one of the specified Role ID/s Example: 1,2,3", "type": "text/plain" }, "disabled": true, "key": "roleid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group ID or List of Group IDs (comma-separated). Contacts with at least one of the specified Group IDs", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Pending status. \n- true - Pending Contacts\n- false - Active Contacts (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "false" }, { "description": { "content": "Login status. \n- true - Contacts with Login Access\n- false - Contacts without Login Access (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "true" }, { "description": { "content": "Division ID (Advanced plan only). \n- divisionid - Contacts in specified Division Example: 1", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company ID. \n- companyid - Contacts in specified Company Example: 1", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts added/edited on or after this date (UTC time). \n- Specific date \u0026 time - Date in ISO8601 (yyyy-mm-ddThh:mm) format Example: 2014-01-18T13:20\n- Xn/h/d/w/m - X minutes/hours/days/weeks/months ago Example: 12h", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts added/edited on or before this date (UTC time). \n- Specific date \u0026 time - Date in ISO8601 (yyyy-mm-ddThh:mm) format Example: 2014-01-18T13:20\n- Xn/h/d/w/m - X minutes/hours/days/weeks/months ago Example: 12h", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts with ID greater than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts with ID less than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,firstname,lastname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "firstname" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "0ccc5177-6b6d-425d-9801-2c63148b8448", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- address - Postal address (computed: combines address1, address2, address3 into a single string)\n- company - Associated company ID and name\n- image - Contact profile image URL\n- lastmodified - Last modified date in ISO8601 format (UTC)\n- name - Contact full name (firstname + lastname)\n- notes - Contact notes as a JSON array [{id, content, date, authorid, authorname}]\n- payrate - Pay rate, pay rate multiplier, and default hourly rate ID\n- roles - Contact roles as a JSON array [{id, name, color}]\n- status - Contact status (active, inactive)\n- timezone - IANA timezone identifier\n- type - Contact type (client, contractor, staff, other)", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,company,type" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use email or q+qfields instead. Search by email. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match (firstname + lastname)", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact email match", "type": "text/plain" }, "disabled": true, "key": "email", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,email)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "email" }, { "description": { "content": "Contact Type. \n- client - Client Contacts\n- contractor - Contractor Contacts\n- other - Other Contacts\n- staff - Staff Contacts (This can only be one of client,contractor,staff,other)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "client" }, { "description": { "content": "Tag ID or List of Tag IDs. \n- tagid/s - Contacts with at least one of the specified Tag ID/s Example: 1,2,3", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Role ID or List of Role IDs. \n- roleid/s - Contacts with at least one of the specified Role ID/s Example: 1,2,3", "type": "text/plain" }, "disabled": true, "key": "roleid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group ID or List of Group IDs (comma-separated). Contacts with at least one of the specified Group IDs", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Pending status. \n- true - Pending Contacts\n- false - Active Contacts (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "false" }, { "description": { "content": "Login status. \n- true - Contacts with Login Access\n- false - Contacts without Login Access (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "true" }, { "description": { "content": "Division ID (Advanced plan only). \n- divisionid - Contacts in specified Division Example: 1", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company ID. \n- companyid - Contacts in specified Company Example: 1", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts added/edited on or after this date (UTC time). \n- Specific date \u0026 time - Date in ISO8601 (yyyy-mm-ddThh:mm) format Example: 2014-01-18T13:20\n- Xn/h/d/w/m - X minutes/hours/days/weeks/months ago Example: 12h", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts added/edited on or before this date (UTC time). \n- Specific date \u0026 time - Date in ISO8601 (yyyy-mm-ddThh:mm) format Example: 2014-01-18T13:20\n- Xn/h/d/w/m - X minutes/hours/days/weeks/months ago Example: 12h", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts with ID greater than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts with ID less than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,firstname,lastname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "firstname" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4d52da7c-b5f0-4bcb-b1ef-82ea0fedc8ee", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- address - Postal address (computed: combines address1, address2, address3 into a single string)\n- company - Associated company ID and name\n- image - Contact profile image URL\n- lastmodified - Last modified date in ISO8601 format (UTC)\n- name - Contact full name (firstname + lastname)\n- notes - Contact notes as a JSON array [{id, content, date, authorid, authorname}]\n- payrate - Pay rate, pay rate multiplier, and default hourly rate ID\n- roles - Contact roles as a JSON array [{id, name, color}]\n- status - Contact status (active, inactive)\n- timezone - IANA timezone identifier\n- type - Contact type (client, contractor, staff, other)", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,company,type" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use email or q+qfields instead. Search by email. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match (firstname + lastname)", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact email match", "type": "text/plain" }, "disabled": true, "key": "email", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,email)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "email" }, { "description": { "content": "Contact Type. \n- client - Client Contacts\n- contractor - Contractor Contacts\n- other - Other Contacts\n- staff - Staff Contacts (This can only be one of client,contractor,staff,other)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "client" }, { "description": { "content": "Tag ID or List of Tag IDs. \n- tagid/s - Contacts with at least one of the specified Tag ID/s Example: 1,2,3", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Role ID or List of Role IDs. \n- roleid/s - Contacts with at least one of the specified Role ID/s Example: 1,2,3", "type": "text/plain" }, "disabled": true, "key": "roleid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group ID or List of Group IDs (comma-separated). Contacts with at least one of the specified Group IDs", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Pending status. \n- true - Pending Contacts\n- false - Active Contacts (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "false" }, { "description": { "content": "Login status. \n- true - Contacts with Login Access\n- false - Contacts without Login Access (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "true" }, { "description": { "content": "Division ID (Advanced plan only). \n- divisionid - Contacts in specified Division Example: 1", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company ID. \n- companyid - Contacts in specified Company Example: 1", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts added/edited on or after this date (UTC time). \n- Specific date \u0026 time - Date in ISO8601 (yyyy-mm-ddThh:mm) format Example: 2014-01-18T13:20\n- Xn/h/d/w/m - X minutes/hours/days/weeks/months ago Example: 12h", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts added/edited on or before this date (UTC time). \n- Specific date \u0026 time - Date in ISO8601 (yyyy-mm-ddThh:mm) format Example: 2014-01-18T13:20\n- Xn/h/d/w/m - X minutes/hours/days/weeks/months ago Example: 12h", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts with ID greater than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts with ID less than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,firstname,lastname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "firstname" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "f2deff00-eb6e-4cb4-b0b8-d131de570dba", "name": "/contacts", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"allowlogin\": \"\u003cboolean\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"defaulthourlyrateid\": \"\u003cinteger\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"emailsignature\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"groupid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"ianatimezone\": \"\u003cstring\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"primarycontact\": \"\u003cboolean\u003e\",\n \"roleid\": \"\u003cstring\u003e\",\n \"showhistoric\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"title\": \"\u003cstring\u003e\",\n \"type\": \"client\",\n \"workphone\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Create one or more new contacts", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/contacts", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c618c890-8956-4c3a-8d14-fee8eb74733c", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"allowlogin\": \"\u003cboolean\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"defaulthourlyrateid\": \"\u003cinteger\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"emailsignature\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"groupid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"ianatimezone\": \"\u003cstring\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"primarycontact\": \"\u003cboolean\u003e\",\n \"roleid\": \"\u003cstring\u003e\",\n \"showhistoric\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"title\": \"\u003cstring\u003e\",\n \"type\": \"client\",\n \"workphone\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts" ], "query": [], "variable": [] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a74e90a3-e923-45ef-8cf1-70ffe1b6d6f9", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"allowlogin\": \"\u003cboolean\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"defaulthourlyrateid\": \"\u003cinteger\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"emailsignature\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"groupid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"ianatimezone\": \"\u003cstring\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"primarycontact\": \"\u003cboolean\u003e\",\n \"roleid\": \"\u003cstring\u003e\",\n \"showhistoric\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"title\": \"\u003cstring\u003e\",\n \"type\": \"client\",\n \"workphone\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "866a5507-3284-4175-b9b4-073a7cd25373", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"allowlogin\": \"\u003cboolean\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"defaulthourlyrateid\": \"\u003cinteger\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"emailsignature\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"groupid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"ianatimezone\": \"\u003cstring\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"primarycontact\": \"\u003cboolean\u003e\",\n \"roleid\": \"\u003cstring\u003e\",\n \"showhistoric\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"title\": \"\u003cstring\u003e\",\n \"type\": \"client\",\n \"workphone\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2382db66-f7ff-4e83-becd-27dd3eae4f27", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"allowlogin\": \"\u003cboolean\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"defaulthourlyrateid\": \"\u003cinteger\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"emailsignature\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"groupid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"ianatimezone\": \"\u003cstring\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"primarycontact\": \"\u003cboolean\u003e\",\n \"roleid\": \"\u003cstring\u003e\",\n \"showhistoric\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"title\": \"\u003cstring\u003e\",\n \"type\": \"client\",\n \"workphone\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "94526a0a-9d29-4101-9ee4-ea41a176e597", "name": "/contacts/client", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Client Contacts. Supports the same filters as GET /contacts, scoped to type=client.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/contacts/client", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "client" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: id, name, company, type, email, phone, fax, address, title, image, lastmodified, logindetails, roles, tags, teams, groups, notes", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,company,type" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use email or q+qfields instead. Search by email. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match (firstname + lastname)", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact email match", "type": "text/plain" }, "disabled": true, "key": "email", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,email)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "email" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Role IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "roleid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "true" }, { "description": { "content": "Login access filter (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "true" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Company ID", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Records modified on or after this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cinteger\u003e" }, { "description": { "content": "Records with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cinteger\u003e" }, { "description": { "content": "List of Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,firstname,lastname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "firstname" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"allowlogin\": \"\u003cboolean\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"defaulthourlyrateid\": \"\u003cinteger\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"fax\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"groups\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"ianatimezone\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"notes\": [\n {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n },\n {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n }\n ],\n \"payrate\": \"\u003cnumber\u003e\",\n \"payratemultiplier\": \"\u003cnumber\u003e\",\n \"pending\": \"\u003cboolean\u003e\",\n \"roles\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"state\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\",\n \"tags\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"teams\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"title\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"username\": \"\u003cstring\u003e\",\n \"workphone\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n },\n {\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"allowlogin\": \"\u003cboolean\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"defaulthourlyrateid\": \"\u003cinteger\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"fax\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"groups\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"ianatimezone\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"notes\": [\n {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n },\n {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n }\n ],\n \"payrate\": \"\u003cnumber\u003e\",\n \"payratemultiplier\": \"\u003cnumber\u003e\",\n \"pending\": \"\u003cboolean\u003e\",\n \"roles\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"state\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\",\n \"tags\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"teams\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"title\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"username\": \"\u003cstring\u003e\",\n \"workphone\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "aa08d1fb-ec7e-4ca0-b799-965194c4f22f", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "client" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: id, name, company, type, email, phone, fax, address, title, image, lastmodified, logindetails, roles, tags, teams, groups, notes", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,company,type" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use email or q+qfields instead. Search by email. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match (firstname + lastname)", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact email match", "type": "text/plain" }, "disabled": true, "key": "email", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,email)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "email" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Role IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "roleid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "true" }, { "description": { "content": "Login access filter (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "true" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Company ID", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Records modified on or after this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cinteger\u003e" }, { "description": { "content": "Records with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cinteger\u003e" }, { "description": { "content": "List of Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,firstname,lastname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "firstname" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ae3f807d-21cb-4978-86ce-765694a28e72", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "client" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: id, name, company, type, email, phone, fax, address, title, image, lastmodified, logindetails, roles, tags, teams, groups, notes", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,company,type" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use email or q+qfields instead. Search by email. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match (firstname + lastname)", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact email match", "type": "text/plain" }, "disabled": true, "key": "email", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,email)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "email" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Role IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "roleid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "true" }, { "description": { "content": "Login access filter (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "true" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Company ID", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Records modified on or after this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cinteger\u003e" }, { "description": { "content": "Records with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cinteger\u003e" }, { "description": { "content": "List of Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,firstname,lastname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "firstname" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "15332e16-604a-4edc-bbc4-869abc00e6ef", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "client" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: id, name, company, type, email, phone, fax, address, title, image, lastmodified, logindetails, roles, tags, teams, groups, notes", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,company,type" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use email or q+qfields instead. Search by email. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match (firstname + lastname)", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact email match", "type": "text/plain" }, "disabled": true, "key": "email", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,email)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "email" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Role IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "roleid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "true" }, { "description": { "content": "Login access filter (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "true" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Company ID", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Records modified on or after this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cinteger\u003e" }, { "description": { "content": "Records with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cinteger\u003e" }, { "description": { "content": "List of Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,firstname,lastname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "firstname" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2db942b8-ca70-42a9-a412-3f853603e7f1", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "client" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: id, name, company, type, email, phone, fax, address, title, image, lastmodified, logindetails, roles, tags, teams, groups, notes", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,company,type" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use email or q+qfields instead. Search by email. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match (firstname + lastname)", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact email match", "type": "text/plain" }, "disabled": true, "key": "email", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,email)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "email" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Role IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "roleid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "true" }, { "description": { "content": "Login access filter (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "true" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Company ID", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Records modified on or after this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cinteger\u003e" }, { "description": { "content": "Records with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cinteger\u003e" }, { "description": { "content": "List of Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,firstname,lastname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "firstname" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "72cad350-19b2-4f2d-9595-8718d447e67e", "name": "/contacts/contractor", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Contractor Contacts. Supports the same filters as GET /contacts, scoped to type=contractor.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/contacts/contractor", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "contractor" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: id, name, company, type, email, phone, fax, address, title, image, lastmodified, logindetails, roles, tags, teams, groups, notes", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,company,type" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use email or q+qfields instead. Search by email. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match (firstname + lastname)", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact email match", "type": "text/plain" }, "disabled": true, "key": "email", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,email)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "email" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Role IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "roleid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "true" }, { "description": { "content": "Login access filter (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "true" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Company ID", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Records modified on or after this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cinteger\u003e" }, { "description": { "content": "Records with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cinteger\u003e" }, { "description": { "content": "List of Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,firstname,lastname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "firstname" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"allowlogin\": \"\u003cboolean\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"defaulthourlyrateid\": \"\u003cinteger\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"fax\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"groups\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"ianatimezone\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"notes\": [\n {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n },\n {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n }\n ],\n \"payrate\": \"\u003cnumber\u003e\",\n \"payratemultiplier\": \"\u003cnumber\u003e\",\n \"pending\": \"\u003cboolean\u003e\",\n \"roles\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"state\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\",\n \"tags\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"teams\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"title\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"username\": \"\u003cstring\u003e\",\n \"workphone\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n },\n {\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"allowlogin\": \"\u003cboolean\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"defaulthourlyrateid\": \"\u003cinteger\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"fax\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"groups\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"ianatimezone\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"notes\": [\n {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n },\n {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n }\n ],\n \"payrate\": \"\u003cnumber\u003e\",\n \"payratemultiplier\": \"\u003cnumber\u003e\",\n \"pending\": \"\u003cboolean\u003e\",\n \"roles\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"state\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\",\n \"tags\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"teams\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"title\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"username\": \"\u003cstring\u003e\",\n \"workphone\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b2b43622-ec31-4bb6-b267-08f25ec3c2a9", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "contractor" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: id, name, company, type, email, phone, fax, address, title, image, lastmodified, logindetails, roles, tags, teams, groups, notes", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,company,type" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use email or q+qfields instead. Search by email. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match (firstname + lastname)", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact email match", "type": "text/plain" }, "disabled": true, "key": "email", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,email)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "email" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Role IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "roleid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "true" }, { "description": { "content": "Login access filter (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "true" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Company ID", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Records modified on or after this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cinteger\u003e" }, { "description": { "content": "Records with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cinteger\u003e" }, { "description": { "content": "List of Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,firstname,lastname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "firstname" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8ae5ebfa-c72e-47a3-8e13-424c6b928e94", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "contractor" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: id, name, company, type, email, phone, fax, address, title, image, lastmodified, logindetails, roles, tags, teams, groups, notes", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,company,type" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use email or q+qfields instead. Search by email. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match (firstname + lastname)", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact email match", "type": "text/plain" }, "disabled": true, "key": "email", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,email)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "email" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Role IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "roleid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "true" }, { "description": { "content": "Login access filter (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "true" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Company ID", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Records modified on or after this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cinteger\u003e" }, { "description": { "content": "Records with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cinteger\u003e" }, { "description": { "content": "List of Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,firstname,lastname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "firstname" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c9160c51-2531-40be-ab37-41d36d3bcaff", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "contractor" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: id, name, company, type, email, phone, fax, address, title, image, lastmodified, logindetails, roles, tags, teams, groups, notes", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,company,type" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use email or q+qfields instead. Search by email. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match (firstname + lastname)", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact email match", "type": "text/plain" }, "disabled": true, "key": "email", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,email)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "email" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Role IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "roleid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "true" }, { "description": { "content": "Login access filter (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "true" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Company ID", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Records modified on or after this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cinteger\u003e" }, { "description": { "content": "Records with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cinteger\u003e" }, { "description": { "content": "List of Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,firstname,lastname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "firstname" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "13d1b0a2-4bfa-4ed1-957f-f9ec63153c6e", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "contractor" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: id, name, company, type, email, phone, fax, address, title, image, lastmodified, logindetails, roles, tags, teams, groups, notes", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,company,type" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use email or q+qfields instead. Search by email. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match (firstname + lastname)", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact email match", "type": "text/plain" }, "disabled": true, "key": "email", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,email)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "email" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Role IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "roleid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "true" }, { "description": { "content": "Login access filter (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "true" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Company ID", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Records modified on or after this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cinteger\u003e" }, { "description": { "content": "Records with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cinteger\u003e" }, { "description": { "content": "List of Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,firstname,lastname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "firstname" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "3ef61df1-a608-4e41-ab47-93b7bf64615e", "name": "/contacts/groups", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"groupid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Adds one or more Groups to one or more Contacts.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/contacts/groups", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "groups" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "df08c3c7-d35f-4485-8e25-91f3cc21d46e", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"groupid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "groups" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "77baf7f8-6aa2-4718-98cc-04cd3c9cd25d", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"groupid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "groups" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2924444a-6ae5-4c2a-86a2-d21bf6584e29", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"groupid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "groups" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "86b7f374-b97e-4f7b-a629-b0e6f4937ebc", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"groupid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "groups" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "d2b926b6-92ab-4c44-9919-67cb9eab4b1e", "name": "/contacts/groups", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"groupid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Removes one or more Groups from one or more Contacts.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/contacts/groups", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "groups" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "1a4438ba-2850-493a-8aa1-e51498146b22", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"groupid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "groups" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6931544c-aa3e-47de-8926-0eaf95066edb", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"groupid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "groups" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9c593e10-fcbb-46a0-a576-464f677eaa6a", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"groupid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "groups" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "31a83cfb-a483-4ac1-8b2b-7d3571cd0e15", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"groupid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "groups" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "3216a00e-8815-45fa-9be3-b81549e5e749", "name": "/contacts/roles", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"roleid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Assigns one or more Roles to one or more Staff Contacts.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/contacts/roles", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "roles" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "aa45a81d-25f0-4895-a8ba-3be6a89cd9fe", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"roleid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "roles" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5e181faf-3481-4995-be7d-5fa899771cd5", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"roleid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "roles" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5b704602-7dcd-49df-b6fd-3e0f07bdd9d5", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"roleid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "roles" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "cd215b3e-24b6-4262-9985-650da5b77f90", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"roleid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "roles" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "5d5a6825-d0ac-4349-96be-155d61818cc3", "name": "/contacts/roles", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"roleid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Removes one or more Roles from one or more Staff Contacts.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/contacts/roles", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "roles" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "41f213ed-3976-4548-9aad-c885fd95ec4a", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"roleid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "roles" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "0fd20ae3-ba75-4464-939c-894d1eec1de4", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"roleid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "roles" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e98f666c-dd51-49ae-9afb-2f05e23bbb2b", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"roleid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "roles" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "165cc0ad-165a-453f-82f2-833238300965", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"roleid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "roles" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "0fe03411-7998-4660-9990-55bde1ff22c9", "name": "/contacts/roles/contacts", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Removes one or more Contacts from one or more Roles.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/contacts/roles/contacts", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "roles", "contacts" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9f00cf82-b7e3-45de-aea9-3c6771fad9c7", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "roles", "contacts" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d7af6ad5-e302-49f1-b1ad-48cce0de74ad", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "roles", "contacts" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2f5e9ffb-8739-4c8a-a148-7e2f7008606e", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "roles", "contacts" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3691f39d-0bce-4968-a562-23287be26186", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "roles", "contacts" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "bda9b4be-fcdf-4f43-a4ce-32b05a0fda48", "name": "/contacts/staff", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Staff Contacts. Supports the same filters as GET /contacts, scoped to type=staff.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/contacts/staff", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "staff" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: id, name, company, type, email, phone, fax, address, title, image, lastmodified, logindetails, roles, tags, teams, groups, notes", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,company,type" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use email or q+qfields instead. Search by email. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match (firstname + lastname)", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact email match", "type": "text/plain" }, "disabled": true, "key": "email", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,email)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "email" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Role IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "roleid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "true" }, { "description": { "content": "Login access filter (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "true" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Company ID", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Records modified on or after this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cinteger\u003e" }, { "description": { "content": "Records with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cinteger\u003e" }, { "description": { "content": "List of Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,firstname,lastname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "firstname" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"allowlogin\": \"\u003cboolean\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"defaulthourlyrateid\": \"\u003cinteger\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"fax\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"groups\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"ianatimezone\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"notes\": [\n {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n },\n {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n }\n ],\n \"payrate\": \"\u003cnumber\u003e\",\n \"payratemultiplier\": \"\u003cnumber\u003e\",\n \"pending\": \"\u003cboolean\u003e\",\n \"roles\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"state\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\",\n \"tags\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"teams\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"title\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"username\": \"\u003cstring\u003e\",\n \"workphone\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n },\n {\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"allowlogin\": \"\u003cboolean\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"defaulthourlyrateid\": \"\u003cinteger\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"fax\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"groups\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"ianatimezone\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"notes\": [\n {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n },\n {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n }\n ],\n \"payrate\": \"\u003cnumber\u003e\",\n \"payratemultiplier\": \"\u003cnumber\u003e\",\n \"pending\": \"\u003cboolean\u003e\",\n \"roles\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"state\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\",\n \"tags\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"teams\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"title\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"username\": \"\u003cstring\u003e\",\n \"workphone\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "219058a0-ec75-418a-92d5-9f8314819c2c", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "staff" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: id, name, company, type, email, phone, fax, address, title, image, lastmodified, logindetails, roles, tags, teams, groups, notes", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,company,type" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use email or q+qfields instead. Search by email. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match (firstname + lastname)", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact email match", "type": "text/plain" }, "disabled": true, "key": "email", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,email)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "email" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Role IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "roleid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "true" }, { "description": { "content": "Login access filter (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "true" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Company ID", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Records modified on or after this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cinteger\u003e" }, { "description": { "content": "Records with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cinteger\u003e" }, { "description": { "content": "List of Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,firstname,lastname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "firstname" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2447d9bc-4122-46fc-80f1-d78944c0f8a9", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "staff" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: id, name, company, type, email, phone, fax, address, title, image, lastmodified, logindetails, roles, tags, teams, groups, notes", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,company,type" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use email or q+qfields instead. Search by email. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match (firstname + lastname)", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact email match", "type": "text/plain" }, "disabled": true, "key": "email", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,email)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "email" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Role IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "roleid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "true" }, { "description": { "content": "Login access filter (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "true" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Company ID", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Records modified on or after this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cinteger\u003e" }, { "description": { "content": "Records with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cinteger\u003e" }, { "description": { "content": "List of Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,firstname,lastname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "firstname" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "fd1a6bda-fdaf-46e7-b689-fe7de45f5008", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "staff" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: id, name, company, type, email, phone, fax, address, title, image, lastmodified, logindetails, roles, tags, teams, groups, notes", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,company,type" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use email or q+qfields instead. Search by email. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match (firstname + lastname)", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact email match", "type": "text/plain" }, "disabled": true, "key": "email", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,email)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "email" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Role IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "roleid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "true" }, { "description": { "content": "Login access filter (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "true" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Company ID", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Records modified on or after this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cinteger\u003e" }, { "description": { "content": "Records with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cinteger\u003e" }, { "description": { "content": "List of Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,firstname,lastname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "firstname" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "be3f1492-f672-4841-8627-44f3098fed43", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "staff" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: id, name, company, type, email, phone, fax, address, title, image, lastmodified, logindetails, roles, tags, teams, groups, notes", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,company,type" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use email or q+qfields instead. Search by email. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match (firstname + lastname)", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact email match", "type": "text/plain" }, "disabled": true, "key": "email", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,email)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "email" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Role IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "roleid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "true" }, { "description": { "content": "Login access filter (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "true" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Company ID", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Records modified on or after this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cinteger\u003e" }, { "description": { "content": "Records with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cinteger\u003e" }, { "description": { "content": "List of Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,firstname,lastname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "firstname" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "bfb1c275-bbda-419a-bb1f-ae1dbf05f706", "name": "/contacts/tags", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Adds one or more Tags to one or more Contacts.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/contacts/tags", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "tags" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "08822bfc-239c-445b-94b5-ca131bd270ab", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "tags" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c880d364-8b17-4a02-8105-f8b6d5e024b0", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "tags" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "277c1795-2e82-4c34-b95e-5de1a69742fd", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "tags" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8041e104-735a-4d7a-ae61-c11f70070740", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "tags" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "c43ea234-0a74-4474-82b1-3515547b99be", "name": "/contacts/tags", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Removes one or more Tags from one or more Contacts.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/contacts/tags", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "tags" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a9eef6ec-5930-4cac-8941-f4430748c114", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "tags" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "83d6f376-c367-40ec-9565-86f1c34b2ab3", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "tags" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9d5b1444-0dbc-4610-af34-29e925474c03", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "tags" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c7bd5117-d115-4f1f-b10c-6381771d5984", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", "tags" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "99415400-9141-4f9c-9567-8bf77384b790", "name": "/contacts/:contactid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns details of a single Contact.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/contacts/:contactid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"allowlogin\": \"\u003cboolean\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"defaulthourlyrateid\": \"\u003cinteger\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"fax\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"groups\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"ianatimezone\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"notes\": [\n {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n },\n {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n }\n ],\n \"payrate\": \"\u003cnumber\u003e\",\n \"payratemultiplier\": \"\u003cnumber\u003e\",\n \"pending\": \"\u003cboolean\u003e\",\n \"roles\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"state\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\",\n \"tags\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"teams\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"title\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"username\": \"\u003cstring\u003e\",\n \"workphone\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "231cd502-8f4e-4d84-972e-d7f5e02a4fbe", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "de26fe30-46e5-4738-a51e-0a68b20e9fc9", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b6711a5a-2137-4519-874f-b962108d46be", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2d70effd-c1e1-42a6-98d2-3e3b81884272", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2aad24c0-96db-4e19-abe3-55496f996768", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "a35329be-7cd3-4fd5-804b-e3674ea2b7fb", "name": "/contacts/:contactid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"allowlogin\": \"\u003cboolean\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"companyFavouriteId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"companyid\": \"\u003cinteger\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"defaulthourlyrateid\": \"\u003cinteger\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"emailsignature\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"groupid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"groupids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"ianatimezone\": \"\u003cstring\u003e\",\n \"itemFavouriteId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"primarycontact\": \"\u003cboolean\u003e\",\n \"productFavouriteId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"projectFavouriteId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"reportFavouriteId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"showhistoric\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"title\": \"\u003cstring\u003e\",\n \"workphone\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Updates an existing Contact.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/contacts/:contactid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "65894732-ffb4-47ed-9475-7f9ae0c7523d", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"allowlogin\": \"\u003cboolean\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"companyFavouriteId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"companyid\": \"\u003cinteger\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"defaulthourlyrateid\": \"\u003cinteger\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"emailsignature\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"groupid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"groupids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"ianatimezone\": \"\u003cstring\u003e\",\n \"itemFavouriteId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"primarycontact\": \"\u003cboolean\u003e\",\n \"productFavouriteId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"projectFavouriteId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"reportFavouriteId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"showhistoric\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"title\": \"\u003cstring\u003e\",\n \"workphone\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "1ef6d559-0dec-47aa-b7ef-2de7da9316d9", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"allowlogin\": \"\u003cboolean\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"companyFavouriteId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"companyid\": \"\u003cinteger\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"defaulthourlyrateid\": \"\u003cinteger\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"emailsignature\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"groupid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"groupids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"ianatimezone\": \"\u003cstring\u003e\",\n \"itemFavouriteId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"primarycontact\": \"\u003cboolean\u003e\",\n \"productFavouriteId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"projectFavouriteId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"reportFavouriteId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"showhistoric\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"title\": \"\u003cstring\u003e\",\n \"workphone\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8d5a0704-fc2c-4107-ab4f-48a157a2a254", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"allowlogin\": \"\u003cboolean\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"companyFavouriteId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"companyid\": \"\u003cinteger\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"defaulthourlyrateid\": \"\u003cinteger\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"emailsignature\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"groupid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"groupids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"ianatimezone\": \"\u003cstring\u003e\",\n \"itemFavouriteId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"primarycontact\": \"\u003cboolean\u003e\",\n \"productFavouriteId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"projectFavouriteId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"reportFavouriteId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"showhistoric\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"title\": \"\u003cstring\u003e\",\n \"workphone\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "1a67690d-b1c9-4f0b-9906-10c20a8c9500", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"allowlogin\": \"\u003cboolean\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"companyFavouriteId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"companyid\": \"\u003cinteger\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"defaulthourlyrateid\": \"\u003cinteger\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"emailsignature\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"groupid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"groupids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"ianatimezone\": \"\u003cstring\u003e\",\n \"itemFavouriteId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"primarycontact\": \"\u003cboolean\u003e\",\n \"productFavouriteId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"projectFavouriteId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"reportFavouriteId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"showhistoric\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"title\": \"\u003cstring\u003e\",\n \"workphone\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2cb607ff-f837-4317-b84a-9b5ce08d8d60", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"allowlogin\": \"\u003cboolean\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"companyFavouriteId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"companyid\": \"\u003cinteger\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"defaulthourlyrateid\": \"\u003cinteger\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"emailsignature\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"groupid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"groupids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"ianatimezone\": \"\u003cstring\u003e\",\n \"itemFavouriteId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"primarycontact\": \"\u003cboolean\u003e\",\n \"productFavouriteId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"projectFavouriteId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"reportFavouriteId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"showhistoric\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"title\": \"\u003cstring\u003e\",\n \"workphone\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "895f1717-9324-4bcb-9445-1492001bb79f", "name": "/contacts/:contactid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Soft deletes a Contact.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/contacts/:contactid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2c5e3109-e48e-49f9-83c5-42d39d8d6bc6", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a8b3b846-ac46-4a77-aa42-767d319b8569", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "eacb8acd-59a7-481f-8601-d9aae8629385", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9b2483ac-1f0c-4bd2-a038-47f57b7de4c8", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a13fbd90-a002-428c-b94f-a69d4825cc09", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "da60ef5c-e6d0-423a-8cb4-5e5468b0cbe6", "name": "/contacts/:contactid/groups", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Teams \u0026 Groups for a Contact.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/contacts/:contactid/groups", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "groups" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"groups\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\",\n \"teams\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ]\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "63a251c5-eb6b-472c-97c0-1e1d76d772cf", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "groups" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "706ae321-b69c-4914-a3b7-8aab5d87eb5b", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "groups" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6f26e64d-b9ef-490f-b073-981109f1496c", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "groups" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c18136a5-ab17-46a1-bcb5-fa4bb11cb5c1", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "groups" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b9a3ce58-4971-49fa-99e0-7eede7495ed7", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "groups" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "a398e2c4-6097-45ba-b677-67fa896d0d5a", "name": "/contacts/:contactid/groups", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"groupid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Updates the groups assigned to a Staff Contact.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/contacts/:contactid/groups", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "groups" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2183a774-ec1f-4943-a1cf-8bb6ccd0bf63", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"groupid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "groups" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "41205032-c391-499b-96c9-8b33fdbaf690", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"groupid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "groups" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6e25c838-c92a-44e9-9f09-ce3505605cbd", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"groupid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "groups" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f8debef6-4a10-4c70-9bd2-acd6532625f4", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"groupid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "groups" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5820f0c1-5094-4f58-92e1-a2025045e7d5", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"groupid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "groups" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "c6300091-c0e2-4773-966c-e3dd8bc547f5", "name": "/contacts/:contactid/items", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Items (Tasks) assigned to the specified Contact. Supports the same filters as GET /items, scoped to the given contact.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/contacts/:contactid/items", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: title, code, number, description, status, priority, percentcomplete, position, project, company, dates, time, billable, workstageid, parentid, phasename, assignedto, tags, lastmodified", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "title,status,priority" }, { "description": { "content": "Search by name or code. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by description. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchdescription", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by code. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Item status (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "active" }, { "description": { "content": "Priority values 1-5 (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Additional contact filter (comma-separated IDs, or 'me')", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Mode for contacts filter (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Work Stage ID", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Start date from (yyyy-mm-dd)", "type": "text/plain" }, "disabled": true, "key": "startdatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Start date to (yyyy-mm-dd)", "type": "text/plain" }, "disabled": true, "key": "startdateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (yyyy-mm-dd)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date to (yyyy-mm-dd)", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Items modified on or after this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Items modified on or before this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Items with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Items with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,title,code,priority,startdate,duedate,completedate,status,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "title" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"actualInLabour\": \"\u003cnumber\u003e\",\n \"actualInTotal\": \"\u003cnumber\u003e\",\n \"actualInTotalTax\": \"\u003cnumber\u003e\",\n \"actualOutLabour\": \"\u003cnumber\u003e\",\n \"actualProfit\": \"\u003cnumber\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"contacts\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cstring\u003e\",\n \"createdatetime\": \"\u003cstring\u003e\",\n \"creatorid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"dependenttaskid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"discountRate\": \"\u003cnumber\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScoreId\": \"\u003cinteger\u003e\",\n \"estBillAmount\": \"\u003cnumber\u003e\",\n \"estBillAmountTax\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"impactScoreId\": \"\u003cinteger\u003e\",\n \"importanceScoreId\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inTaxRate\": \"\u003cnumber\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoicedAmount\": \"\u003cnumber\u003e\",\n \"invoicedAmountTax\": \"\u003cnumber\u003e\",\n \"invoiceitemid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"isDiscountPercent\": \"\u003cboolean\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"manualPercentageComplete\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"number\": \"\u003cinteger\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outTaxRate\": \"\u003cnumber\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"paidAmount\": \"\u003cnumber\u003e\",\n \"paidAmountTax\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"phasename\": \"\u003cstring\u003e\",\n \"prerequisiteid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedBillAmount\": \"\u003cnumber\u003e\",\n \"projectedBillAmountTax\": \"\u003cnumber\u003e\",\n \"projectedGrossMargin\": \"\u003cnumber\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"projectedOutLabour\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"projectedTimeManual\": \"\u003cnumber\u003e\",\n \"projectedTimeSpent\": \"\u003cnumber\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"quoteitemid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cinteger\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tags\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"uniquetoken\": \"\u003cstring\u003e\",\n \"urgencyScoreId\": \"\u003cinteger\u003e\"\n },\n {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"actualInLabour\": \"\u003cnumber\u003e\",\n \"actualInTotal\": \"\u003cnumber\u003e\",\n \"actualInTotalTax\": \"\u003cnumber\u003e\",\n \"actualOutLabour\": \"\u003cnumber\u003e\",\n \"actualProfit\": \"\u003cnumber\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"contacts\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cstring\u003e\",\n \"createdatetime\": \"\u003cstring\u003e\",\n \"creatorid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"dependenttaskid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"discountRate\": \"\u003cnumber\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScoreId\": \"\u003cinteger\u003e\",\n \"estBillAmount\": \"\u003cnumber\u003e\",\n \"estBillAmountTax\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"impactScoreId\": \"\u003cinteger\u003e\",\n \"importanceScoreId\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inTaxRate\": \"\u003cnumber\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoicedAmount\": \"\u003cnumber\u003e\",\n \"invoicedAmountTax\": \"\u003cnumber\u003e\",\n \"invoiceitemid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"isDiscountPercent\": \"\u003cboolean\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"manualPercentageComplete\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"number\": \"\u003cinteger\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outTaxRate\": \"\u003cnumber\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"paidAmount\": \"\u003cnumber\u003e\",\n \"paidAmountTax\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"phasename\": \"\u003cstring\u003e\",\n \"prerequisiteid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedBillAmount\": \"\u003cnumber\u003e\",\n \"projectedBillAmountTax\": \"\u003cnumber\u003e\",\n \"projectedGrossMargin\": \"\u003cnumber\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"projectedOutLabour\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"projectedTimeManual\": \"\u003cnumber\u003e\",\n \"projectedTimeSpent\": \"\u003cnumber\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"quoteitemid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cinteger\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tags\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"uniquetoken\": \"\u003cstring\u003e\",\n \"urgencyScoreId\": \"\u003cinteger\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "14b14fd5-9933-447b-b1cd-9b8964a4467b", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: title, code, number, description, status, priority, percentcomplete, position, project, company, dates, time, billable, workstageid, parentid, phasename, assignedto, tags, lastmodified", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "title,status,priority" }, { "description": { "content": "Search by name or code. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by description. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchdescription", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by code. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Item status (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "active" }, { "description": { "content": "Priority values 1-5 (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Additional contact filter (comma-separated IDs, or 'me')", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Mode for contacts filter (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Work Stage ID", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Start date from (yyyy-mm-dd)", "type": "text/plain" }, "disabled": true, "key": "startdatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Start date to (yyyy-mm-dd)", "type": "text/plain" }, "disabled": true, "key": "startdateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (yyyy-mm-dd)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date to (yyyy-mm-dd)", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Items modified on or after this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Items modified on or before this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Items with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Items with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,title,code,priority,startdate,duedate,completedate,status,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "title" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7e9a7a28-5d20-4e80-a077-23fdce792b78", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: title, code, number, description, status, priority, percentcomplete, position, project, company, dates, time, billable, workstageid, parentid, phasename, assignedto, tags, lastmodified", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "title,status,priority" }, { "description": { "content": "Search by name or code. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by description. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchdescription", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by code. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Item status (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "active" }, { "description": { "content": "Priority values 1-5 (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Additional contact filter (comma-separated IDs, or 'me')", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Mode for contacts filter (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Work Stage ID", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Start date from (yyyy-mm-dd)", "type": "text/plain" }, "disabled": true, "key": "startdatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Start date to (yyyy-mm-dd)", "type": "text/plain" }, "disabled": true, "key": "startdateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (yyyy-mm-dd)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date to (yyyy-mm-dd)", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Items modified on or after this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Items modified on or before this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Items with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Items with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,title,code,priority,startdate,duedate,completedate,status,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "title" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ef902368-233b-4529-96e8-feac89882067", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: title, code, number, description, status, priority, percentcomplete, position, project, company, dates, time, billable, workstageid, parentid, phasename, assignedto, tags, lastmodified", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "title,status,priority" }, { "description": { "content": "Search by name or code. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by description. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchdescription", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by code. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Item status (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "active" }, { "description": { "content": "Priority values 1-5 (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Additional contact filter (comma-separated IDs, or 'me')", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Mode for contacts filter (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Work Stage ID", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Start date from (yyyy-mm-dd)", "type": "text/plain" }, "disabled": true, "key": "startdatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Start date to (yyyy-mm-dd)", "type": "text/plain" }, "disabled": true, "key": "startdateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (yyyy-mm-dd)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date to (yyyy-mm-dd)", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Items modified on or after this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Items modified on or before this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Items with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Items with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,title,code,priority,startdate,duedate,completedate,status,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "title" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e6ed7b7a-2deb-48f6-b04d-07efdb297aa4", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: title, code, number, description, status, priority, percentcomplete, position, project, company, dates, time, billable, workstageid, parentid, phasename, assignedto, tags, lastmodified", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "title,status,priority" }, { "description": { "content": "Search by name or code. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by description. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchdescription", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by code. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Item status (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "active" }, { "description": { "content": "Priority values 1-5 (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Additional contact filter (comma-separated IDs, or 'me')", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Mode for contacts filter (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Work Stage ID", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Start date from (yyyy-mm-dd)", "type": "text/plain" }, "disabled": true, "key": "startdatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Start date to (yyyy-mm-dd)", "type": "text/plain" }, "disabled": true, "key": "startdateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (yyyy-mm-dd)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date to (yyyy-mm-dd)", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Items modified on or after this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Items modified on or before this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Items with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Items with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,title,code,priority,startdate,duedate,completedate,status,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "title" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] }, { "event": [], "id": "f6cfc03f-38ab-4fee-93a1-6b9cf7fe7fd0", "name": "/contacts/:contactid/items", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Assigns a Contact to one or more Items (Tasks).", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/contacts/:contactid/items", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "items" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "edc1288f-7496-43d9-a241-b5ac2a3b92be", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "items" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "cc12563b-b7cb-4a84-a47b-9112bb691248", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "items" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3ab6841a-8beb-4c63-a67e-585b263f47d0", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "items" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "55c491f7-275f-4f61-bf0a-50898f975259", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "items" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] }, { "event": [], "id": "81599da4-e5df-40ba-b64f-e62e84d15f1d", "name": "/contacts/:contactid/notes", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Notes for a Contact.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/contacts/:contactid/notes", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "notes" ], "query": [ { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n },\n {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3ce2c5b9-9c26-4e08-b045-bf180dbbcd7a", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "notes" ], "query": [ { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c196b841-f96e-4bdf-ad17-21e75347d65c", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "notes" ], "query": [ { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6200cc57-49fa-4782-ba78-32b89e2200cd", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "notes" ], "query": [ { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7add66b0-3fe4-425a-9e69-954eeda3a42c", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "notes" ], "query": [ { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ff259f26-9e59-495c-8319-ecce83e92069", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "notes" ], "query": [ { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "12423833-93fa-4013-a497-82ce3184343e", "name": "/contacts/:contactid/notes", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"note\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Creates one or more Notes for a Contact.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/contacts/:contactid/notes", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "notes" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c649b61f-12fc-45d5-9f6c-83d2a2dbbd75", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"note\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "notes" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c0e60b6e-ac59-47c9-b361-25773950c496", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"note\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "notes" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f4ba0f6e-db48-4187-9d7f-f88ebdeca31d", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"note\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "notes" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "bae44d30-c10e-42a8-b43e-8341459da741", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"note\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "notes" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5628a10a-537a-49e2-8be7-27d6ce1c8e0d", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"note\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "notes" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "f68af278-feba-4021-a09f-7a4d3fa9e538", "name": "/contacts/:contactid/notes/:noteid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a single Note for a Contact.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/contacts/:contactid/notes/:noteid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "notes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "518300bf-7f24-44f9-a6d8-48902bd6667e", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "notes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d512579f-ad16-4512-9770-6b2b6047cc22", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "notes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "55232ad9-d533-4d9d-895b-cedaf6ed560a", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "notes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "529de257-505b-4829-86fe-fccc7493f0a6", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "notes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "057ca045-dd02-4e12-a764-0e7d5c03fd3f", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "notes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "6e4fe151-8297-411e-99fd-ad19a4b10c09", "name": "/contacts/:contactid/notes/:noteid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"note\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Soft deletes a Contact Note.\nUpdates a Contact Note.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/contacts/:contactid/notes/:noteid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "notes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "eab8d4bb-9be4-4e50-9daf-a958a52e122a", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"note\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "notes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b0cbbf93-df3a-4b24-9e37-760c51a323c6", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"note\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "notes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "57b7c4c0-311c-496d-8017-e0b7da3b8fe7", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"note\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "notes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e8f382ee-2ed5-4c9c-b040-c995148ea671", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"note\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "notes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "11da0c42-b4d2-477e-aa60-fd7ebef9473e", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"note\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "notes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "19d74583-a4d0-46e5-8a52-0cf3e9ad3966", "name": "/contacts/:contactid/permissions", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns all permissions for a Staff contact. Use GET /settings/contacts/permissions to retrieve the list of available permission IDs.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/contacts/:contactid/permissions", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "permissions" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "[\n {\n \"add\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"delete\": \"\u003cboolean\u003e\",\n \"edit\": \"\u003cboolean\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"permissionid\": \"\u003cinteger\u003e\",\n \"view\": \"\u003cboolean\u003e\"\n },\n {\n \"add\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"delete\": \"\u003cboolean\u003e\",\n \"edit\": \"\u003cboolean\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"permissionid\": \"\u003cinteger\u003e\",\n \"view\": \"\u003cboolean\u003e\"\n }\n]", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b12c9478-29ca-4d10-aaab-8ea7c89a6450", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "permissions" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "81b99fd3-7e43-4e74-b014-eb79040640b7", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "permissions" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f004ca1d-ae11-4c07-bc4e-5ebe8fbd6c60", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "permissions" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4e792323-492b-4100-b336-7b86f9471d82", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "permissions" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] }, { "event": [], "id": "c0e44d03-5d04-4bfa-b1a5-f906a8ecee5c", "name": "/contacts/:contactid/permissions/:permissionid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a single permission entry for a Staff contact. Use GET /settings/contacts/permissions to retrieve the list of available permission IDs.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/contacts/:contactid/permissions/:permissionid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "permissions", ":permissionid" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Permission ID", "type": "text/plain" }, "disabled": false, "key": "permissionid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"add\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"delete\": \"\u003cboolean\u003e\",\n \"edit\": \"\u003cboolean\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"permissionid\": \"\u003cinteger\u003e\",\n \"view\": \"\u003cboolean\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3ad6d7c1-24a1-403a-adfb-c08cb86f3ff3", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "permissions", ":permissionid" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Permission ID", "type": "text/plain" }, "disabled": false, "key": "permissionid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "689d831a-ac0f-456a-bd29-7f573bb5ba8c", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "permissions", ":permissionid" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Permission ID", "type": "text/plain" }, "disabled": false, "key": "permissionid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "cc13d8d4-b0ee-4e53-82d9-b74c3948634e", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "permissions", ":permissionid" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Permission ID", "type": "text/plain" }, "disabled": false, "key": "permissionid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "06849aca-796a-487f-86a4-884db1b8a76b", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "permissions", ":permissionid" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Permission ID", "type": "text/plain" }, "disabled": false, "key": "permissionid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "163eb105-828d-4a37-9dff-b939e4aabf4f", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "permissions", ":permissionid" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Permission ID", "type": "text/plain" }, "disabled": false, "key": "permissionid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "8b79f26c-46b7-4fe7-babb-3c8bb199d965", "name": "/contacts/:contactid/projects", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Projects the specified Contact is assigned to (as staff, contractor, or client). Supports the same filters as GET /projects, scoped to the given contact.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/contacts/:contactid/projects", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "projects" ], "query": [ { "description": { "content": "Comma-separated fields to return", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "title,number,company,startdate,duedate" }, { "description": { "content": "Search by number or title. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by project number. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Project status (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "deleted" }, { "description": { "content": "Manager Contact IDs (comma-separated). Use ! for negation, or 'me'/'all'", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Additional contact filter (comma-separated IDs). Use ! for negation, or 'me'/'all'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts filter mode (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Team IDs (comma-separated, Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "teamid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group IDs (comma-separated, Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Priority values 1-5 (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Workstage IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Start date from (yyyy-mm-dd or relative: +/-Xd/w/m/y)", "type": "text/plain" }, "disabled": true, "key": "startdatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Start date to (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "startdateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date to (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Complete date from (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "completedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Complete date to (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "completedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified from in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified to in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter projects with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter projects with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,startdate,duedate,completedate,companyname,categoryname,priority)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"actualInLabour\": \"\u003cnumber\u003e\",\n \"actualInTotal\": \"\u003cnumber\u003e\",\n \"actualInTotalTax\": \"\u003cnumber\u003e\",\n \"actualOutLabour\": \"\u003cnumber\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billtotal\": \"\u003cnumber\u003e\",\n \"bookmarks\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"url\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"url\": \"\u003cstring\u003e\"\n }\n ],\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"burn\": \"\u003cnumber\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"categoryname\": \"\u003cstring\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"clients\": [\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"clienttype\": \"\u003cstring\u003e\",\n \"clientviewalltasks\": \"\u003cboolean\u003e\",\n \"clientviewtime\": \"\u003cboolean\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"contractorid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"contractors\": [\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"createdate\": \"\u003cstring\u003e\",\n \"customfieldoptionid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"customfields\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"value\": \"\u003cstring\u003e\",\n \"valuename\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"value\": \"\u003cstring\u003e\",\n \"valuename\": \"\u003cstring\u003e\"\n }\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"estBillAmount\": \"\u003cnumber\u003e\",\n \"estBillAmountTax\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"files\": [\n {\n \"description\": \"\u003cstring\u003e\",\n \"folderid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"modified\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"uniquetoken\": \"\u003cstring\u003e\"\n },\n {\n \"description\": \"\u003cstring\u003e\",\n \"folderid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"modified\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"uniquetoken\": \"\u003cstring\u003e\"\n }\n ],\n \"folders\": [\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"modified\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"modified\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"groupid\": \"\u003cinteger\u003e\",\n \"groupname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"internalclientcontactid\": \"\u003cinteger\u003e\",\n \"internalclientgroupid\": \"\u003cinteger\u003e\",\n \"internalclientgroupname\": \"\u003cstring\u003e\",\n \"internalclientteamid\": \"\u003cinteger\u003e\",\n \"internalclientteamname\": \"\u003cstring\u003e\",\n \"invoiced\": \"\u003cboolean\u003e\",\n \"invoicedAmount\": \"\u003cnumber\u003e\",\n \"invoicedAmountTax\": \"\u003cnumber\u003e\",\n \"invoices\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoicedate\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"paid\": \"\u003cboolean\u003e\",\n \"paiddate\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoicedate\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"paid\": \"\u003cboolean\u003e\",\n \"paiddate\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\"\n }\n ],\n \"invoicetotal\": \"\u003cnumber\u003e\",\n \"itemDueDate\": \"\u003cstring\u003e\",\n \"itemStartDate\": \"\u003cstring\u003e\",\n \"itemsActive\": \"\u003cinteger\u003e\",\n \"itemsCompleted\": \"\u003cinteger\u003e\",\n \"itemsDiscount\": \"\u003cnumber\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"managerfirstname\": \"\u003cstring\u003e\",\n \"managerid\": \"\u003cinteger\u003e\",\n \"managerlastname\": \"\u003cstring\u003e\",\n \"messages\": [\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"replycount\": \"\u003cinteger\u003e\",\n \"senddate\": \"\u003cstring\u003e\",\n \"senderid\": \"\u003cinteger\u003e\",\n \"shortdetails\": \"\u003cstring\u003e\",\n \"subject\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"replycount\": \"\u003cinteger\u003e\",\n \"senddate\": \"\u003cstring\u003e\",\n \"senderid\": \"\u003cinteger\u003e\",\n \"shortdetails\": \"\u003cstring\u003e\",\n \"subject\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"notification\": \"\u003cboolean\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"paid\": \"\u003cboolean\u003e\",\n \"paidAmountTax\": \"\u003cnumber\u003e\",\n \"paidamount\": \"\u003cnumber\u003e\",\n \"percentcomplete\": \"\u003cinteger\u003e\",\n \"phases\": [\n {\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n }\n ],\n \"name\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n },\n {\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n }\n ],\n \"name\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n }\n ],\n \"priority\": \"\u003cinteger\u003e\",\n \"privatenotes\": \"\u003cstring\u003e\",\n \"projectedBillAmount\": \"\u003cnumber\u003e\",\n \"projectedBillAmountTax\": \"\u003cnumber\u003e\",\n \"projectedGrossMargin\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"projectedTimeManual\": \"\u003cnumber\u003e\",\n \"projectedTimeSpent\": \"\u003cnumber\u003e\",\n \"projectnotes\": [\n {\n \"content\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n },\n {\n \"content\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n }\n ],\n \"purchaseorder\": \"\u003cstring\u003e\",\n \"staff\": [\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"staffid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"staffviewalltasks\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cnumber\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tags\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"teamid\": \"\u003cinteger\u003e\",\n \"teamname\": \"\u003cstring\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\",\n \"timerecords\": [\n {\n \"accountedfor\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"endtime\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"notes\": \"\u003cstring\u003e\",\n \"running\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n },\n {\n \"accountedfor\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"endtime\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"notes\": \"\u003cstring\u003e\",\n \"running\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n }\n ],\n \"timetracked\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\",\n \"workstagename\": \"\u003cstring\u003e\",\n \"workstages\": [\n {\n \"active\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"setdatetime\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\"\n },\n {\n \"active\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"setdatetime\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\"\n }\n ]\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"actualInLabour\": \"\u003cnumber\u003e\",\n \"actualInTotal\": \"\u003cnumber\u003e\",\n \"actualInTotalTax\": \"\u003cnumber\u003e\",\n \"actualOutLabour\": \"\u003cnumber\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billtotal\": \"\u003cnumber\u003e\",\n \"bookmarks\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"url\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"url\": \"\u003cstring\u003e\"\n }\n ],\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"burn\": \"\u003cnumber\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"categoryname\": \"\u003cstring\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"clients\": [\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"clienttype\": \"\u003cstring\u003e\",\n \"clientviewalltasks\": \"\u003cboolean\u003e\",\n \"clientviewtime\": \"\u003cboolean\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"contractorid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"contractors\": [\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"createdate\": \"\u003cstring\u003e\",\n \"customfieldoptionid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"customfields\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"value\": \"\u003cstring\u003e\",\n \"valuename\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"value\": \"\u003cstring\u003e\",\n \"valuename\": \"\u003cstring\u003e\"\n }\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"estBillAmount\": \"\u003cnumber\u003e\",\n \"estBillAmountTax\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"files\": [\n {\n \"description\": \"\u003cstring\u003e\",\n \"folderid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"modified\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"uniquetoken\": \"\u003cstring\u003e\"\n },\n {\n \"description\": \"\u003cstring\u003e\",\n \"folderid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"modified\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"uniquetoken\": \"\u003cstring\u003e\"\n }\n ],\n \"folders\": [\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"modified\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"modified\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"groupid\": \"\u003cinteger\u003e\",\n \"groupname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"internalclientcontactid\": \"\u003cinteger\u003e\",\n \"internalclientgroupid\": \"\u003cinteger\u003e\",\n \"internalclientgroupname\": \"\u003cstring\u003e\",\n \"internalclientteamid\": \"\u003cinteger\u003e\",\n \"internalclientteamname\": \"\u003cstring\u003e\",\n \"invoiced\": \"\u003cboolean\u003e\",\n \"invoicedAmount\": \"\u003cnumber\u003e\",\n \"invoicedAmountTax\": \"\u003cnumber\u003e\",\n \"invoices\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoicedate\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"paid\": \"\u003cboolean\u003e\",\n \"paiddate\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoicedate\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"paid\": \"\u003cboolean\u003e\",\n \"paiddate\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\"\n }\n ],\n \"invoicetotal\": \"\u003cnumber\u003e\",\n \"itemDueDate\": \"\u003cstring\u003e\",\n \"itemStartDate\": \"\u003cstring\u003e\",\n \"itemsActive\": \"\u003cinteger\u003e\",\n \"itemsCompleted\": \"\u003cinteger\u003e\",\n \"itemsDiscount\": \"\u003cnumber\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"managerfirstname\": \"\u003cstring\u003e\",\n \"managerid\": \"\u003cinteger\u003e\",\n \"managerlastname\": \"\u003cstring\u003e\",\n \"messages\": [\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"replycount\": \"\u003cinteger\u003e\",\n \"senddate\": \"\u003cstring\u003e\",\n \"senderid\": \"\u003cinteger\u003e\",\n \"shortdetails\": \"\u003cstring\u003e\",\n \"subject\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"replycount\": \"\u003cinteger\u003e\",\n \"senddate\": \"\u003cstring\u003e\",\n \"senderid\": \"\u003cinteger\u003e\",\n \"shortdetails\": \"\u003cstring\u003e\",\n \"subject\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"notification\": \"\u003cboolean\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"paid\": \"\u003cboolean\u003e\",\n \"paidAmountTax\": \"\u003cnumber\u003e\",\n \"paidamount\": \"\u003cnumber\u003e\",\n \"percentcomplete\": \"\u003cinteger\u003e\",\n \"phases\": [\n {\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n }\n ],\n \"name\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n },\n {\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n }\n ],\n \"name\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n }\n ],\n \"priority\": \"\u003cinteger\u003e\",\n \"privatenotes\": \"\u003cstring\u003e\",\n \"projectedBillAmount\": \"\u003cnumber\u003e\",\n \"projectedBillAmountTax\": \"\u003cnumber\u003e\",\n \"projectedGrossMargin\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"projectedTimeManual\": \"\u003cnumber\u003e\",\n \"projectedTimeSpent\": \"\u003cnumber\u003e\",\n \"projectnotes\": [\n {\n \"content\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n },\n {\n \"content\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n }\n ],\n \"purchaseorder\": \"\u003cstring\u003e\",\n \"staff\": [\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"staffid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"staffviewalltasks\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cnumber\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tags\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"teamid\": \"\u003cinteger\u003e\",\n \"teamname\": \"\u003cstring\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\",\n \"timerecords\": [\n {\n \"accountedfor\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"endtime\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"notes\": \"\u003cstring\u003e\",\n \"running\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n },\n {\n \"accountedfor\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"endtime\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"notes\": \"\u003cstring\u003e\",\n \"running\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n }\n ],\n \"timetracked\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\",\n \"workstagename\": \"\u003cstring\u003e\",\n \"workstages\": [\n {\n \"active\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"setdatetime\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\"\n },\n {\n \"active\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"setdatetime\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\"\n }\n ]\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a2bac894-27cd-4fcf-be5e-133c537823a5", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "projects" ], "query": [ { "description": { "content": "Comma-separated fields to return", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "title,number,company,startdate,duedate" }, { "description": { "content": "Search by number or title. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by project number. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Project status (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "deleted" }, { "description": { "content": "Manager Contact IDs (comma-separated). Use ! for negation, or 'me'/'all'", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Additional contact filter (comma-separated IDs). Use ! for negation, or 'me'/'all'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts filter mode (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Team IDs (comma-separated, Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "teamid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group IDs (comma-separated, Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Priority values 1-5 (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Workstage IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Start date from (yyyy-mm-dd or relative: +/-Xd/w/m/y)", "type": "text/plain" }, "disabled": true, "key": "startdatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Start date to (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "startdateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date to (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Complete date from (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "completedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Complete date to (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "completedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified from in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified to in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter projects with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter projects with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,startdate,duedate,completedate,companyname,categoryname,priority)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "61bd6dd6-9386-4d16-95f4-8b7b77f1f9e5", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "projects" ], "query": [ { "description": { "content": "Comma-separated fields to return", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "title,number,company,startdate,duedate" }, { "description": { "content": "Search by number or title. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by project number. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Project status (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "deleted" }, { "description": { "content": "Manager Contact IDs (comma-separated). Use ! for negation, or 'me'/'all'", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Additional contact filter (comma-separated IDs). Use ! for negation, or 'me'/'all'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts filter mode (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Team IDs (comma-separated, Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "teamid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group IDs (comma-separated, Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Priority values 1-5 (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Workstage IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Start date from (yyyy-mm-dd or relative: +/-Xd/w/m/y)", "type": "text/plain" }, "disabled": true, "key": "startdatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Start date to (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "startdateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date to (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Complete date from (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "completedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Complete date to (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "completedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified from in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified to in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter projects with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter projects with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,startdate,duedate,completedate,companyname,categoryname,priority)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a17a51af-0802-4504-bb5e-a2a6b97b1ce1", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "projects" ], "query": [ { "description": { "content": "Comma-separated fields to return", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "title,number,company,startdate,duedate" }, { "description": { "content": "Search by number or title. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by project number. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Project status (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "deleted" }, { "description": { "content": "Manager Contact IDs (comma-separated). Use ! for negation, or 'me'/'all'", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Additional contact filter (comma-separated IDs). Use ! for negation, or 'me'/'all'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts filter mode (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Team IDs (comma-separated, Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "teamid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group IDs (comma-separated, Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Priority values 1-5 (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Workstage IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Start date from (yyyy-mm-dd or relative: +/-Xd/w/m/y)", "type": "text/plain" }, "disabled": true, "key": "startdatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Start date to (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "startdateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date to (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Complete date from (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "completedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Complete date to (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "completedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified from in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified to in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter projects with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter projects with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,startdate,duedate,completedate,companyname,categoryname,priority)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "de3588e1-d1d6-45d6-9172-c080fbec712d", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "projects" ], "query": [ { "description": { "content": "Comma-separated fields to return", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "title,number,company,startdate,duedate" }, { "description": { "content": "Search by number or title. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by project number. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Project status (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "deleted" }, { "description": { "content": "Manager Contact IDs (comma-separated). Use ! for negation, or 'me'/'all'", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Additional contact filter (comma-separated IDs). Use ! for negation, or 'me'/'all'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts filter mode (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Team IDs (comma-separated, Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "teamid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group IDs (comma-separated, Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Priority values 1-5 (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Workstage IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Start date from (yyyy-mm-dd or relative: +/-Xd/w/m/y)", "type": "text/plain" }, "disabled": true, "key": "startdatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Start date to (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "startdateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date to (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Complete date from (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "completedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Complete date to (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "completedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified from in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified to in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter projects with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter projects with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,startdate,duedate,completedate,companyname,categoryname,priority)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] }, { "event": [], "id": "cb3cc205-b200-4008-91e7-49ac788909fb", "name": "/contacts/:contactid/projects", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"projectid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Adds a Contact to one or more Projects.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/contacts/:contactid/projects", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "projects" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2d8b0d48-9805-4130-8f25-6856bd9066bc", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"projectid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "projects" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f236b448-a93f-4f5a-9d5d-35d58d4ea594", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"projectid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "projects" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "951fa8b1-4a68-4f4c-af64-9dd76a04c8bf", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"projectid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "projects" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8f077cbf-3de6-4b8c-8002-88369836656f", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"projectid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "projects" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] }, { "event": [], "id": "64afa61b-c50e-4dc8-85b6-84eb6fd08a9a", "name": "/contacts/:contactid/projects", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"projectid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Removes a Contact from one or more Projects.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/contacts/:contactid/projects", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "projects" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "219004b8-b31c-4330-97a3-9520bc7bf025", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"projectid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "projects" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7aec4098-d0b3-4832-9c87-9b7c0e12fdfa", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"projectid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "projects" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "31bb2d04-f53c-40ac-abcf-4a118b920c0e", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"projectid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "projects" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d5531589-222d-456b-a418-70bbb6d7efd2", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"projectid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "projects" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] }, { "event": [], "id": "856262f6-f3a6-42ec-bf3f-4247d5de7d42", "name": "/contacts/:contactid/roles", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of roles for a Staff Contact.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/contacts/:contactid/roles", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "roles" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"displayorder\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"displayorder\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a2aab52f-0a14-416d-99cb-e8a9169b078c", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "roles" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "44180f12-ae5d-4b3d-8b00-93b1e75bfa13", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "roles" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6bc10f0c-ef0a-48d7-9a6b-15ddde73b00c", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "roles" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4beac6fd-af17-45f0-bdb1-48f7c537beb9", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "roles" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7498f932-f066-404d-a9e8-ddf27858374c", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "roles" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "80ba96c4-7925-440f-b520-56f1bfced5cb", "name": "/contacts/:contactid/roles", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"roleid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Assigns one or more Roles to a Staff Contact.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/contacts/:contactid/roles", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "roles" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7e891b23-8bed-422f-93a9-20b6d17b4970", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"roleid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "roles" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a44f854c-607e-407a-a56c-6f48b9ce0b3d", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"roleid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "roles" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "bbb0570f-1143-4fc4-aee8-fdbef28b3de5", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"roleid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "roles" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "da5b34e6-d2cf-40ec-af21-6ab9c2e35a0f", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"roleid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "roles" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] }, { "event": [], "id": "45797cbf-5c14-484a-aec8-91655389f083", "name": "/contacts/:contactid/roles", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"roleid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Removes one or more Roles from a Staff Contact.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/contacts/:contactid/roles", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "roles" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "95112f6a-9607-4743-8240-abb6603d2b29", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"roleid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "roles" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "0fe8f343-a0b0-4bac-bd2a-0dec7efc64b8", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"roleid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "roles" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "bb0d4fab-2e25-4df2-adcd-eb134207bcff", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"roleid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "roles" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "38b5f993-32ca-4bec-a680-240ee777aed4", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"roleid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "roles" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] }, { "event": [], "id": "fb6a089c-bf0b-422a-99a8-ebb1acdba59d", "name": "/contacts/:contactid/tags", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of tags linked to the specified Contact.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/contacts/:contactid/tags", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "tags" ], "query": [ { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Tags modified on or after this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Tags modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" } ], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5dbd383d-e790-4848-8f2f-426330ce0b2c", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "tags" ], "query": [ { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Tags modified on or after this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Tags modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" } ], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "22c6453b-da46-478a-9eec-0c2c064e5032", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "tags" ], "query": [ { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Tags modified on or after this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Tags modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" } ], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f1b038cd-bcbc-4f19-bd18-a8f0118b7295", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "tags" ], "query": [ { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Tags modified on or after this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Tags modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" } ], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "1e4bcabd-c921-4595-a82c-0f4a98edda4b", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "tags" ], "query": [ { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Tags modified on or after this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Tags modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" } ], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ec2c3dae-1d5f-4008-9352-215b9360ca46", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "tags" ], "query": [ { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Tags modified on or after this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Tags modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" } ], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "1cdb8c3e-60a9-469b-992b-e7502aa18da3", "name": "/contacts/:contactid/tags", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Updates the tags linked to a Contact.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/contacts/:contactid/tags", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "tags" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "afb19e52-ff08-40f2-9dca-d16b09975be3", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "tags" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "1d0183e6-02ad-4eee-8b8a-3aba1e0fddbd", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "tags" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b3af9e70-f7d4-4fb0-bc55-dcd02a770a69", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "tags" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "93954b9c-9a24-4c85-bbe9-af973b5c9e4b", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "tags" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "29ab7575-11ae-40e4-9a5a-417b057d0bca", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "tags" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "6f00ca83-8a3c-4bb0-be3a-436014966a3b", "name": "/contacts/:contactid/time", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Time Records tracked by the specified Contact. No default date range is applied — all time for the contact is returned unless trackedfrom/trackedto are specified.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/contacts/:contactid/time", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "time" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: contact, item, project, company, dates, timetracked, notes, billable, lastmodified", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "contact,item,dates,timetracked" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project Category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or after this date. Accepts yyyy-mm-dd or relative: -6d, -1w", "type": "text/plain" }, "disabled": true, "key": "trackedfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or before this date. Accepts yyyy-mm-dd or relative: +0d", "type": "text/plain" }, "disabled": true, "key": "trackedto", "value": "\u003cstring\u003e" }, { "description": { "content": "Billable filter (This can only be one of billable,nonbillable,all)", "type": "text/plain" }, "disabled": true, "key": "billable", "value": "all" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Filter by item activeworkstate (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Search by notes. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchnotes", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by item name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchitem", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or after this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Time Record IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,date,projectid,itemid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"accountedfor\": \"\u003cboolean\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"contactname\": \"\u003cstring\u003e\",\n \"endtime\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"itemname\": \"\u003cstring\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"notes\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeallocationid\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n },\n {\n \"accountedfor\": \"\u003cboolean\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"contactname\": \"\u003cstring\u003e\",\n \"endtime\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"itemname\": \"\u003cstring\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"notes\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeallocationid\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f290896d-789e-4bcd-8a34-cd059a6d65a3", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "time" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: contact, item, project, company, dates, timetracked, notes, billable, lastmodified", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "contact,item,dates,timetracked" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project Category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or after this date. Accepts yyyy-mm-dd or relative: -6d, -1w", "type": "text/plain" }, "disabled": true, "key": "trackedfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or before this date. Accepts yyyy-mm-dd or relative: +0d", "type": "text/plain" }, "disabled": true, "key": "trackedto", "value": "\u003cstring\u003e" }, { "description": { "content": "Billable filter (This can only be one of billable,nonbillable,all)", "type": "text/plain" }, "disabled": true, "key": "billable", "value": "all" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Filter by item activeworkstate (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Search by notes. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchnotes", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by item name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchitem", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or after this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Time Record IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,date,projectid,itemid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4c1f2786-8a71-4d05-9117-2f36ffb14813", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "time" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: contact, item, project, company, dates, timetracked, notes, billable, lastmodified", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "contact,item,dates,timetracked" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project Category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or after this date. Accepts yyyy-mm-dd or relative: -6d, -1w", "type": "text/plain" }, "disabled": true, "key": "trackedfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or before this date. Accepts yyyy-mm-dd or relative: +0d", "type": "text/plain" }, "disabled": true, "key": "trackedto", "value": "\u003cstring\u003e" }, { "description": { "content": "Billable filter (This can only be one of billable,nonbillable,all)", "type": "text/plain" }, "disabled": true, "key": "billable", "value": "all" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Filter by item activeworkstate (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Search by notes. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchnotes", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by item name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchitem", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or after this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Time Record IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,date,projectid,itemid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b4b7142f-2e90-4180-9af9-b1790528830f", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "time" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: contact, item, project, company, dates, timetracked, notes, billable, lastmodified", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "contact,item,dates,timetracked" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project Category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or after this date. Accepts yyyy-mm-dd or relative: -6d, -1w", "type": "text/plain" }, "disabled": true, "key": "trackedfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or before this date. Accepts yyyy-mm-dd or relative: +0d", "type": "text/plain" }, "disabled": true, "key": "trackedto", "value": "\u003cstring\u003e" }, { "description": { "content": "Billable filter (This can only be one of billable,nonbillable,all)", "type": "text/plain" }, "disabled": true, "key": "billable", "value": "all" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Filter by item activeworkstate (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Search by notes. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchnotes", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by item name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchitem", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or after this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Time Record IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,date,projectid,itemid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "aac684e9-cb14-4ab4-93f2-42073a74a1a9", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "time" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: contact, item, project, company, dates, timetracked, notes, billable, lastmodified", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "contact,item,dates,timetracked" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project Category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or after this date. Accepts yyyy-mm-dd or relative: -6d, -1w", "type": "text/plain" }, "disabled": true, "key": "trackedfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or before this date. Accepts yyyy-mm-dd or relative: +0d", "type": "text/plain" }, "disabled": true, "key": "trackedto", "value": "\u003cstring\u003e" }, { "description": { "content": "Billable filter (This can only be one of billable,nonbillable,all)", "type": "text/plain" }, "disabled": true, "key": "billable", "value": "all" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Filter by item activeworkstate (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Search by notes. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchnotes", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by item name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "searchitem", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or after this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date in UTC", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Time Record IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,date,projectid,itemid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] }, { "event": [], "id": "2417b738-fac1-4e77-ad30-10f68f93e842", "name": "/projects/:projectid/contacts", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns the Contacts assigned to a Project (staff, clients, contractors, and the project manager).", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/projects/:projectid/contacts", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "contacts" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: address, company, image, lastmodified, name, roles, type", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,company,type" }, { "description": { "content": "Search by name. Use ! prefix for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by email. Use ! prefix for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by contact type (This can only be one of client,contractor,staff,other)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "client" }, { "description": { "content": "Tag ID or comma-separated list of Tag IDs", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Role ID or comma-separated list of Role IDs", "type": "text/plain" }, "disabled": true, "key": "roleid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group ID or comma-separated list of Group IDs", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "true" }, { "description": { "content": "Filter by login access (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "true" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Contacts modified on or after this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts modified on or before this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cinteger\u003e" }, { "description": { "content": "Contacts with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cinteger\u003e" }, { "description": { "content": "Comma-separated list of Contact IDs", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,firstname,lastname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "firstname" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"allowlogin\": \"\u003cboolean\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"defaulthourlyrateid\": \"\u003cinteger\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"fax\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"groups\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"ianatimezone\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"notes\": [\n {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n },\n {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n }\n ],\n \"payrate\": \"\u003cnumber\u003e\",\n \"payratemultiplier\": \"\u003cnumber\u003e\",\n \"pending\": \"\u003cboolean\u003e\",\n \"roles\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"state\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\",\n \"tags\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"teams\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"title\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"username\": \"\u003cstring\u003e\",\n \"workphone\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n },\n {\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"allowlogin\": \"\u003cboolean\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"defaulthourlyrateid\": \"\u003cinteger\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"fax\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"groups\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"ianatimezone\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"notes\": [\n {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n },\n {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n }\n ],\n \"payrate\": \"\u003cnumber\u003e\",\n \"payratemultiplier\": \"\u003cnumber\u003e\",\n \"pending\": \"\u003cboolean\u003e\",\n \"roles\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"state\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\",\n \"tags\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"teams\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"title\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"username\": \"\u003cstring\u003e\",\n \"workphone\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "aa166afe-bc79-498c-81c5-bf5251ca18b7", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "contacts" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: address, company, image, lastmodified, name, roles, type", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,company,type" }, { "description": { "content": "Search by name. Use ! prefix for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by email. Use ! prefix for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by contact type (This can only be one of client,contractor,staff,other)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "client" }, { "description": { "content": "Tag ID or comma-separated list of Tag IDs", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Role ID or comma-separated list of Role IDs", "type": "text/plain" }, "disabled": true, "key": "roleid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group ID or comma-separated list of Group IDs", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "true" }, { "description": { "content": "Filter by login access (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "true" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Contacts modified on or after this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts modified on or before this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cinteger\u003e" }, { "description": { "content": "Contacts with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cinteger\u003e" }, { "description": { "content": "Comma-separated list of Contact IDs", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,firstname,lastname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "firstname" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e202c5a2-9a80-4421-b0c1-6856bf12c30e", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "contacts" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: address, company, image, lastmodified, name, roles, type", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,company,type" }, { "description": { "content": "Search by name. Use ! prefix for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by email. Use ! prefix for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by contact type (This can only be one of client,contractor,staff,other)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "client" }, { "description": { "content": "Tag ID or comma-separated list of Tag IDs", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Role ID or comma-separated list of Role IDs", "type": "text/plain" }, "disabled": true, "key": "roleid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group ID or comma-separated list of Group IDs", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "true" }, { "description": { "content": "Filter by login access (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "true" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Contacts modified on or after this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts modified on or before this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cinteger\u003e" }, { "description": { "content": "Contacts with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cinteger\u003e" }, { "description": { "content": "Comma-separated list of Contact IDs", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,firstname,lastname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "firstname" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "cc3d7e4a-ba96-43d0-9a41-86c779ac4502", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "contacts" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: address, company, image, lastmodified, name, roles, type", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,company,type" }, { "description": { "content": "Search by name. Use ! prefix for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by email. Use ! prefix for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by contact type (This can only be one of client,contractor,staff,other)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "client" }, { "description": { "content": "Tag ID or comma-separated list of Tag IDs", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Role ID or comma-separated list of Role IDs", "type": "text/plain" }, "disabled": true, "key": "roleid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group ID or comma-separated list of Group IDs", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "true" }, { "description": { "content": "Filter by login access (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "true" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Contacts modified on or after this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts modified on or before this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cinteger\u003e" }, { "description": { "content": "Contacts with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cinteger\u003e" }, { "description": { "content": "Comma-separated list of Contact IDs", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,firstname,lastname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "firstname" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "cc7b76bf-a574-470f-ab35-914d8d700d07", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "contacts" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: address, company, image, lastmodified, name, roles, type", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,company,type" }, { "description": { "content": "Search by name. Use ! prefix for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by email. Use ! prefix for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by contact type (This can only be one of client,contractor,staff,other)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "client" }, { "description": { "content": "Tag ID or comma-separated list of Tag IDs", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Role ID or comma-separated list of Role IDs", "type": "text/plain" }, "disabled": true, "key": "roleid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group ID or comma-separated list of Group IDs", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "true" }, { "description": { "content": "Filter by login access (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "true" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Contacts modified on or after this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts modified on or before this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cinteger\u003e" }, { "description": { "content": "Contacts with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cinteger\u003e" }, { "description": { "content": "Comma-separated list of Contact IDs", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,firstname,lastname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "firstname" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "1becf1bf-e616-4b12-b2f4-cf8e68f863cf", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "contacts" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: address, company, image, lastmodified, name, roles, type", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,company,type" }, { "description": { "content": "Search by name. Use ! prefix for negation", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by email. Use ! prefix for negation", "type": "text/plain" }, "disabled": true, "key": "searchemail", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by contact type (This can only be one of client,contractor,staff,other)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "client" }, { "description": { "content": "Tag ID or comma-separated list of Tag IDs", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Role ID or comma-separated list of Role IDs", "type": "text/plain" }, "disabled": true, "key": "roleid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group ID or comma-separated list of Group IDs", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by pending status (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "pending", "value": "true" }, { "description": { "content": "Filter by login access (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "true" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Contacts modified on or after this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts modified on or before this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cinteger\u003e" }, { "description": { "content": "Contacts with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cinteger\u003e" }, { "description": { "content": "Comma-separated list of Contact IDs", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,firstname,lastname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "firstname" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "212d7943-dfb3-41e9-83f5-b68b01b5366c", "name": "/projects/:projectid/contacts", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Updates the Contacts assigned to a Project.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/projects/:projectid/contacts", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "contacts" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "974dda8b-db1b-43b2-9d9e-fac475a268ad", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "contacts" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f71950ce-bc6c-4b46-9370-53576f80d6cc", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "contacts" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "72eca788-4485-4d92-96e1-4ccd36db466a", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "contacts" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "13d09b91-f748-46b1-b91d-b1e18bbb1881", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "contacts" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ec5e1eeb-aa38-4f36-825b-3a623facc91c", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "contacts" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "2cae522c-1dce-4979-acee-29ca7fc30cc0", "name": "/projects/:projectid/contacts", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Removes one or more Contacts from a Project.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/projects/:projectid/contacts", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "contacts" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "47d4404b-1c63-4ab3-89b2-eeab0387e055", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "contacts" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "eca8b5b6-ab34-472a-a123-a5a3eb9a9bf9", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "contacts" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f1647761-9a7b-45a6-9bd5-23adfa59565a", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "contacts" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d40f9b95-10d5-4ca7-bc57-947c72d6ab45", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "contacts" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] } ], "name": "contacts" }, { "event": [], "id": "d8a34ebd-0436-42b2-9c9a-ed375fec800e", "name": "/contacts/:contactid/notes/:noteid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": {}, "method": "DELETE", "name": "/contacts/:contactid/notes/:noteid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "notes", ":noteid" ], "query": [], "variable": [ { "key": "contactid", "type": "any" }, { "key": "noteid", "type": "any" } ] } }, "response": [] }, { "description": "", "item": [ { "event": [], "id": "8e1a82b2-4773-43ec-a137-aeb654373d86", "name": "/files", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Files based on the filters specified. The fields parameter allows you to choose which data fields to return for each File.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/files", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: name, description, size, project, projectnumber, projecttitle, item (or task), itemname (or taskname), folder, foldername, contactids, date, owner, link, all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,project,item,date,size,link" }, { "description": { "content": "Search by file name. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "active" }, { "description": { "content": "Project ID or list of Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by item activeworkstate (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Alias for activeworkstate parameter. (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "deleted" }, { "description": { "content": "Item (task) ID or list of IDs (comma-separated). Alias: taskid", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Alias for itemid parameter.", "type": "text/plain" }, "disabled": true, "key": "taskid", "value": "\u003cstring\u003e" }, { "description": { "content": "Folder ID or list of Folder IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "folderid", "value": "\u003cstring\u003e" }, { "description": { "content": "Files modified on or after this date (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "datefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Files modified on or before this date (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "dateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Files with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Files with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of File IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,size,date,itemid,taskid,folderid,projectid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"contactids\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"folderid\": \"\u003cinteger\u003e\",\n \"foldername\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"itemname\": \"\u003cstring\u003e\",\n \"link\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"size\": \"\u003cinteger\u003e\"\n },\n {\n \"contactids\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"folderid\": \"\u003cinteger\u003e\",\n \"foldername\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"itemname\": \"\u003cstring\u003e\",\n \"link\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"size\": \"\u003cinteger\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d944e12b-a39a-4d6d-9145-d6c7f3c4b4e3", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: name, description, size, project, projectnumber, projecttitle, item (or task), itemname (or taskname), folder, foldername, contactids, date, owner, link, all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,project,item,date,size,link" }, { "description": { "content": "Search by file name. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "active" }, { "description": { "content": "Project ID or list of Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by item activeworkstate (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Alias for activeworkstate parameter. (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "deleted" }, { "description": { "content": "Item (task) ID or list of IDs (comma-separated). Alias: taskid", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Alias for itemid parameter.", "type": "text/plain" }, "disabled": true, "key": "taskid", "value": "\u003cstring\u003e" }, { "description": { "content": "Folder ID or list of Folder IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "folderid", "value": "\u003cstring\u003e" }, { "description": { "content": "Files modified on or after this date (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "datefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Files modified on or before this date (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "dateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Files with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Files with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of File IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,size,date,itemid,taskid,folderid,projectid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ce675e95-b730-4c55-b335-ad18c9001f16", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: name, description, size, project, projectnumber, projecttitle, item (or task), itemname (or taskname), folder, foldername, contactids, date, owner, link, all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,project,item,date,size,link" }, { "description": { "content": "Search by file name. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "active" }, { "description": { "content": "Project ID or list of Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by item activeworkstate (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Alias for activeworkstate parameter. (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "deleted" }, { "description": { "content": "Item (task) ID or list of IDs (comma-separated). Alias: taskid", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Alias for itemid parameter.", "type": "text/plain" }, "disabled": true, "key": "taskid", "value": "\u003cstring\u003e" }, { "description": { "content": "Folder ID or list of Folder IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "folderid", "value": "\u003cstring\u003e" }, { "description": { "content": "Files modified on or after this date (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "datefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Files modified on or before this date (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "dateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Files with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Files with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of File IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,size,date,itemid,taskid,folderid,projectid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "99709e52-c5e7-4420-9930-801a58a5d31e", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: name, description, size, project, projectnumber, projecttitle, item (or task), itemname (or taskname), folder, foldername, contactids, date, owner, link, all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,project,item,date,size,link" }, { "description": { "content": "Search by file name. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "active" }, { "description": { "content": "Project ID or list of Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by item activeworkstate (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Alias for activeworkstate parameter. (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "deleted" }, { "description": { "content": "Item (task) ID or list of IDs (comma-separated). Alias: taskid", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Alias for itemid parameter.", "type": "text/plain" }, "disabled": true, "key": "taskid", "value": "\u003cstring\u003e" }, { "description": { "content": "Folder ID or list of Folder IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "folderid", "value": "\u003cstring\u003e" }, { "description": { "content": "Files modified on or after this date (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "datefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Files modified on or before this date (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "dateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Files with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Files with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of File IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,size,date,itemid,taskid,folderid,projectid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8fe34e50-3ccc-4dd6-bc30-e401074b0f5e", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: name, description, size, project, projectnumber, projecttitle, item (or task), itemname (or taskname), folder, foldername, contactids, date, owner, link, all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,project,item,date,size,link" }, { "description": { "content": "Search by file name. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "active" }, { "description": { "content": "Project ID or list of Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by item activeworkstate (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Alias for activeworkstate parameter. (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "deleted" }, { "description": { "content": "Item (task) ID or list of IDs (comma-separated). Alias: taskid", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Alias for itemid parameter.", "type": "text/plain" }, "disabled": true, "key": "taskid", "value": "\u003cstring\u003e" }, { "description": { "content": "Folder ID or list of Folder IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "folderid", "value": "\u003cstring\u003e" }, { "description": { "content": "Files modified on or after this date (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "datefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Files modified on or before this date (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "dateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Files with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Files with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of File IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,size,date,itemid,taskid,folderid,projectid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "d1c2e75a-57bf-42a5-a343-6d9df7fa6c84", "name": "/files/:fileid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns full details of a single File by ID. Access is scoped by the authenticated user's project membership.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/files/:fileid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", ":fileid" ], "query": [], "variable": [ { "description": { "content": "(Required) File ID", "type": "text/plain" }, "disabled": false, "key": "fileid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"contactids\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"folderid\": \"\u003cinteger\u003e\",\n \"foldername\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"itemname\": \"\u003cstring\u003e\",\n \"link\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"size\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "1b0cd05b-1ca1-4403-b461-1d47a91e3cf3", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", ":fileid" ], "query": [], "variable": [ { "description": { "content": "(Required) File ID", "type": "text/plain" }, "disabled": false, "key": "fileid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "047112be-d578-4196-b209-b4b93dfb3fab", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", ":fileid" ], "query": [], "variable": [ { "description": { "content": "(Required) File ID", "type": "text/plain" }, "disabled": false, "key": "fileid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "0df15780-fefc-4ea6-803a-bd0d931ca2fd", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", ":fileid" ], "query": [], "variable": [ { "description": { "content": "(Required) File ID", "type": "text/plain" }, "disabled": false, "key": "fileid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5a1172cb-f1d7-44ad-bc7d-ae95d1d3527f", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", ":fileid" ], "query": [], "variable": [ { "description": { "content": "(Required) File ID", "type": "text/plain" }, "disabled": false, "key": "fileid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8e823b3b-e1eb-471b-a045-d044200e3775", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", ":fileid" ], "query": [], "variable": [ { "description": { "content": "(Required) File ID", "type": "text/plain" }, "disabled": false, "key": "fileid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "71651a88-ee7d-48d9-87a7-c2b1b37401c9", "name": "/files/:fileid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Soft-delete a File by ID.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/files/:fileid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", ":fileid" ], "query": [], "variable": [ { "description": { "content": "(Required) File ID", "type": "text/plain" }, "disabled": false, "key": "fileid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d8fbb506-a1d4-48cf-a682-6a6668328601", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", ":fileid" ], "query": [], "variable": [ { "description": { "content": "(Required) File ID", "type": "text/plain" }, "disabled": false, "key": "fileid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "623da3a6-c0b4-4220-a1ff-5dddd15098d7", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", ":fileid" ], "query": [], "variable": [ { "description": { "content": "(Required) File ID", "type": "text/plain" }, "disabled": false, "key": "fileid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "24d4d0e9-e391-4a63-97ab-49dfb7ba33e2", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", ":fileid" ], "query": [], "variable": [ { "description": { "content": "(Required) File ID", "type": "text/plain" }, "disabled": false, "key": "fileid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "bcdc5ee0-71d0-46db-90f3-81d73a1205cc", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", ":fileid" ], "query": [], "variable": [ { "description": { "content": "(Required) File ID", "type": "text/plain" }, "disabled": false, "key": "fileid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "1cb6fbea-8f85-4946-857e-ec29173c8db1", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", ":fileid" ], "query": [], "variable": [ { "description": { "content": "(Required) File ID", "type": "text/plain" }, "disabled": false, "key": "fileid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "cb7ccd48-5a30-432d-9c37-f37bf048f753", "name": "/files/:fileid/download", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Downloads the binary content of a File by ID. Returns the raw file with Content-Type inferred from the file extension and Content-Disposition set to attachment. Note: use curl or an API client to download — Swagger UI cannot render binary responses.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/octet-stream" } ], "method": "GET", "name": "/files/:fileid/download", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", ":fileid", "download" ], "query": [], "variable": [ { "description": { "content": "(Required) File ID", "type": "text/plain" }, "disabled": false, "key": "fileid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "text", "body": "\u003cbinary\u003e", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/octet-stream" } ], "id": "ab64e948-5725-4dec-a48e-f057bd6c58ce", "name": "File content", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/octet-stream" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", ":fileid", "download" ], "query": [], "variable": [ { "description": { "content": "(Required) File ID", "type": "text/plain" }, "disabled": false, "key": "fileid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "text", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/octet-stream" } ], "id": "16ddee84-ee7b-428e-ab0b-5a10fccac543", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/octet-stream" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", ":fileid", "download" ], "query": [], "variable": [ { "description": { "content": "(Required) File ID", "type": "text/plain" }, "disabled": false, "key": "fileid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "text", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/octet-stream" } ], "id": "030b2531-2568-451f-9a01-e7d7a6711716", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/octet-stream" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", ":fileid", "download" ], "query": [], "variable": [ { "description": { "content": "(Required) File ID", "type": "text/plain" }, "disabled": false, "key": "fileid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "text", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/octet-stream" } ], "id": "b33429ba-9f79-45e4-9d78-619c5a87b34c", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/octet-stream" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", ":fileid", "download" ], "query": [], "variable": [ { "description": { "content": "(Required) File ID", "type": "text/plain" }, "disabled": false, "key": "fileid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "text", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/octet-stream" } ], "id": "edb9b1ef-80d6-4201-8648-0e469654bc49", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/octet-stream" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", ":fileid", "download" ], "query": [], "variable": [ { "description": { "content": "(Required) File ID", "type": "text/plain" }, "disabled": false, "key": "fileid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] } ], "name": "files" }, { "description": "", "item": [ { "event": [], "id": "ec888afa-3eac-4ce3-916e-42dfc258c13d", "name": "/files/folders", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Custom Folders based on the specified filters. Access is scoped by the authenticated user's project membership (staff see all, clients/contractors see their linked projects only). Only returns folders of type 'custom'.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/files/folders", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", "folders" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: name, description, type, size, date, owner, contacts, project, item (or task), public", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,project" }, { "description": { "content": "Search by folder name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "active" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Folders with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Folders with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Folder IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,projectid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"contacts\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"contacts\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "92896062-0731-49f3-8478-5ca02d9cdfa6", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", "folders" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: name, description, type, size, date, owner, contacts, project, item (or task), public", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,project" }, { "description": { "content": "Search by folder name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "active" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Folders with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Folders with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Folder IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,projectid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "196f5ad1-f476-4623-b17b-470c941886b2", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", "folders" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: name, description, type, size, date, owner, contacts, project, item (or task), public", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,project" }, { "description": { "content": "Search by folder name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "active" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Folders with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Folders with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Folder IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,projectid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9c76714b-1a96-4f7f-96f4-2066a49e09fe", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", "folders" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: name, description, type, size, date, owner, contacts, project, item (or task), public", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,project" }, { "description": { "content": "Search by folder name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "active" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Folders with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Folders with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Folder IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,projectid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e0c1ea1b-ccf4-438f-afae-06ba80691010", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", "folders" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: name, description, type, size, date, owner, contacts, project, item (or task), public", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,project" }, { "description": { "content": "Search by folder name. Use ! for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "active" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Folders with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Folders with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Folder IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,projectid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "0cbfb02e-3795-4d16-ac99-fc4eba5917a7", "name": "/files/folders", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Creates a custom folder within a project.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/files/folders", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", "folders" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e8b33a57-efc6-4cff-acbf-9f3063740ac8", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", "folders" ], "query": [], "variable": [] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4545102f-9ceb-4611-89fc-eb23bb75b988", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", "folders" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "92cf44c5-3a11-4f33-8389-391e71442af6", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", "folders" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "00462f2c-60b0-41e0-9f8f-869d187bd7d6", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", "folders" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "5ea2c4ec-1a61-432e-bce0-c11133ca9120", "name": "/files/folders/:folderid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns full details of a single Custom Folder by ID. Access is scoped by the authenticated user's project membership (staff see all, clients/contractors see their linked projects only).", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/files/folders/:folderid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", "folders", ":folderid" ], "query": [], "variable": [ { "description": { "content": "(Required) Folder ID", "type": "text/plain" }, "disabled": false, "key": "folderid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"contacts\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "266fd4d0-ac3d-4d9a-a9a0-7458222fa5b0", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", "folders", ":folderid" ], "query": [], "variable": [ { "description": { "content": "(Required) Folder ID", "type": "text/plain" }, "disabled": false, "key": "folderid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8d68c9af-8b6b-4c53-b70c-8f3a1b7267d8", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", "folders", ":folderid" ], "query": [], "variable": [ { "description": { "content": "(Required) Folder ID", "type": "text/plain" }, "disabled": false, "key": "folderid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8016bb01-5a86-421c-9e1f-c50b30056851", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", "folders", ":folderid" ], "query": [], "variable": [ { "description": { "content": "(Required) Folder ID", "type": "text/plain" }, "disabled": false, "key": "folderid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "93d361fa-a3d9-4a29-8619-f3c033e9ccb7", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", "folders", ":folderid" ], "query": [], "variable": [ { "description": { "content": "(Required) Folder ID", "type": "text/plain" }, "disabled": false, "key": "folderid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "597b55d6-7d4f-415b-bd09-a7e40ff081af", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", "folders", ":folderid" ], "query": [], "variable": [ { "description": { "content": "(Required) Folder ID", "type": "text/plain" }, "disabled": false, "key": "folderid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "6a72118c-aff6-4e3f-8196-5c960596a257", "name": "/files/folders/:folderid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Updates an existing custom folder.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/files/folders/:folderid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", "folders", ":folderid" ], "query": [], "variable": [ { "description": { "content": "(Required) Folder ID", "type": "text/plain" }, "disabled": false, "key": "folderid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c62ae1fd-a2fd-4133-b23a-45d2281c15eb", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", "folders", ":folderid" ], "query": [], "variable": [ { "description": { "content": "(Required) Folder ID", "type": "text/plain" }, "disabled": false, "key": "folderid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "abe2c6cf-7266-4c25-a946-3d1e10ec0c7a", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", "folders", ":folderid" ], "query": [], "variable": [ { "description": { "content": "(Required) Folder ID", "type": "text/plain" }, "disabled": false, "key": "folderid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c575ca25-ad1a-4f0e-8f8b-6d2fee88943d", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", "folders", ":folderid" ], "query": [], "variable": [ { "description": { "content": "(Required) Folder ID", "type": "text/plain" }, "disabled": false, "key": "folderid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "dc3e5abc-841a-47be-954e-1759e3f3f4fd", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", "folders", ":folderid" ], "query": [], "variable": [ { "description": { "content": "(Required) Folder ID", "type": "text/plain" }, "disabled": false, "key": "folderid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "cb156122-e361-48a1-9918-06b9fa6533d2", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", "folders", ":folderid" ], "query": [], "variable": [ { "description": { "content": "(Required) Folder ID", "type": "text/plain" }, "disabled": false, "key": "folderid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "aa4344d2-a6f0-4b7c-90c9-9bded41dde88", "name": "/files/folders/:folderid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Deletes a custom folder by ID.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/files/folders/:folderid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", "folders", ":folderid" ], "query": [], "variable": [ { "description": { "content": "(Required) Folder ID", "type": "text/plain" }, "disabled": false, "key": "folderid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "bb654bc5-267b-42bd-88cc-afa99628a958", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", "folders", ":folderid" ], "query": [], "variable": [ { "description": { "content": "(Required) Folder ID", "type": "text/plain" }, "disabled": false, "key": "folderid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "131730bf-eeeb-418e-9462-89686c1c7cb0", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", "folders", ":folderid" ], "query": [], "variable": [ { "description": { "content": "(Required) Folder ID", "type": "text/plain" }, "disabled": false, "key": "folderid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6db812af-0c54-4cff-97fb-093ad0d07124", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", "folders", ":folderid" ], "query": [], "variable": [ { "description": { "content": "(Required) Folder ID", "type": "text/plain" }, "disabled": false, "key": "folderid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3a6f96cd-33db-4483-9508-aa4b9e6715ed", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", "folders", ":folderid" ], "query": [], "variable": [ { "description": { "content": "(Required) Folder ID", "type": "text/plain" }, "disabled": false, "key": "folderid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "69c343fd-7e01-47cf-8daa-2775fad42ed0", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", "folders", ":folderid" ], "query": [], "variable": [ { "description": { "content": "(Required) Folder ID", "type": "text/plain" }, "disabled": false, "key": "folderid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "2cdfb57a-74d1-47a5-85dd-91c7a8080f6c", "name": "/files/folders/:folderid/files", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" } ], "mode": "formdata" }, "description": { "content": "Upload a file to a Folder. Send a multipart/form-data request with the file in the \"file\" field. The folder may be a custom folder, project root, or task folder — the file is placed in the corresponding location on disk. Blocked extensions: exe, msi, ini, bin, bat, cfm, cfc, asp, aspx, php, config, vb, java, pl.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/files/folders/:folderid/files", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", "folders", ":folderid", "files" ], "query": [], "variable": [ { "description": { "content": "(Required) Folder ID", "type": "text/plain" }, "disabled": false, "key": "folderid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"fileid\": \"\u003cinteger\u003e\",\n \"filesize\": \"\u003cinteger\u003e\",\n \"folderid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "95471773-0804-4290-827b-e7fd9006df8c", "name": "Created", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" } ], "mode": "formdata" }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", "folders", ":folderid", "files" ], "query": [], "variable": [ { "description": { "content": "(Required) Folder ID", "type": "text/plain" }, "disabled": false, "key": "folderid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "df53b93a-7418-4529-92df-c7bfd4c97852", "name": "Bad Request", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" } ], "mode": "formdata" }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", "folders", ":folderid", "files" ], "query": [], "variable": [ { "description": { "content": "(Required) Folder ID", "type": "text/plain" }, "disabled": false, "key": "folderid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "df34da40-3017-4a88-b4ef-ab44d5441a40", "name": "Unauthorized", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" } ], "mode": "formdata" }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", "folders", ":folderid", "files" ], "query": [], "variable": [ { "description": { "content": "(Required) Folder ID", "type": "text/plain" }, "disabled": false, "key": "folderid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f24f4f3d-4b14-4b60-b469-fdfcfa8b5452", "name": "Forbidden", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" } ], "mode": "formdata" }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", "folders", ":folderid", "files" ], "query": [], "variable": [ { "description": { "content": "(Required) Folder ID", "type": "text/plain" }, "disabled": false, "key": "folderid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8607050d-bf63-40b2-8f83-265ebb62b2cf", "name": "Not Found", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" } ], "mode": "formdata" }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", "folders", ":folderid", "files" ], "query": [], "variable": [ { "description": { "content": "(Required) Folder ID", "type": "text/plain" }, "disabled": false, "key": "folderid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] } ], "name": "folders" }, { "description": "", "item": [ { "event": [], "id": "49be3ebd-ad40-40fb-9c71-680edf754bc8", "name": "/invoices", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Invoices based on the filters specified. Optionally returns subtotals grouped by company, project, status, or time period. Also returns the grand totals across all returned invoices.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/invoices", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- number - Invoice number/reference code\n- title - Invoice title\n- status - Invoice status (draft, submitted, authorised, paid, voided, deleted)\n- description - Invoice description (plain text, HTML stripped)\n- company - Client company ID and name\n- project - Associated project IDs, titles, and numbers as a comma-delimited list\n- projectid - Associated project IDs only (comma-separated if multiple)\n- dates - All date fields: invoiceddate, duedate, paiddate\n- invoiceddate - Invoice issue date (yyyy-mm-dd)\n- duedate - Payment due date (yyyy-mm-dd)\n- paiddate - Date payment was received (yyyy-mm-dd)\n- emaileddate - Date invoice was emailed (yyyy-mm-dd)\n- emailedto - Email address the invoice was sent to\n- emailedtoclient - Whether the invoice has been emailed to the client (boolean)\n- invoicedby - Full name of the contact who created the invoice\n- totals - Financial totals: subtotal, taxtotal, and grandtotal (all decimal, 2dp)\n- taxable - Whether the invoice is taxable (boolean)\n- taxrate - Tax rate as a percentage (decimal, e.g. 15.0)\n- purchaseordernumber - Client purchase order reference number\n- showcostbreakdown - Whether cost breakdown is displayed (boolean)\n- showitemdescription - Whether item descriptions are shown (boolean)\n- showphases - Whether phases are shown (boolean)\n- customfield - Custom field name and value pair\n- paid - Whether the invoice has been paid (boolean)\n- activeworkstageid - Active work stage ID\n- clientcontactname - Client contact name on the invoice\n- invoicetermid - Invoice payment term ID\n- paymentterms - Payment terms text (returned together with invoicetermid)\n- pagetitle - Page/PDF title of the invoice\n- address - All address fields: address1, address2, address3, city, state, zipcode, country\n- budget - Budget fields: budget, budgetTax, budgetType\n- billamount - Bill amount fields: billAmount, billAmountTax, billType\n- estbillamount - Estimated bill amount (sensitive)\n- estbillamounttax - Estimated bill amount including tax (sensitive)\n- itemsdiscount - Items discount value (sensitive)\n- timebillable - Billable time in minutes (sensitive)\n- template - Whether this invoice is a template (boolean)\n- lastmodified - Last modified date in ISO8601 format (UTC)\n- all - Returns all available scalar fieldsSub-entity fields (heavy — NOT included by all, must be named explicitly): phases - invoice phases and their line items. Use e.g. fields=all,phases or fields=phases.", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "number,title,company,status,totals,projectid,invoiceddate,duedate" }, { "description": { "content": "Deprecated: use number, title, or q+qfields instead. Search by number or title. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use number or q+qfields instead. Search by invoice number. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use title or q+qfields instead. Search by invoice title. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchtitle", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact number match", "type": "text/plain" }, "disabled": true, "key": "number", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact title match", "type": "text/plain" }, "disabled": true, "key": "title", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of number,title)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "number" }, { "description": { "content": "Status (activeworkstate). Alias: activeworkstate. (This can only be one of draft,submitted,authorised,paid,voided,deleted,all,unpaid)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "paid" }, { "description": { "content": "Alias for status. (This can only be one of draft,submitted,authorised,paid,voided,deleted,all,unpaid)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "paid" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project manager Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Project category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectcategoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter invoices by active work stage ID", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date from (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "invoiceddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "invoiceddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Paid date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "paiddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Paid date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "paiddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total minimum", "type": "text/plain" }, "disabled": true, "key": "grandtotalfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total maximum", "type": "text/plain" }, "disabled": true, "key": "grandtotalto", "value": "\u003cstring\u003e" }, { "description": { "content": "Group results by. Returns subtotals per group. (This can only be one of company,project,status,day,week,month,year)", "type": "text/plain" }, "disabled": true, "key": "subtotals", "value": "status" }, { "description": { "content": "Date field for subtotals grouping (This can only be one of invoiced,due,paid)", "type": "text/plain" }, "disabled": true, "key": "subtotalsdateoption", "value": "paid" }, { "description": { "content": "Invoices modified on or after this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoices modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoices with ID greater than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoices with ID less than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Invoice IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,invoiceddate,duedate,companyname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"clientcontactname\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"customfieldname\": \"\u003cstring\u003e\",\n \"customfieldvalue\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"emaileddate\": \"\u003cstring\u003e\",\n \"emailedto\": \"\u003cstring\u003e\",\n \"emailedtoclient\": \"\u003cboolean\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoicedby\": \"\u003cstring\u003e\",\n \"invoiceddate\": \"\u003cstring\u003e\",\n \"invoicetermid\": \"\u003cinteger\u003e\",\n \"itemsDiscount\": \"\u003cnumber\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"pagetitle\": \"\u003cstring\u003e\",\n \"paid\": \"\u003cboolean\u003e\",\n \"paiddate\": \"\u003cstring\u003e\",\n \"paymentterms\": \"\u003cstring\u003e\",\n \"phases\": [\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n }\n ],\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n },\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n }\n ],\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n }\n ],\n \"projectid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"projectnumbers\": \"\u003cstring\u003e\",\n \"projecttitles\": \"\u003cstring\u003e\",\n \"purchaseordernumber\": \"\u003cstring\u003e\",\n \"showcostbreakdown\": \"\u003cboolean\u003e\",\n \"showitemdescription\": \"\u003cboolean\u003e\",\n \"showphases\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"taxable\": \"\u003cboolean\u003e\",\n \"taxrate\": \"\u003cnumber\u003e\",\n \"taxtotal\": \"\u003cnumber\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n },\n {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"clientcontactname\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"customfieldname\": \"\u003cstring\u003e\",\n \"customfieldvalue\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"emaileddate\": \"\u003cstring\u003e\",\n \"emailedto\": \"\u003cstring\u003e\",\n \"emailedtoclient\": \"\u003cboolean\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoicedby\": \"\u003cstring\u003e\",\n \"invoiceddate\": \"\u003cstring\u003e\",\n \"invoicetermid\": \"\u003cinteger\u003e\",\n \"itemsDiscount\": \"\u003cnumber\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"pagetitle\": \"\u003cstring\u003e\",\n \"paid\": \"\u003cboolean\u003e\",\n \"paiddate\": \"\u003cstring\u003e\",\n \"paymentterms\": \"\u003cstring\u003e\",\n \"phases\": [\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n }\n ],\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n },\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n }\n ],\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n }\n ],\n \"projectid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"projectnumbers\": \"\u003cstring\u003e\",\n \"projecttitles\": \"\u003cstring\u003e\",\n \"purchaseordernumber\": \"\u003cstring\u003e\",\n \"showcostbreakdown\": \"\u003cboolean\u003e\",\n \"showitemdescription\": \"\u003cboolean\u003e\",\n \"showphases\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"taxable\": \"\u003cboolean\u003e\",\n \"taxrate\": \"\u003cnumber\u003e\",\n \"taxtotal\": \"\u003cnumber\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d1b47772-34a9-479d-9e92-41b0a2e96879", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- number - Invoice number/reference code\n- title - Invoice title\n- status - Invoice status (draft, submitted, authorised, paid, voided, deleted)\n- description - Invoice description (plain text, HTML stripped)\n- company - Client company ID and name\n- project - Associated project IDs, titles, and numbers as a comma-delimited list\n- projectid - Associated project IDs only (comma-separated if multiple)\n- dates - All date fields: invoiceddate, duedate, paiddate\n- invoiceddate - Invoice issue date (yyyy-mm-dd)\n- duedate - Payment due date (yyyy-mm-dd)\n- paiddate - Date payment was received (yyyy-mm-dd)\n- emaileddate - Date invoice was emailed (yyyy-mm-dd)\n- emailedto - Email address the invoice was sent to\n- emailedtoclient - Whether the invoice has been emailed to the client (boolean)\n- invoicedby - Full name of the contact who created the invoice\n- totals - Financial totals: subtotal, taxtotal, and grandtotal (all decimal, 2dp)\n- taxable - Whether the invoice is taxable (boolean)\n- taxrate - Tax rate as a percentage (decimal, e.g. 15.0)\n- purchaseordernumber - Client purchase order reference number\n- showcostbreakdown - Whether cost breakdown is displayed (boolean)\n- showitemdescription - Whether item descriptions are shown (boolean)\n- showphases - Whether phases are shown (boolean)\n- customfield - Custom field name and value pair\n- paid - Whether the invoice has been paid (boolean)\n- activeworkstageid - Active work stage ID\n- clientcontactname - Client contact name on the invoice\n- invoicetermid - Invoice payment term ID\n- paymentterms - Payment terms text (returned together with invoicetermid)\n- pagetitle - Page/PDF title of the invoice\n- address - All address fields: address1, address2, address3, city, state, zipcode, country\n- budget - Budget fields: budget, budgetTax, budgetType\n- billamount - Bill amount fields: billAmount, billAmountTax, billType\n- estbillamount - Estimated bill amount (sensitive)\n- estbillamounttax - Estimated bill amount including tax (sensitive)\n- itemsdiscount - Items discount value (sensitive)\n- timebillable - Billable time in minutes (sensitive)\n- template - Whether this invoice is a template (boolean)\n- lastmodified - Last modified date in ISO8601 format (UTC)\n- all - Returns all available scalar fieldsSub-entity fields (heavy — NOT included by all, must be named explicitly): phases - invoice phases and their line items. Use e.g. fields=all,phases or fields=phases.", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "number,title,company,status,totals,projectid,invoiceddate,duedate" }, { "description": { "content": "Deprecated: use number, title, or q+qfields instead. Search by number or title. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use number or q+qfields instead. Search by invoice number. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use title or q+qfields instead. Search by invoice title. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchtitle", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact number match", "type": "text/plain" }, "disabled": true, "key": "number", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact title match", "type": "text/plain" }, "disabled": true, "key": "title", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of number,title)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "number" }, { "description": { "content": "Status (activeworkstate). Alias: activeworkstate. (This can only be one of draft,submitted,authorised,paid,voided,deleted,all,unpaid)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "paid" }, { "description": { "content": "Alias for status. (This can only be one of draft,submitted,authorised,paid,voided,deleted,all,unpaid)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "paid" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project manager Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Project category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectcategoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter invoices by active work stage ID", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date from (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "invoiceddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "invoiceddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Paid date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "paiddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Paid date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "paiddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total minimum", "type": "text/plain" }, "disabled": true, "key": "grandtotalfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total maximum", "type": "text/plain" }, "disabled": true, "key": "grandtotalto", "value": "\u003cstring\u003e" }, { "description": { "content": "Group results by. Returns subtotals per group. (This can only be one of company,project,status,day,week,month,year)", "type": "text/plain" }, "disabled": true, "key": "subtotals", "value": "status" }, { "description": { "content": "Date field for subtotals grouping (This can only be one of invoiced,due,paid)", "type": "text/plain" }, "disabled": true, "key": "subtotalsdateoption", "value": "paid" }, { "description": { "content": "Invoices modified on or after this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoices modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoices with ID greater than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoices with ID less than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Invoice IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,invoiceddate,duedate,companyname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5dcd4d06-03fa-46ad-90a3-ee9b871b257d", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- number - Invoice number/reference code\n- title - Invoice title\n- status - Invoice status (draft, submitted, authorised, paid, voided, deleted)\n- description - Invoice description (plain text, HTML stripped)\n- company - Client company ID and name\n- project - Associated project IDs, titles, and numbers as a comma-delimited list\n- projectid - Associated project IDs only (comma-separated if multiple)\n- dates - All date fields: invoiceddate, duedate, paiddate\n- invoiceddate - Invoice issue date (yyyy-mm-dd)\n- duedate - Payment due date (yyyy-mm-dd)\n- paiddate - Date payment was received (yyyy-mm-dd)\n- emaileddate - Date invoice was emailed (yyyy-mm-dd)\n- emailedto - Email address the invoice was sent to\n- emailedtoclient - Whether the invoice has been emailed to the client (boolean)\n- invoicedby - Full name of the contact who created the invoice\n- totals - Financial totals: subtotal, taxtotal, and grandtotal (all decimal, 2dp)\n- taxable - Whether the invoice is taxable (boolean)\n- taxrate - Tax rate as a percentage (decimal, e.g. 15.0)\n- purchaseordernumber - Client purchase order reference number\n- showcostbreakdown - Whether cost breakdown is displayed (boolean)\n- showitemdescription - Whether item descriptions are shown (boolean)\n- showphases - Whether phases are shown (boolean)\n- customfield - Custom field name and value pair\n- paid - Whether the invoice has been paid (boolean)\n- activeworkstageid - Active work stage ID\n- clientcontactname - Client contact name on the invoice\n- invoicetermid - Invoice payment term ID\n- paymentterms - Payment terms text (returned together with invoicetermid)\n- pagetitle - Page/PDF title of the invoice\n- address - All address fields: address1, address2, address3, city, state, zipcode, country\n- budget - Budget fields: budget, budgetTax, budgetType\n- billamount - Bill amount fields: billAmount, billAmountTax, billType\n- estbillamount - Estimated bill amount (sensitive)\n- estbillamounttax - Estimated bill amount including tax (sensitive)\n- itemsdiscount - Items discount value (sensitive)\n- timebillable - Billable time in minutes (sensitive)\n- template - Whether this invoice is a template (boolean)\n- lastmodified - Last modified date in ISO8601 format (UTC)\n- all - Returns all available scalar fieldsSub-entity fields (heavy — NOT included by all, must be named explicitly): phases - invoice phases and their line items. Use e.g. fields=all,phases or fields=phases.", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "number,title,company,status,totals,projectid,invoiceddate,duedate" }, { "description": { "content": "Deprecated: use number, title, or q+qfields instead. Search by number or title. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use number or q+qfields instead. Search by invoice number. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use title or q+qfields instead. Search by invoice title. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchtitle", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact number match", "type": "text/plain" }, "disabled": true, "key": "number", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact title match", "type": "text/plain" }, "disabled": true, "key": "title", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of number,title)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "number" }, { "description": { "content": "Status (activeworkstate). Alias: activeworkstate. (This can only be one of draft,submitted,authorised,paid,voided,deleted,all,unpaid)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "paid" }, { "description": { "content": "Alias for status. (This can only be one of draft,submitted,authorised,paid,voided,deleted,all,unpaid)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "paid" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project manager Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Project category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectcategoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter invoices by active work stage ID", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date from (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "invoiceddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "invoiceddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Paid date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "paiddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Paid date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "paiddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total minimum", "type": "text/plain" }, "disabled": true, "key": "grandtotalfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total maximum", "type": "text/plain" }, "disabled": true, "key": "grandtotalto", "value": "\u003cstring\u003e" }, { "description": { "content": "Group results by. Returns subtotals per group. (This can only be one of company,project,status,day,week,month,year)", "type": "text/plain" }, "disabled": true, "key": "subtotals", "value": "status" }, { "description": { "content": "Date field for subtotals grouping (This can only be one of invoiced,due,paid)", "type": "text/plain" }, "disabled": true, "key": "subtotalsdateoption", "value": "paid" }, { "description": { "content": "Invoices modified on or after this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoices modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoices with ID greater than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoices with ID less than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Invoice IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,invoiceddate,duedate,companyname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "fb89dc20-08e6-4ab6-8979-a27fb14dbeb9", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- number - Invoice number/reference code\n- title - Invoice title\n- status - Invoice status (draft, submitted, authorised, paid, voided, deleted)\n- description - Invoice description (plain text, HTML stripped)\n- company - Client company ID and name\n- project - Associated project IDs, titles, and numbers as a comma-delimited list\n- projectid - Associated project IDs only (comma-separated if multiple)\n- dates - All date fields: invoiceddate, duedate, paiddate\n- invoiceddate - Invoice issue date (yyyy-mm-dd)\n- duedate - Payment due date (yyyy-mm-dd)\n- paiddate - Date payment was received (yyyy-mm-dd)\n- emaileddate - Date invoice was emailed (yyyy-mm-dd)\n- emailedto - Email address the invoice was sent to\n- emailedtoclient - Whether the invoice has been emailed to the client (boolean)\n- invoicedby - Full name of the contact who created the invoice\n- totals - Financial totals: subtotal, taxtotal, and grandtotal (all decimal, 2dp)\n- taxable - Whether the invoice is taxable (boolean)\n- taxrate - Tax rate as a percentage (decimal, e.g. 15.0)\n- purchaseordernumber - Client purchase order reference number\n- showcostbreakdown - Whether cost breakdown is displayed (boolean)\n- showitemdescription - Whether item descriptions are shown (boolean)\n- showphases - Whether phases are shown (boolean)\n- customfield - Custom field name and value pair\n- paid - Whether the invoice has been paid (boolean)\n- activeworkstageid - Active work stage ID\n- clientcontactname - Client contact name on the invoice\n- invoicetermid - Invoice payment term ID\n- paymentterms - Payment terms text (returned together with invoicetermid)\n- pagetitle - Page/PDF title of the invoice\n- address - All address fields: address1, address2, address3, city, state, zipcode, country\n- budget - Budget fields: budget, budgetTax, budgetType\n- billamount - Bill amount fields: billAmount, billAmountTax, billType\n- estbillamount - Estimated bill amount (sensitive)\n- estbillamounttax - Estimated bill amount including tax (sensitive)\n- itemsdiscount - Items discount value (sensitive)\n- timebillable - Billable time in minutes (sensitive)\n- template - Whether this invoice is a template (boolean)\n- lastmodified - Last modified date in ISO8601 format (UTC)\n- all - Returns all available scalar fieldsSub-entity fields (heavy — NOT included by all, must be named explicitly): phases - invoice phases and their line items. Use e.g. fields=all,phases or fields=phases.", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "number,title,company,status,totals,projectid,invoiceddate,duedate" }, { "description": { "content": "Deprecated: use number, title, or q+qfields instead. Search by number or title. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use number or q+qfields instead. Search by invoice number. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use title or q+qfields instead. Search by invoice title. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchtitle", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact number match", "type": "text/plain" }, "disabled": true, "key": "number", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact title match", "type": "text/plain" }, "disabled": true, "key": "title", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of number,title)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "number" }, { "description": { "content": "Status (activeworkstate). Alias: activeworkstate. (This can only be one of draft,submitted,authorised,paid,voided,deleted,all,unpaid)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "paid" }, { "description": { "content": "Alias for status. (This can only be one of draft,submitted,authorised,paid,voided,deleted,all,unpaid)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "paid" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project manager Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Project category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectcategoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter invoices by active work stage ID", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date from (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "invoiceddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "invoiceddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Paid date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "paiddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Paid date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "paiddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total minimum", "type": "text/plain" }, "disabled": true, "key": "grandtotalfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total maximum", "type": "text/plain" }, "disabled": true, "key": "grandtotalto", "value": "\u003cstring\u003e" }, { "description": { "content": "Group results by. Returns subtotals per group. (This can only be one of company,project,status,day,week,month,year)", "type": "text/plain" }, "disabled": true, "key": "subtotals", "value": "status" }, { "description": { "content": "Date field for subtotals grouping (This can only be one of invoiced,due,paid)", "type": "text/plain" }, "disabled": true, "key": "subtotalsdateoption", "value": "paid" }, { "description": { "content": "Invoices modified on or after this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoices modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoices with ID greater than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoices with ID less than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Invoice IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,invoiceddate,duedate,companyname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "0e7fd89f-bc82-442d-a00b-17dd018c3255", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- number - Invoice number/reference code\n- title - Invoice title\n- status - Invoice status (draft, submitted, authorised, paid, voided, deleted)\n- description - Invoice description (plain text, HTML stripped)\n- company - Client company ID and name\n- project - Associated project IDs, titles, and numbers as a comma-delimited list\n- projectid - Associated project IDs only (comma-separated if multiple)\n- dates - All date fields: invoiceddate, duedate, paiddate\n- invoiceddate - Invoice issue date (yyyy-mm-dd)\n- duedate - Payment due date (yyyy-mm-dd)\n- paiddate - Date payment was received (yyyy-mm-dd)\n- emaileddate - Date invoice was emailed (yyyy-mm-dd)\n- emailedto - Email address the invoice was sent to\n- emailedtoclient - Whether the invoice has been emailed to the client (boolean)\n- invoicedby - Full name of the contact who created the invoice\n- totals - Financial totals: subtotal, taxtotal, and grandtotal (all decimal, 2dp)\n- taxable - Whether the invoice is taxable (boolean)\n- taxrate - Tax rate as a percentage (decimal, e.g. 15.0)\n- purchaseordernumber - Client purchase order reference number\n- showcostbreakdown - Whether cost breakdown is displayed (boolean)\n- showitemdescription - Whether item descriptions are shown (boolean)\n- showphases - Whether phases are shown (boolean)\n- customfield - Custom field name and value pair\n- paid - Whether the invoice has been paid (boolean)\n- activeworkstageid - Active work stage ID\n- clientcontactname - Client contact name on the invoice\n- invoicetermid - Invoice payment term ID\n- paymentterms - Payment terms text (returned together with invoicetermid)\n- pagetitle - Page/PDF title of the invoice\n- address - All address fields: address1, address2, address3, city, state, zipcode, country\n- budget - Budget fields: budget, budgetTax, budgetType\n- billamount - Bill amount fields: billAmount, billAmountTax, billType\n- estbillamount - Estimated bill amount (sensitive)\n- estbillamounttax - Estimated bill amount including tax (sensitive)\n- itemsdiscount - Items discount value (sensitive)\n- timebillable - Billable time in minutes (sensitive)\n- template - Whether this invoice is a template (boolean)\n- lastmodified - Last modified date in ISO8601 format (UTC)\n- all - Returns all available scalar fieldsSub-entity fields (heavy — NOT included by all, must be named explicitly): phases - invoice phases and their line items. Use e.g. fields=all,phases or fields=phases.", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "number,title,company,status,totals,projectid,invoiceddate,duedate" }, { "description": { "content": "Deprecated: use number, title, or q+qfields instead. Search by number or title. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use number or q+qfields instead. Search by invoice number. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use title or q+qfields instead. Search by invoice title. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchtitle", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact number match", "type": "text/plain" }, "disabled": true, "key": "number", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact title match", "type": "text/plain" }, "disabled": true, "key": "title", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of number,title)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "number" }, { "description": { "content": "Status (activeworkstate). Alias: activeworkstate. (This can only be one of draft,submitted,authorised,paid,voided,deleted,all,unpaid)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "paid" }, { "description": { "content": "Alias for status. (This can only be one of draft,submitted,authorised,paid,voided,deleted,all,unpaid)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "paid" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project manager Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Project category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectcategoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter invoices by active work stage ID", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date from (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "invoiceddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "invoiceddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Paid date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "paiddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Paid date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "paiddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total minimum", "type": "text/plain" }, "disabled": true, "key": "grandtotalfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total maximum", "type": "text/plain" }, "disabled": true, "key": "grandtotalto", "value": "\u003cstring\u003e" }, { "description": { "content": "Group results by. Returns subtotals per group. (This can only be one of company,project,status,day,week,month,year)", "type": "text/plain" }, "disabled": true, "key": "subtotals", "value": "status" }, { "description": { "content": "Date field for subtotals grouping (This can only be one of invoiced,due,paid)", "type": "text/plain" }, "disabled": true, "key": "subtotalsdateoption", "value": "paid" }, { "description": { "content": "Invoices modified on or after this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoices modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoices with ID greater than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoices with ID less than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Invoice IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,invoiceddate,duedate,companyname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "126e6cbf-a069-433d-a129-ad3a5c37d780", "name": "/invoices", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"invoicedate\": \"\u003cstring\u003e\",\n \"invoicetermid\": \"\u003cinteger\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"purchaseordernumber\": \"\u003cstring\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Creates a new invoice.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/invoices", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d05b044a-ba20-4c51-972c-b40eebca6a01", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"invoicedate\": \"\u003cstring\u003e\",\n \"invoicetermid\": \"\u003cinteger\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"purchaseordernumber\": \"\u003cstring\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices" ], "query": [], "variable": [] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "29fc56fb-7983-4559-8f81-edfec6732776", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"invoicedate\": \"\u003cstring\u003e\",\n \"invoicetermid\": \"\u003cinteger\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"purchaseordernumber\": \"\u003cstring\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "63af4293-42ec-4c3f-ad27-ca9b6944b0ee", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"invoicedate\": \"\u003cstring\u003e\",\n \"invoicetermid\": \"\u003cinteger\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"purchaseordernumber\": \"\u003cstring\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8150a58b-a388-4a0d-b3ec-6438a47d1c30", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"invoicedate\": \"\u003cstring\u003e\",\n \"invoicetermid\": \"\u003cinteger\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"purchaseordernumber\": \"\u003cstring\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "d6e74068-f4fe-4ef6-a9ff-81030eb9583a", "name": "/invoices", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Soft deletes one or more invoices by ID.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/invoices", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4fb2badc-cb09-43de-af81-33ab6f25aee1", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ef029b1a-9c03-4c44-a838-27a994c4d526", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c0ba40f9-618e-4d55-958e-06a1b681bd89", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices" ], "query": [], "variable": [] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "fb42b7c1-3f60-47f2-ad5a-8314d10fd5b7", "name": "/invoices/items", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of all invoice line items across all invoices, based on the filters specified.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/invoices/items", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,itemcollectionid,parentid,itemtypeid,activeworkstate,billAmount" }, { "description": { "content": "Search by item name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoice ID or list of Invoice IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "invoiceid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to items within a specific phase (itemcollectionid)", "type": "text/plain" }, "disabled": true, "key": "phaseid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by parent item ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by item type ID", "type": "text/plain" }, "disabled": true, "key": "itemtypeid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cstring\u003e\",\n \"createdatetime\": \"\u003cstring\u003e\",\n \"creatorid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"discountRate\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inTaxRate\": \"\u003cnumber\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"isDiscountPercent\": \"\u003cboolean\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outTaxRate\": \"\u003cnumber\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\",\n \"timespent\": \"\u003cnumber\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"uniquetoken\": \"\u003cstring\u003e\",\n \"updatedAt\": \"\u003cnumber\u003e\"\n },\n {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cstring\u003e\",\n \"createdatetime\": \"\u003cstring\u003e\",\n \"creatorid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"discountRate\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inTaxRate\": \"\u003cnumber\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"isDiscountPercent\": \"\u003cboolean\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outTaxRate\": \"\u003cnumber\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\",\n \"timespent\": \"\u003cnumber\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"uniquetoken\": \"\u003cstring\u003e\",\n \"updatedAt\": \"\u003cnumber\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6e8eaf1d-dcc7-4053-a5cb-a069b301bbc3", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,itemcollectionid,parentid,itemtypeid,activeworkstate,billAmount" }, { "description": { "content": "Search by item name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoice ID or list of Invoice IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "invoiceid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to items within a specific phase (itemcollectionid)", "type": "text/plain" }, "disabled": true, "key": "phaseid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by parent item ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by item type ID", "type": "text/plain" }, "disabled": true, "key": "itemtypeid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ee488a77-4d09-4b0c-b5c8-7d609353eaee", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,itemcollectionid,parentid,itemtypeid,activeworkstate,billAmount" }, { "description": { "content": "Search by item name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoice ID or list of Invoice IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "invoiceid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to items within a specific phase (itemcollectionid)", "type": "text/plain" }, "disabled": true, "key": "phaseid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by parent item ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by item type ID", "type": "text/plain" }, "disabled": true, "key": "itemtypeid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2ed398a2-6ece-490c-943d-a55f97359cbd", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,itemcollectionid,parentid,itemtypeid,activeworkstate,billAmount" }, { "description": { "content": "Search by item name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoice ID or list of Invoice IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "invoiceid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to items within a specific phase (itemcollectionid)", "type": "text/plain" }, "disabled": true, "key": "phaseid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by parent item ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by item type ID", "type": "text/plain" }, "disabled": true, "key": "itemtypeid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f9d89a82-b291-4c05-bea3-656c76bfa841", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,itemcollectionid,parentid,itemtypeid,activeworkstate,billAmount" }, { "description": { "content": "Search by item name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoice ID or list of Invoice IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "invoiceid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to items within a specific phase (itemcollectionid)", "type": "text/plain" }, "disabled": true, "key": "phaseid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by parent item ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by item type ID", "type": "text/plain" }, "disabled": true, "key": "itemtypeid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "9aeaeb7f-5a76-47d8-9eb8-21cbe1d6f26c", "name": "/invoices/items", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billType\": \"\u003cinteger\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"discount\": {\n \"amount\": \"\u003cnumber\u003e\",\n \"percent\": \"\u003cnumber\u003e\"\n },\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScore\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"impactScore\": \"\u003cinteger\u003e\",\n \"importanceScore\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"manualPercentageComplete\": \"\u003cnumber\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedTimeManual\": \"\u003cinteger\u003e\",\n \"projectedTimeSpent\": \"\u003cinteger\u003e\",\n \"shiftDates\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cinteger\u003e\",\n \"urgencyScore\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Updates one or more invoice items by ID. All fields except ids are optional — only provided fields are updated.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/invoices/items", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "items" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "0b5114af-57a9-4cde-98a9-9a2b0c020eb0", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billType\": \"\u003cinteger\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"discount\": {\n \"amount\": \"\u003cnumber\u003e\",\n \"percent\": \"\u003cnumber\u003e\"\n },\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScore\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"impactScore\": \"\u003cinteger\u003e\",\n \"importanceScore\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"manualPercentageComplete\": \"\u003cnumber\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedTimeManual\": \"\u003cinteger\u003e\",\n \"projectedTimeSpent\": \"\u003cinteger\u003e\",\n \"shiftDates\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cinteger\u003e\",\n \"urgencyScore\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "items" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "51f2ddff-7417-41c8-adaf-ea89603e353f", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billType\": \"\u003cinteger\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"discount\": {\n \"amount\": \"\u003cnumber\u003e\",\n \"percent\": \"\u003cnumber\u003e\"\n },\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScore\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"impactScore\": \"\u003cinteger\u003e\",\n \"importanceScore\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"manualPercentageComplete\": \"\u003cnumber\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedTimeManual\": \"\u003cinteger\u003e\",\n \"projectedTimeSpent\": \"\u003cinteger\u003e\",\n \"shiftDates\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cinteger\u003e\",\n \"urgencyScore\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "items" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "40c00310-4551-4d7d-9f67-81c80bdc1117", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billType\": \"\u003cinteger\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"discount\": {\n \"amount\": \"\u003cnumber\u003e\",\n \"percent\": \"\u003cnumber\u003e\"\n },\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScore\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"impactScore\": \"\u003cinteger\u003e\",\n \"importanceScore\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"manualPercentageComplete\": \"\u003cnumber\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedTimeManual\": \"\u003cinteger\u003e\",\n \"projectedTimeSpent\": \"\u003cinteger\u003e\",\n \"shiftDates\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cinteger\u003e\",\n \"urgencyScore\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "items" ], "query": [], "variable": [] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "3b4c34cb-e89c-4a42-a3ae-7772a5083a45", "name": "/invoices/items", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billable\": \"\u003cboolean\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Creates one or more invoice line items. The invoiceid must be provided in the request body.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/invoices/items", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "items" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "76771672-35d8-4227-9a80-7e1273751aff", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billable\": \"\u003cboolean\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "items" ], "query": [], "variable": [] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "22b4312e-08c9-401a-a532-fd95c9df44ab", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billable\": \"\u003cboolean\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "items" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7fdda06f-239e-4bf5-80bb-7c4bf75fe13d", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billable\": \"\u003cboolean\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "items" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "776dbdd4-e6ab-463e-98bb-43bbb0d1de4d", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billable\": \"\u003cboolean\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "items" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "127dd44d-80af-410d-ac33-40ae8d42e87d", "name": "/invoices/items/:itemid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns full details of a single invoice line item by ID, without requiring the invoice ID.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/invoices/items/:itemid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cstring\u003e\",\n \"createdatetime\": \"\u003cstring\u003e\",\n \"creatorid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"discountRate\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inTaxRate\": \"\u003cnumber\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"isDiscountPercent\": \"\u003cboolean\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outTaxRate\": \"\u003cnumber\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\",\n \"timespent\": \"\u003cnumber\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"uniquetoken\": \"\u003cstring\u003e\",\n \"updatedAt\": \"\u003cnumber\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "55fe203f-f37f-45c3-b926-0af561950c16", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3d91612c-374f-4365-b43c-086786404991", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3e33c1e7-fa6f-47af-b4e7-40abc6080627", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "08e83077-3cd5-44c9-8db4-b05a94c1af7f", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7813c2d7-3b27-4363-8771-201df93af738", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "33a43274-f5a6-4514-8a38-a53ffa47b6d0", "name": "/invoices/items/:itemid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Updates an existing invoice line item by ID, without requiring the invoice ID.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/invoices/items/:itemid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "66eb24a6-8ab5-4ecf-ae83-9f1ecc5b5193", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7d80fe09-dc5d-498b-aab7-89810997fd81", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a3d46e9f-0f59-47a2-b66d-fff6346f7c12", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "0bf3a611-4810-4117-90d9-35f43cf897be", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4d3ea098-a3ba-41f7-a89c-252515724009", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "54f622ff-e7ff-41da-b484-be6893b7b606", "name": "/invoices/items/:itemid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Soft-deletes an invoice line item by ID, without requiring the invoice ID.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/invoices/items/:itemid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ae073d50-582f-4185-b35c-393eeac3984d", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "1c15b610-8dd8-45af-bdec-ba872b2ba7b7", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "fdd65a43-d7d3-4b8c-a0bb-efee19f0e64e", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e32b2199-4639-437e-a26c-acef449e4fa4", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "03ef8d60-9ee7-4e70-a65d-65713b4474d7", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "f0cab305-3060-4cee-b508-caeaa06515a1", "name": "/invoices/items/:itemid/order", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"placeafterid\": \"\u003cinteger\u003e\",\n \"placebeforeid\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Moves an invoice item before or after another item using sortorder. Provide exactly one of placeafterid or placebeforeid.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/invoices/items/:itemid/order", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "items", ":itemid", "order" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9e0459f0-9df1-41b3-9215-3b3507e9b280", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"placeafterid\": \"\u003cinteger\u003e\",\n \"placebeforeid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "items", ":itemid", "order" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5bd79c4c-0571-4fe9-99a3-ae467a4e9d5c", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"placeafterid\": \"\u003cinteger\u003e\",\n \"placebeforeid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "items", ":itemid", "order" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e89de7b9-8f2a-4e84-848f-17f4b237c802", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"placeafterid\": \"\u003cinteger\u003e\",\n \"placebeforeid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "items", ":itemid", "order" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "f14ee875-f84c-47ef-95f5-185de7809435", "name": "/invoices/overdue", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns invoices that are past their due date and have not been paid (status: submitted or authorised). Supports the same field selection, sorting, and pagination as GET /invoices.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/invoices/overdue", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "overdue" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "number,title,company,status,totals,projectid,invoiceddate,duedate" }, { "description": { "content": "Search by number or title. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by invoice number. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by invoice title. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchtitle", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project manager Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Project category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectcategoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date from (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "invoiceddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "invoiceddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total minimum", "type": "text/plain" }, "disabled": true, "key": "grandtotalfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total maximum", "type": "text/plain" }, "disabled": true, "key": "grandtotalto", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified UTC from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified UTC to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoice ID range from", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoice ID range to", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Invoice IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,invoiceddate,duedate,companyname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "duedate" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"clientcontactname\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"customfieldname\": \"\u003cstring\u003e\",\n \"customfieldvalue\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"emaileddate\": \"\u003cstring\u003e\",\n \"emailedto\": \"\u003cstring\u003e\",\n \"emailedtoclient\": \"\u003cboolean\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoicedby\": \"\u003cstring\u003e\",\n \"invoiceddate\": \"\u003cstring\u003e\",\n \"invoicetermid\": \"\u003cinteger\u003e\",\n \"itemsDiscount\": \"\u003cnumber\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"pagetitle\": \"\u003cstring\u003e\",\n \"paid\": \"\u003cboolean\u003e\",\n \"paiddate\": \"\u003cstring\u003e\",\n \"paymentterms\": \"\u003cstring\u003e\",\n \"phases\": [\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n }\n ],\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n },\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n }\n ],\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n }\n ],\n \"projectid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"projectnumbers\": \"\u003cstring\u003e\",\n \"projecttitles\": \"\u003cstring\u003e\",\n \"purchaseordernumber\": \"\u003cstring\u003e\",\n \"showcostbreakdown\": \"\u003cboolean\u003e\",\n \"showitemdescription\": \"\u003cboolean\u003e\",\n \"showphases\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"taxable\": \"\u003cboolean\u003e\",\n \"taxrate\": \"\u003cnumber\u003e\",\n \"taxtotal\": \"\u003cnumber\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n },\n {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"clientcontactname\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"customfieldname\": \"\u003cstring\u003e\",\n \"customfieldvalue\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"emaileddate\": \"\u003cstring\u003e\",\n \"emailedto\": \"\u003cstring\u003e\",\n \"emailedtoclient\": \"\u003cboolean\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoicedby\": \"\u003cstring\u003e\",\n \"invoiceddate\": \"\u003cstring\u003e\",\n \"invoicetermid\": \"\u003cinteger\u003e\",\n \"itemsDiscount\": \"\u003cnumber\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"pagetitle\": \"\u003cstring\u003e\",\n \"paid\": \"\u003cboolean\u003e\",\n \"paiddate\": \"\u003cstring\u003e\",\n \"paymentterms\": \"\u003cstring\u003e\",\n \"phases\": [\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n }\n ],\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n },\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n }\n ],\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n }\n ],\n \"projectid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"projectnumbers\": \"\u003cstring\u003e\",\n \"projecttitles\": \"\u003cstring\u003e\",\n \"purchaseordernumber\": \"\u003cstring\u003e\",\n \"showcostbreakdown\": \"\u003cboolean\u003e\",\n \"showitemdescription\": \"\u003cboolean\u003e\",\n \"showphases\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"taxable\": \"\u003cboolean\u003e\",\n \"taxrate\": \"\u003cnumber\u003e\",\n \"taxtotal\": \"\u003cnumber\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "da4d4d8b-b266-4027-91fe-406cf286a929", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "overdue" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "number,title,company,status,totals,projectid,invoiceddate,duedate" }, { "description": { "content": "Search by number or title. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by invoice number. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by invoice title. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchtitle", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project manager Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Project category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectcategoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date from (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "invoiceddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "invoiceddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total minimum", "type": "text/plain" }, "disabled": true, "key": "grandtotalfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total maximum", "type": "text/plain" }, "disabled": true, "key": "grandtotalto", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified UTC from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified UTC to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoice ID range from", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoice ID range to", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Invoice IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,invoiceddate,duedate,companyname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "duedate" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "18447335-e552-400c-9931-0737cdde6ba4", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "overdue" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "number,title,company,status,totals,projectid,invoiceddate,duedate" }, { "description": { "content": "Search by number or title. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by invoice number. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by invoice title. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchtitle", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project manager Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Project category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectcategoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date from (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "invoiceddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "invoiceddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total minimum", "type": "text/plain" }, "disabled": true, "key": "grandtotalfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total maximum", "type": "text/plain" }, "disabled": true, "key": "grandtotalto", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified UTC from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified UTC to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoice ID range from", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoice ID range to", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Invoice IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,invoiceddate,duedate,companyname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "duedate" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "cb67b8d6-d60f-4634-86ce-9ad946673e95", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "overdue" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "number,title,company,status,totals,projectid,invoiceddate,duedate" }, { "description": { "content": "Search by number or title. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by invoice number. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by invoice title. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchtitle", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project manager Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Project category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectcategoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date from (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "invoiceddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "invoiceddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total minimum", "type": "text/plain" }, "disabled": true, "key": "grandtotalfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total maximum", "type": "text/plain" }, "disabled": true, "key": "grandtotalto", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified UTC from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified UTC to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoice ID range from", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoice ID range to", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Invoice IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,invoiceddate,duedate,companyname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "duedate" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "627a27fc-205d-4734-b88f-41a50b692c7e", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "overdue" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "number,title,company,status,totals,projectid,invoiceddate,duedate" }, { "description": { "content": "Search by number or title. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by invoice number. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by invoice title. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchtitle", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project manager Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Project category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectcategoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date from (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "invoiceddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "invoiceddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total minimum", "type": "text/plain" }, "disabled": true, "key": "grandtotalfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total maximum", "type": "text/plain" }, "disabled": true, "key": "grandtotalto", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified UTC from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified UTC to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoice ID range from", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoice ID range to", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Invoice IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,invoiceddate,duedate,companyname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "duedate" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "561a1afa-d1e3-45ee-844b-18752a46692c", "name": "/invoices/phases", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns phases (item collections) across all invoices. Optionally filter by one or more invoice IDs.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/invoices/phases", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "phases" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,invoiceid,parentid,billAmount" }, { "description": { "content": "Search by phase name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoice ID or comma-separated list of Invoice IDs to filter by", "type": "text/plain" }, "disabled": true, "key": "invoiceid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to phases with a specific parent phase ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"datecreated\": \"\u003cstring\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\"\n },\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"datecreated\": \"\u003cstring\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "89e2a6f4-df53-4d1b-9100-637accb73d05", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "phases" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,invoiceid,parentid,billAmount" }, { "description": { "content": "Search by phase name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoice ID or comma-separated list of Invoice IDs to filter by", "type": "text/plain" }, "disabled": true, "key": "invoiceid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to phases with a specific parent phase ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "1097a0bd-84e4-4c5e-bce2-70601864bf38", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "phases" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,invoiceid,parentid,billAmount" }, { "description": { "content": "Search by phase name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoice ID or comma-separated list of Invoice IDs to filter by", "type": "text/plain" }, "disabled": true, "key": "invoiceid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to phases with a specific parent phase ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "262068ce-5ace-4276-bf7f-9d9c1faa42c0", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "phases" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,invoiceid,parentid,billAmount" }, { "description": { "content": "Search by phase name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoice ID or comma-separated list of Invoice IDs to filter by", "type": "text/plain" }, "disabled": true, "key": "invoiceid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to phases with a specific parent phase ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "19724752-dbf8-4a58-b056-a96c17d6287d", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "phases" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,invoiceid,parentid,billAmount" }, { "description": { "content": "Search by phase name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoice ID or comma-separated list of Invoice IDs to filter by", "type": "text/plain" }, "disabled": true, "key": "invoiceid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to phases with a specific parent phase ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "95134af9-b909-4a80-b779-5103b5ca33d7", "name": "/invoices/phases", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billType\": \"\u003cinteger\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Updates one or more invoice phases by ID. All fields except ids are optional.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/invoices/phases", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "phases" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c1bb00d6-0809-4f55-82de-d9193d7c4312", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billType\": \"\u003cinteger\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "phases" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "18ac4eae-dc78-405f-94c9-660daa5f2d3a", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billType\": \"\u003cinteger\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "phases" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "54c20095-d05c-4473-a3a1-f6d46b38c279", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billType\": \"\u003cinteger\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "phases" ], "query": [], "variable": [] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "bf6cd6a0-2667-4aff-9373-ebf9a23df312", "name": "/invoices/phases", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billtype\": \"\u003cinteger\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Creates one or more invoice phases (item collections). The invoiceid must be included in the request body.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/invoices/phases", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "phases" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4e559293-08cd-43df-8722-e5a069810008", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billtype\": \"\u003cinteger\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "phases" ], "query": [], "variable": [] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "46583901-d146-45b1-90aa-285ce7aab11b", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billtype\": \"\u003cinteger\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "phases" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d69cf441-5270-4452-b24a-210825000a28", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billtype\": \"\u003cinteger\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "phases" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7e9a8351-264e-4b83-a616-06ea260690aa", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billtype\": \"\u003cinteger\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "phases" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "8a7955b3-41be-46af-bc87-bb15d14e29d3", "name": "/invoices/phases/adjustdates", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"shiftchilddates\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Shifts item dates within one or more invoice phases by a number of days. Negative values shift backwards.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/invoices/phases/adjustdates", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "phases", "adjustdates" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8fc1fabf-8ccc-4c84-ac15-15fcf725eb5e", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"shiftchilddates\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "phases", "adjustdates" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "464a769b-7b2f-4959-bf43-3969c8aa82a7", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"shiftchilddates\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "phases", "adjustdates" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a02652ec-16d8-4791-8205-2c101da0f6cc", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"shiftchilddates\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "phases", "adjustdates" ], "query": [], "variable": [] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "5157ba8d-e4e1-4a9c-bf61-3c2257e628ef", "name": "/invoices/phases/:phaseid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns full details of a single invoice phase by ID.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/invoices/phases/:phaseid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"datecreated\": \"\u003cstring\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4e0bea95-a634-4c8d-8e52-a9a03d8ec0d4", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4e9a312a-96ac-4785-8816-0491c9d14388", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4c9bc032-ed61-4989-9bdf-76b0b78f6c9f", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "fa9a1a17-7012-4e2a-8c9a-d834acfeba24", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "53a2abef-08aa-460b-9499-9453c1bd428b", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "219d4f25-65bd-47ad-8312-3ef20f4e14a2", "name": "/invoices/phases/:phaseid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Updates an existing invoice phase by ID.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/invoices/phases/:phaseid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f8edd48a-7ad3-4cd1-ad67-544d1c8be598", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "1777dc1e-179b-465a-ac21-db9a0c6db281", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "21aeae51-7775-4be2-aa72-30ee13eeaccd", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ae9af2c3-110d-4c06-a2b8-76a0f8d4a332", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "94f7fed9-80e8-4f18-a7be-baf4da7209f8", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "995c9acc-32ec-4061-989a-40bab93a38dd", "name": "/invoices/phases/:phaseid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Soft-deletes an invoice phase by ID.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/invoices/phases/:phaseid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2ae5906e-9d9f-44a8-8c74-837dcfcb6ccb", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d7d9a6b6-74d3-4817-b22b-232ca27b8aac", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8e1afefe-166e-48ad-9997-a1734a8bb5fa", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "edc62eb0-0751-45f5-8e4e-abcc790c046a", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7a57bea1-2959-431f-961c-8d210fe34802", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "dd38d635-e310-44e5-9fa4-ce4b5b5370d1", "name": "/invoices/:invoiceid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "View a single Invoice. Returns detailed information including phases and line items. IMPORTANT: For Task/Staff Rate Lines, the 'rate' value is cost/hour, the 'time' value is the time in minutes.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/invoices/:invoiceid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"clientcontactname\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"customfieldname\": \"\u003cstring\u003e\",\n \"customfieldvalue\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"emaileddate\": \"\u003cstring\u003e\",\n \"emailedto\": \"\u003cstring\u003e\",\n \"emailedtoclient\": \"\u003cboolean\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoicedby\": \"\u003cstring\u003e\",\n \"invoiceddate\": \"\u003cstring\u003e\",\n \"invoicetermid\": \"\u003cinteger\u003e\",\n \"itemsDiscount\": \"\u003cnumber\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"pagetitle\": \"\u003cstring\u003e\",\n \"paid\": \"\u003cboolean\u003e\",\n \"paiddate\": \"\u003cstring\u003e\",\n \"paymentterms\": \"\u003cstring\u003e\",\n \"phases\": [\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n }\n ],\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n },\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n }\n ],\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n }\n ],\n \"projectid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"projectnumbers\": \"\u003cstring\u003e\",\n \"projecttitles\": \"\u003cstring\u003e\",\n \"purchaseordernumber\": \"\u003cstring\u003e\",\n \"showcostbreakdown\": \"\u003cboolean\u003e\",\n \"showitemdescription\": \"\u003cboolean\u003e\",\n \"showphases\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"taxable\": \"\u003cboolean\u003e\",\n \"taxrate\": \"\u003cnumber\u003e\",\n \"taxtotal\": \"\u003cnumber\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5bcbd109-f9f0-4203-b48b-a35eef1eacad", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c03a0dc3-480b-4982-9a15-1b3c631a1063", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "77ee30ba-55ec-4913-9bca-30af3b8c5c62", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3e3a5e00-7cce-4b0b-84d9-3b5c0b98d7b3", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7c7204ae-fc98-4ae6-bf93-9a162ec9b96c", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "9f31ee2d-4df5-41f0-bc2b-74882ad3cdfd", "name": "/invoices/:invoiceid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"autonumber\": \"\u003cboolean\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"clientcompany\": \"\u003cstring\u003e\",\n \"clientcontactname\": \"\u003cstring\u003e\",\n \"contactfooter\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"customfieldvalue\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"footerdetails\": \"\u003cstring\u003e\",\n \"invoicedate\": \"\u003cstring\u003e\",\n \"invoicetermid\": \"\u003cinteger\u003e\",\n \"layoutid\": \"\u003cinteger\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"pagesubtitle\": \"\u003cstring\u003e\",\n \"pagetitle\": \"\u003cstring\u003e\",\n \"paymentdetails\": \"\u003cstring\u003e\",\n \"paymentperiod\": \"\u003cinteger\u003e\",\n \"paymentterms\": \"\u003cstring\u003e\",\n \"purchaseordernumber\": \"\u003cstring\u003e\",\n \"showItemDescription\": \"\u003cboolean\u003e\",\n \"showPhases\": \"\u003cboolean\u003e\",\n \"showcostbreakdown\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"status\": \"voided\",\n \"taxable\": \"\u003cboolean\u003e\",\n \"taxrate\": \"\u003cnumber\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Updates an existing invoice. Only provide the fields you want to update.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/invoices/:invoiceid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8c432273-42db-400a-8972-7a855c3fff61", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"autonumber\": \"\u003cboolean\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"clientcompany\": \"\u003cstring\u003e\",\n \"clientcontactname\": \"\u003cstring\u003e\",\n \"contactfooter\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"customfieldvalue\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"footerdetails\": \"\u003cstring\u003e\",\n \"invoicedate\": \"\u003cstring\u003e\",\n \"invoicetermid\": \"\u003cinteger\u003e\",\n \"layoutid\": \"\u003cinteger\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"pagesubtitle\": \"\u003cstring\u003e\",\n \"pagetitle\": \"\u003cstring\u003e\",\n \"paymentdetails\": \"\u003cstring\u003e\",\n \"paymentperiod\": \"\u003cinteger\u003e\",\n \"paymentterms\": \"\u003cstring\u003e\",\n \"purchaseordernumber\": \"\u003cstring\u003e\",\n \"showItemDescription\": \"\u003cboolean\u003e\",\n \"showPhases\": \"\u003cboolean\u003e\",\n \"showcostbreakdown\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"status\": \"voided\",\n \"taxable\": \"\u003cboolean\u003e\",\n \"taxrate\": \"\u003cnumber\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "0e733cc5-15d3-4f3b-877a-e6a79c1f9f70", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"autonumber\": \"\u003cboolean\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"clientcompany\": \"\u003cstring\u003e\",\n \"clientcontactname\": \"\u003cstring\u003e\",\n \"contactfooter\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"customfieldvalue\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"footerdetails\": \"\u003cstring\u003e\",\n \"invoicedate\": \"\u003cstring\u003e\",\n \"invoicetermid\": \"\u003cinteger\u003e\",\n \"layoutid\": \"\u003cinteger\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"pagesubtitle\": \"\u003cstring\u003e\",\n \"pagetitle\": \"\u003cstring\u003e\",\n \"paymentdetails\": \"\u003cstring\u003e\",\n \"paymentperiod\": \"\u003cinteger\u003e\",\n \"paymentterms\": \"\u003cstring\u003e\",\n \"purchaseordernumber\": \"\u003cstring\u003e\",\n \"showItemDescription\": \"\u003cboolean\u003e\",\n \"showPhases\": \"\u003cboolean\u003e\",\n \"showcostbreakdown\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"status\": \"voided\",\n \"taxable\": \"\u003cboolean\u003e\",\n \"taxrate\": \"\u003cnumber\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f42fd09c-e01a-4483-8985-0989fe6483ac", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"autonumber\": \"\u003cboolean\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"clientcompany\": \"\u003cstring\u003e\",\n \"clientcontactname\": \"\u003cstring\u003e\",\n \"contactfooter\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"customfieldvalue\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"footerdetails\": \"\u003cstring\u003e\",\n \"invoicedate\": \"\u003cstring\u003e\",\n \"invoicetermid\": \"\u003cinteger\u003e\",\n \"layoutid\": \"\u003cinteger\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"pagesubtitle\": \"\u003cstring\u003e\",\n \"pagetitle\": \"\u003cstring\u003e\",\n \"paymentdetails\": \"\u003cstring\u003e\",\n \"paymentperiod\": \"\u003cinteger\u003e\",\n \"paymentterms\": \"\u003cstring\u003e\",\n \"purchaseordernumber\": \"\u003cstring\u003e\",\n \"showItemDescription\": \"\u003cboolean\u003e\",\n \"showPhases\": \"\u003cboolean\u003e\",\n \"showcostbreakdown\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"status\": \"voided\",\n \"taxable\": \"\u003cboolean\u003e\",\n \"taxrate\": \"\u003cnumber\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7f358908-1050-46d7-816b-33620b214cd7", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"autonumber\": \"\u003cboolean\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"clientcompany\": \"\u003cstring\u003e\",\n \"clientcontactname\": \"\u003cstring\u003e\",\n \"contactfooter\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"customfieldvalue\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"footerdetails\": \"\u003cstring\u003e\",\n \"invoicedate\": \"\u003cstring\u003e\",\n \"invoicetermid\": \"\u003cinteger\u003e\",\n \"layoutid\": \"\u003cinteger\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"pagesubtitle\": \"\u003cstring\u003e\",\n \"pagetitle\": \"\u003cstring\u003e\",\n \"paymentdetails\": \"\u003cstring\u003e\",\n \"paymentperiod\": \"\u003cinteger\u003e\",\n \"paymentterms\": \"\u003cstring\u003e\",\n \"purchaseordernumber\": \"\u003cstring\u003e\",\n \"showItemDescription\": \"\u003cboolean\u003e\",\n \"showPhases\": \"\u003cboolean\u003e\",\n \"showcostbreakdown\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"status\": \"voided\",\n \"taxable\": \"\u003cboolean\u003e\",\n \"taxrate\": \"\u003cnumber\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "94291b7b-9488-49fc-8f89-5d9a1e817a09", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"autonumber\": \"\u003cboolean\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"clientcompany\": \"\u003cstring\u003e\",\n \"clientcontactname\": \"\u003cstring\u003e\",\n \"contactfooter\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"customfieldvalue\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"footerdetails\": \"\u003cstring\u003e\",\n \"invoicedate\": \"\u003cstring\u003e\",\n \"invoicetermid\": \"\u003cinteger\u003e\",\n \"layoutid\": \"\u003cinteger\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"pagesubtitle\": \"\u003cstring\u003e\",\n \"pagetitle\": \"\u003cstring\u003e\",\n \"paymentdetails\": \"\u003cstring\u003e\",\n \"paymentperiod\": \"\u003cinteger\u003e\",\n \"paymentterms\": \"\u003cstring\u003e\",\n \"purchaseordernumber\": \"\u003cstring\u003e\",\n \"showItemDescription\": \"\u003cboolean\u003e\",\n \"showPhases\": \"\u003cboolean\u003e\",\n \"showcostbreakdown\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"status\": \"voided\",\n \"taxable\": \"\u003cboolean\u003e\",\n \"taxrate\": \"\u003cnumber\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "6d12a64d-79a7-449f-b33f-86107e7c0a2e", "name": "/invoices/:invoiceid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Soft deletes an invoice by setting activeworkstate to 'deleted'.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/invoices/:invoiceid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f8c7ffb8-0b02-4076-932f-168360e27978", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5551de5b-be03-4927-8ff2-27db28227e42", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6f67962d-cb77-405c-ab0e-9610b46a1996", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "95f3cb47-7dde-4b9c-84c3-0b58604a55eb", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "577b8836-5fca-48ce-b29a-1ba8999eb508", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "09fb61b0-bd2e-4f2c-b7f0-0e67ea0497b8", "name": "/invoices/:invoiceid/clone", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"makeTemplate\": \"\u003cboolean\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Clones an existing invoice.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/invoices/:invoiceid/clone", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "clone" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID to clone", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a484413b-63b1-4412-88d2-767261cc90cb", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"makeTemplate\": \"\u003cboolean\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "clone" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID to clone", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "cdc97905-3bb9-4ed5-b88c-b9ff4bd29ae6", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"makeTemplate\": \"\u003cboolean\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "clone" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID to clone", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8fc379c7-0ff9-41bf-b0f2-9eea0288b8ea", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"makeTemplate\": \"\u003cboolean\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "clone" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID to clone", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8a55886b-7559-45e8-9b12-9cdb7410492b", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"makeTemplate\": \"\u003cboolean\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "clone" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID to clone", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "81269ef7-0200-46d3-9646-253d77403533", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"makeTemplate\": \"\u003cboolean\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "clone" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID to clone", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "236c37fc-3984-4d93-99c3-a16e6ba6860c", "name": "/invoices/:invoiceid/items", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of line items for an invoice. Supports field selection, filtering, sorting and pagination.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/invoices/:invoiceid/items", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,itemcollectionid,parentid,itemtypeid,activeworkstate,billAmount" }, { "description": { "content": "Search by item name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to items within a specific phase (itemcollectionid)", "type": "text/plain" }, "disabled": true, "key": "phaseid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by parent item ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by item type ID", "type": "text/plain" }, "disabled": true, "key": "itemtypeid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cstring\u003e\",\n \"createdatetime\": \"\u003cstring\u003e\",\n \"creatorid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"discountRate\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inTaxRate\": \"\u003cnumber\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"isDiscountPercent\": \"\u003cboolean\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outTaxRate\": \"\u003cnumber\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\",\n \"timespent\": \"\u003cnumber\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"uniquetoken\": \"\u003cstring\u003e\",\n \"updatedAt\": \"\u003cnumber\u003e\"\n },\n {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cstring\u003e\",\n \"createdatetime\": \"\u003cstring\u003e\",\n \"creatorid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"discountRate\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inTaxRate\": \"\u003cnumber\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"isDiscountPercent\": \"\u003cboolean\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outTaxRate\": \"\u003cnumber\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\",\n \"timespent\": \"\u003cnumber\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"uniquetoken\": \"\u003cstring\u003e\",\n \"updatedAt\": \"\u003cnumber\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3d5a4e23-f697-4b13-ae32-d281ebbfc9e2", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,itemcollectionid,parentid,itemtypeid,activeworkstate,billAmount" }, { "description": { "content": "Search by item name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to items within a specific phase (itemcollectionid)", "type": "text/plain" }, "disabled": true, "key": "phaseid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by parent item ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by item type ID", "type": "text/plain" }, "disabled": true, "key": "itemtypeid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5b7bace2-7555-4128-8926-5716a73839e2", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,itemcollectionid,parentid,itemtypeid,activeworkstate,billAmount" }, { "description": { "content": "Search by item name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to items within a specific phase (itemcollectionid)", "type": "text/plain" }, "disabled": true, "key": "phaseid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by parent item ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by item type ID", "type": "text/plain" }, "disabled": true, "key": "itemtypeid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a9b27b83-a00d-4c8f-bc59-12d3eb9c16b3", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,itemcollectionid,parentid,itemtypeid,activeworkstate,billAmount" }, { "description": { "content": "Search by item name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to items within a specific phase (itemcollectionid)", "type": "text/plain" }, "disabled": true, "key": "phaseid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by parent item ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by item type ID", "type": "text/plain" }, "disabled": true, "key": "itemtypeid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "680b9f19-fab4-49cc-8cbb-7ecf32d31cee", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,itemcollectionid,parentid,itemtypeid,activeworkstate,billAmount" }, { "description": { "content": "Search by item name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to items within a specific phase (itemcollectionid)", "type": "text/plain" }, "disabled": true, "key": "phaseid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by parent item ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by item type ID", "type": "text/plain" }, "disabled": true, "key": "itemtypeid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] }, { "event": [], "id": "f2b0549a-0613-495b-a20b-2ece83449465", "name": "/invoices/:invoiceid/items", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billable\": \"\u003cboolean\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Creates one or more line items within an invoice phase.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/invoices/:invoiceid/items", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "items" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "259e54e6-fd5f-4c8c-9f97-2fb7f7164020", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billable\": \"\u003cboolean\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "items" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2765bd60-036e-4b1d-b1ca-f483577bfca3", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billable\": \"\u003cboolean\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "items" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "89e2bd06-ae10-4696-8fff-01d27881b705", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billable\": \"\u003cboolean\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "items" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d5734451-695f-4539-b843-7a5a15390eb6", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billable\": \"\u003cboolean\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "items" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] }, { "event": [], "id": "09e1f13c-2b18-4ca6-bb8f-f379aa31e1e6", "name": "/invoices/:invoiceid/items/:itemid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns full details of a single invoice line item by ID.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/invoices/:invoiceid/items/:itemid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cstring\u003e\",\n \"createdatetime\": \"\u003cstring\u003e\",\n \"creatorid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"discountRate\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inTaxRate\": \"\u003cnumber\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"isDiscountPercent\": \"\u003cboolean\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outTaxRate\": \"\u003cnumber\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\",\n \"timespent\": \"\u003cnumber\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"uniquetoken\": \"\u003cstring\u003e\",\n \"updatedAt\": \"\u003cnumber\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a13e4939-34f8-4a86-a856-4e15e52ed436", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e2afed43-0fce-424d-99c2-26cb99b7a2e1", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e8592237-3161-44d9-84ad-cbb5880df8cf", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "818d21b4-7795-4f56-80c7-39bd80e754e6", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c36d93eb-ef8b-4425-a18f-6c7df0cc0f5d", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "288494c8-314a-4ce1-8ec8-a549dc759d05", "name": "/invoices/:invoiceid/items/:itemid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Updates an existing invoice line item.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/invoices/:invoiceid/items/:itemid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "45351b34-519a-4e91-9976-efeaec58c29e", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "71560e7e-8392-4a07-9ae7-ff3033327375", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3cf08326-3b3c-402b-ba4c-b32c7095f35f", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "532804de-f7df-4a8e-a646-492f56e793e4", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3fa7a554-9178-44b5-9f06-dde5c1e13d36", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "61f6c4d5-fdd1-428d-bd74-6fc3a383a389", "name": "/invoices/:invoiceid/items/:itemid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Soft-deletes an invoice line item.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/invoices/:invoiceid/items/:itemid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9ab8f12a-4c31-4f06-a589-0eb43e6470ae", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9b10421b-f961-403c-84ea-5441360c92ba", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "295bcbc5-74b0-4f7e-9980-b3700a00f993", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "aba55c7e-1008-432c-94d3-524fbd13548d", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9686c428-b5c2-45db-8893-672b2ee1f917", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "8d1ab651-d0e9-49d1-bc9a-6ad5779e3e1c", "name": "/invoices/:invoiceid/items/:itemid/workstages", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns the workstage history for an invoice line item.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/invoices/:invoiceid/items/:itemid/workstages", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "items", ":itemid", "workstages" ], "query": [ { "description": { "content": "Sort field (This can only be one of setdatetime,id)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "setdatetime" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "desc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"active\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemcontactid\": \"\u003cstring\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"setdatetime\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\"\n },\n {\n \"active\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemcontactid\": \"\u003cstring\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"setdatetime\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e62fcd7d-b63b-401c-9a16-9bbad6df35bd", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "items", ":itemid", "workstages" ], "query": [ { "description": { "content": "Sort field (This can only be one of setdatetime,id)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "setdatetime" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "desc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f78fa2aa-1865-4306-8b98-427bebee9a6d", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "items", ":itemid", "workstages" ], "query": [ { "description": { "content": "Sort field (This can only be one of setdatetime,id)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "setdatetime" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "desc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e8874135-5878-4c22-84c1-220538269ab1", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "items", ":itemid", "workstages" ], "query": [ { "description": { "content": "Sort field (This can only be one of setdatetime,id)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "setdatetime" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "desc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "06e2ca58-7aeb-4f40-a82f-97abd3afc3ba", "name": "/invoices/:invoiceid/order", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"placeafterid\": \"\u003cinteger\u003e\",\n \"placebeforeid\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Moves an invoice before or after another invoice using sortorder. Provide exactly one of placeafterid or placebeforeid.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/invoices/:invoiceid/order", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "order" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "717fcc6f-d0c1-416f-babc-b3942b3f4c6d", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"placeafterid\": \"\u003cinteger\u003e\",\n \"placebeforeid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "order" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a5a4f227-d81c-4870-8402-245f88734adf", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"placeafterid\": \"\u003cinteger\u003e\",\n \"placebeforeid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "order" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3cacd04f-912d-4189-b5a9-eb0678cac180", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"placeafterid\": \"\u003cinteger\u003e\",\n \"placebeforeid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "order" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "230dc83a-aef6-481a-b483-294d979e4841", "name": "/invoices/:invoiceid/phases", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of phases (item collections) for an invoice.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/invoices/:invoiceid/phases", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "phases" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,invoiceid,parentid,billAmount" }, { "description": { "content": "Search by phase name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to phases with a specific parent phase ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"datecreated\": \"\u003cstring\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\"\n },\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"datecreated\": \"\u003cstring\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "15cb5dbe-607e-44e4-817d-d05b862892e1", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "phases" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,invoiceid,parentid,billAmount" }, { "description": { "content": "Search by phase name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to phases with a specific parent phase ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9722fca7-599e-4855-aac2-518d944a1dc0", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "phases" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,invoiceid,parentid,billAmount" }, { "description": { "content": "Search by phase name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to phases with a specific parent phase ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6b82df6d-3528-4134-8c1b-85d860bfc326", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "phases" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,invoiceid,parentid,billAmount" }, { "description": { "content": "Search by phase name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to phases with a specific parent phase ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9b7ccc76-7630-444f-90c3-f656a418d692", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "phases" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,invoiceid,parentid,billAmount" }, { "description": { "content": "Search by phase name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to phases with a specific parent phase ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] }, { "event": [], "id": "e4c4f8f6-910c-4ff8-b46e-fa3aa716950e", "name": "/invoices/:invoiceid/phases", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billtype\": \"\u003cinteger\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Creates one or more phases (item collections) within an invoice.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/invoices/:invoiceid/phases", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "phases" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "225e9c4f-394e-4120-a40d-8de3ed28a7ff", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billtype\": \"\u003cinteger\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "phases" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "10dd384a-f742-4ec7-9479-e519d2324fe4", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billtype\": \"\u003cinteger\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "phases" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b2dc3c69-546d-48d0-afea-9b1475e8cf81", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billtype\": \"\u003cinteger\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "phases" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "874c8d02-e828-4680-8fb7-c64103147233", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billtype\": \"\u003cinteger\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "phases" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] }, { "event": [], "id": "4a41bd7f-2496-4c02-a442-93e30e7141ff", "name": "/invoices/:invoiceid/phases/:phaseid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns full details of a single invoice phase (item collection) by ID.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/invoices/:invoiceid/phases/:phaseid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"datecreated\": \"\u003cstring\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "db53e935-9bae-4439-a30b-95dc234788b0", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d3eb62ab-cb34-44ff-a381-129fe83f0c6e", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "764d83a4-eaeb-4a13-b163-38a81e68ce1a", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "95d7a385-f7e9-4961-a90d-9e92b13cac30", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "39dec2cf-d50b-4c86-8b51-92258ee4ec6a", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "608c20f5-06eb-4ae3-a7a5-7d2f913bed31", "name": "/invoices/:invoiceid/phases/:phaseid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Updates an existing invoice phase.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/invoices/:invoiceid/phases/:phaseid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "270537b3-d16a-4050-b4a8-e74f0f29b775", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ea9fb401-c712-4b70-93ec-361b7c027f22", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "add6eb84-7538-40b0-8168-6254e4f4bcb0", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "56f13dfd-c2b4-4b38-8865-ba72327d3b28", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d572b4be-2e54-47df-bd8a-815e5875724a", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "fae3c1c4-91a4-4952-9da1-8e3490a8f4f3", "name": "/invoices/:invoiceid/phases/:phaseid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Soft-deletes an invoice phase and its associated items.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/invoices/:invoiceid/phases/:phaseid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "149d6341-0e81-4db8-a0cf-8c4fc461ebf5", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7d7c6bde-d447-441d-85b9-5a68d1f92ac2", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f0b1bb7c-f3a0-4981-b307-3472466c2b7d", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "fd178327-f110-4821-a003-ae6a07958195", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6f8f55eb-0d98-4a9e-b897-cd95b9fdf4e5", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "70eedd1a-3524-45cf-8779-e224ba2d1e87", "name": "/invoices/:invoiceid/workstage", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Sets the active work stage for an invoice.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/invoices/:invoiceid/workstage", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "workstage" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "440b269c-398d-4f74-9360-6ac88935eb88", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "workstage" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "643ed046-2506-45db-8b76-24fc5a733c01", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "workstage" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "43406612-2347-4d3c-8929-f3ac88226812", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "workstage" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "f8406db0-fb5b-492e-bd2a-20cc27c35cce", "name": "/invoices/:invoiceid/workstages", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns the workstage history for an invoice.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/invoices/:invoiceid/workstages", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "workstages" ], "query": [ { "description": { "content": "Sort field (This can only be one of setdatetime,id)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "setdatetime" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "desc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"contactid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"setdatetime\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\"\n },\n {\n \"contactid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"setdatetime\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "1506e776-cbb1-485f-9444-e53ecbc3d5e2", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "workstages" ], "query": [ { "description": { "content": "Sort field (This can only be one of setdatetime,id)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "setdatetime" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "desc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9310d29b-b5dc-482b-b5f8-3bbb64589081", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "workstages" ], "query": [ { "description": { "content": "Sort field (This can only be one of setdatetime,id)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "setdatetime" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "desc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a6e0ae3c-f23f-47a8-8960-808bff93bf08", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "workstages" ], "query": [ { "description": { "content": "Sort field (This can only be one of setdatetime,id)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "setdatetime" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "desc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "f2f30845-431a-4312-81e9-e7b033a10887", "name": "/settings/invoices/templates", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a simple list of Invoice Templates.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/invoices/templates", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "invoices", "templates" ], "query": [ { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"taxable\": \"\u003cboolean\u003e\",\n \"taxrate\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"taxable\": \"\u003cboolean\u003e\",\n \"taxrate\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8de2d7f3-5c4d-4313-820a-4a7c93ce484d", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "invoices", "templates" ], "query": [ { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "60ed00b1-85a5-4575-a301-97ef11ee4b41", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "invoices", "templates" ], "query": [ { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "05d3b373-76fc-465c-b462-9d1dd4531b05", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "invoices", "templates" ], "query": [ { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "1fb44363-40ef-432a-919f-21c88f9c67e2", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "invoices", "templates" ], "query": [ { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d84bfcca-6117-4693-b417-e2cabea764f4", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "invoices", "templates" ], "query": [ { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "Not Found" } ] } ], "name": "invoices" }, { "description": "", "item": [ { "event": [], "id": "8905c0e8-a202-442f-95ab-e935b7baae7e", "name": "/me", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns details of the Contact making the request (the authenticated user). Requires JWT authentication — API key auth has no user context.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/me", "url": { "host": [ "{{baseUrl}}" ], "path": [ "me" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"allowlogin\": \"\u003cboolean\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"defaulthourlyrateid\": \"\u003cinteger\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"email\": \"\u003cstring\u003e\",\n \"fax\": \"\u003cstring\u003e\",\n \"firstname\": \"\u003cstring\u003e\",\n \"groups\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"ianatimezone\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"image\": \"\u003cstring\u003e\",\n \"invoicesplugin\": \"\u003cboolean\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"mobilephone\": \"\u003cstring\u003e\",\n \"notes\": [\n {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n },\n {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n }\n ],\n \"payrate\": \"\u003cnumber\u003e\",\n \"payratemultiplier\": \"\u003cnumber\u003e\",\n \"pending\": \"\u003cboolean\u003e\",\n \"plan\": \"\u003cstring\u003e\",\n \"quotesplugin\": \"\u003cboolean\u003e\",\n \"roles\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"state\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\",\n \"tags\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"teams\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"title\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"username\": \"\u003cstring\u003e\",\n \"workphone\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ab1dbe7d-a6f2-4838-af5b-bf19fbf6600a", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "me" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "483aa331-ccc7-4754-aa88-28832c2c76d4", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "me" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b1d7d121-770e-426f-94cd-6b52a435b699", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "me" ], "query": [], "variable": [] } }, "status": "Not Found" } ] } ], "name": "me" }, { "description": "", "item": [ { "event": [], "id": "94e80015-bf8f-417d-ab76-353e4a3ca48f", "name": "/messages", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Messages based on the filters specified. The fields parameter allows you to choose which data fields to return for each Message. IMPORTANT: We recommend using the datefrom option to return only messages added in the timeframe you require.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/messages", "url": { "host": [ "{{baseUrl}}" ], "path": [ "messages" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- subject - Message subject\n- content - Full message body (HTML stripped)\n- originalmessageid - Parent message ID (0 if this started the discussion)\n- project - Project ID, number, and title\n- item (or task) - Item ID and name\n- itemid (or taskid) - Item ID only\n- itemname (or taskname) - Item name only\n- date - Message date (ISO8601)\n- author - All author fields (id, type, name, email, image)\n- authorid - Author contact ID\n- authortype - Author contact type\n- authorname - Author display name\n- authoremail - Author email address\n- authorimage - Author avatar image URL\n- contacts - Recipient contact IDs\n- public - Whether message is public\n- files - File IDs and files-enabled flag\n- replycount - Number of replies\n- all - All fields", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "subject,content,originalmessageid,project,item,date,author,contacts,public,files" }, { "description": { "content": "Search by subject. \n- string - Messages where subject contains string\n- !string - Messages where subject does NOT contain string", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by contact. Comma-separated Contact IDs, 'me', or 'all'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "active" }, { "description": { "content": "Project ID or list of Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by item activeworkstate (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Alias for activeworkstate parameter. (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "deleted" }, { "description": { "content": "Item (task) ID or list of IDs (comma-separated). Alias: taskid", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Alias for itemid parameter.", "type": "text/plain" }, "disabled": true, "key": "taskid", "value": "\u003cstring\u003e" }, { "description": { "content": "Original Message ID - returns messages in the discussion started by this message", "type": "text/plain" }, "disabled": true, "key": "originalmessageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages added on or after this date (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "datefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages added on or before this date (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "dateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Message IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,date,originalmessageid,projectid,itemid,taskid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "desc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"authoremail\": \"\u003cstring\u003e\",\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorimage\": \"\u003cstring\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"authortype\": \"\u003cstring\u003e\",\n \"contacts\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"files\": \"\u003cstring\u003e\",\n \"filesenabled\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"itemname\": \"\u003cstring\u003e\",\n \"originalmessageid\": \"\u003cinteger\u003e\",\n \"projectcontacts\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectmanagerid\": \"\u003cinteger\u003e\",\n \"projectmanagername\": \"\u003cstring\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"replies\": [\n {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorimage\": \"\u003cstring\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"authortype\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"files\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n },\n {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorimage\": \"\u003cstring\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"authortype\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"files\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n }\n ],\n \"replycount\": \"\u003cinteger\u003e\",\n \"subject\": \"\u003cstring\u003e\"\n },\n {\n \"authoremail\": \"\u003cstring\u003e\",\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorimage\": \"\u003cstring\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"authortype\": \"\u003cstring\u003e\",\n \"contacts\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"files\": \"\u003cstring\u003e\",\n \"filesenabled\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"itemname\": \"\u003cstring\u003e\",\n \"originalmessageid\": \"\u003cinteger\u003e\",\n \"projectcontacts\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectmanagerid\": \"\u003cinteger\u003e\",\n \"projectmanagername\": \"\u003cstring\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"replies\": [\n {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorimage\": \"\u003cstring\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"authortype\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"files\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n },\n {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorimage\": \"\u003cstring\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"authortype\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"files\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n }\n ],\n \"replycount\": \"\u003cinteger\u003e\",\n \"subject\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3df5d4bd-ea19-47b3-9f18-484305fb4ef4", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "messages" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- subject - Message subject\n- content - Full message body (HTML stripped)\n- originalmessageid - Parent message ID (0 if this started the discussion)\n- project - Project ID, number, and title\n- item (or task) - Item ID and name\n- itemid (or taskid) - Item ID only\n- itemname (or taskname) - Item name only\n- date - Message date (ISO8601)\n- author - All author fields (id, type, name, email, image)\n- authorid - Author contact ID\n- authortype - Author contact type\n- authorname - Author display name\n- authoremail - Author email address\n- authorimage - Author avatar image URL\n- contacts - Recipient contact IDs\n- public - Whether message is public\n- files - File IDs and files-enabled flag\n- replycount - Number of replies\n- all - All fields", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "subject,content,originalmessageid,project,item,date,author,contacts,public,files" }, { "description": { "content": "Search by subject. \n- string - Messages where subject contains string\n- !string - Messages where subject does NOT contain string", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by contact. Comma-separated Contact IDs, 'me', or 'all'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "active" }, { "description": { "content": "Project ID or list of Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by item activeworkstate (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Alias for activeworkstate parameter. (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "deleted" }, { "description": { "content": "Item (task) ID or list of IDs (comma-separated). Alias: taskid", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Alias for itemid parameter.", "type": "text/plain" }, "disabled": true, "key": "taskid", "value": "\u003cstring\u003e" }, { "description": { "content": "Original Message ID - returns messages in the discussion started by this message", "type": "text/plain" }, "disabled": true, "key": "originalmessageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages added on or after this date (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "datefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages added on or before this date (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "dateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Message IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,date,originalmessageid,projectid,itemid,taskid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "desc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9d68cc6d-82a5-4922-8268-2ee5a56c93e5", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "messages" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- subject - Message subject\n- content - Full message body (HTML stripped)\n- originalmessageid - Parent message ID (0 if this started the discussion)\n- project - Project ID, number, and title\n- item (or task) - Item ID and name\n- itemid (or taskid) - Item ID only\n- itemname (or taskname) - Item name only\n- date - Message date (ISO8601)\n- author - All author fields (id, type, name, email, image)\n- authorid - Author contact ID\n- authortype - Author contact type\n- authorname - Author display name\n- authoremail - Author email address\n- authorimage - Author avatar image URL\n- contacts - Recipient contact IDs\n- public - Whether message is public\n- files - File IDs and files-enabled flag\n- replycount - Number of replies\n- all - All fields", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "subject,content,originalmessageid,project,item,date,author,contacts,public,files" }, { "description": { "content": "Search by subject. \n- string - Messages where subject contains string\n- !string - Messages where subject does NOT contain string", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by contact. Comma-separated Contact IDs, 'me', or 'all'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "active" }, { "description": { "content": "Project ID or list of Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by item activeworkstate (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Alias for activeworkstate parameter. (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "deleted" }, { "description": { "content": "Item (task) ID or list of IDs (comma-separated). Alias: taskid", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Alias for itemid parameter.", "type": "text/plain" }, "disabled": true, "key": "taskid", "value": "\u003cstring\u003e" }, { "description": { "content": "Original Message ID - returns messages in the discussion started by this message", "type": "text/plain" }, "disabled": true, "key": "originalmessageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages added on or after this date (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "datefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages added on or before this date (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "dateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Message IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,date,originalmessageid,projectid,itemid,taskid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "desc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6495a3fd-7fe3-42cd-9d66-4a92639b4bf1", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "messages" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- subject - Message subject\n- content - Full message body (HTML stripped)\n- originalmessageid - Parent message ID (0 if this started the discussion)\n- project - Project ID, number, and title\n- item (or task) - Item ID and name\n- itemid (or taskid) - Item ID only\n- itemname (or taskname) - Item name only\n- date - Message date (ISO8601)\n- author - All author fields (id, type, name, email, image)\n- authorid - Author contact ID\n- authortype - Author contact type\n- authorname - Author display name\n- authoremail - Author email address\n- authorimage - Author avatar image URL\n- contacts - Recipient contact IDs\n- public - Whether message is public\n- files - File IDs and files-enabled flag\n- replycount - Number of replies\n- all - All fields", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "subject,content,originalmessageid,project,item,date,author,contacts,public,files" }, { "description": { "content": "Search by subject. \n- string - Messages where subject contains string\n- !string - Messages where subject does NOT contain string", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by contact. Comma-separated Contact IDs, 'me', or 'all'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "active" }, { "description": { "content": "Project ID or list of Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by item activeworkstate (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Alias for activeworkstate parameter. (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "deleted" }, { "description": { "content": "Item (task) ID or list of IDs (comma-separated). Alias: taskid", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Alias for itemid parameter.", "type": "text/plain" }, "disabled": true, "key": "taskid", "value": "\u003cstring\u003e" }, { "description": { "content": "Original Message ID - returns messages in the discussion started by this message", "type": "text/plain" }, "disabled": true, "key": "originalmessageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages added on or after this date (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "datefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages added on or before this date (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "dateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Message IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,date,originalmessageid,projectid,itemid,taskid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "desc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "01382e30-be54-4abe-92e4-9fadce99a42b", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "messages" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- subject - Message subject\n- content - Full message body (HTML stripped)\n- originalmessageid - Parent message ID (0 if this started the discussion)\n- project - Project ID, number, and title\n- item (or task) - Item ID and name\n- itemid (or taskid) - Item ID only\n- itemname (or taskname) - Item name only\n- date - Message date (ISO8601)\n- author - All author fields (id, type, name, email, image)\n- authorid - Author contact ID\n- authortype - Author contact type\n- authorname - Author display name\n- authoremail - Author email address\n- authorimage - Author avatar image URL\n- contacts - Recipient contact IDs\n- public - Whether message is public\n- files - File IDs and files-enabled flag\n- replycount - Number of replies\n- all - All fields", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "subject,content,originalmessageid,project,item,date,author,contacts,public,files" }, { "description": { "content": "Search by subject. \n- string - Messages where subject contains string\n- !string - Messages where subject does NOT contain string", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by contact. Comma-separated Contact IDs, 'me', or 'all'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "active" }, { "description": { "content": "Project ID or list of Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by item activeworkstate (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Alias for activeworkstate parameter. (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "deleted" }, { "description": { "content": "Item (task) ID or list of IDs (comma-separated). Alias: taskid", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Alias for itemid parameter.", "type": "text/plain" }, "disabled": true, "key": "taskid", "value": "\u003cstring\u003e" }, { "description": { "content": "Original Message ID - returns messages in the discussion started by this message", "type": "text/plain" }, "disabled": true, "key": "originalmessageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages added on or after this date (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "datefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages added on or before this date (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "dateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Message IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,date,originalmessageid,projectid,itemid,taskid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "desc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "1742f11b-7e18-4191-b254-ee8cb07794fc", "name": "/messages", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"content\": \"\u003cstring\u003e\",\n \"fileid\": \"\u003cstring\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"subject\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Add a Message to a project or item discussion, or reply to an existing message. For new discussions, provide subject, content, contacts, and either projectid or itemid. For replies, provide content and originalmessageid.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/messages", "url": { "host": [ "{{baseUrl}}" ], "path": [ "messages" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a348c16f-b827-488b-919e-e4f57bb2c420", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"content\": \"\u003cstring\u003e\",\n \"fileid\": \"\u003cstring\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"subject\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "messages" ], "query": [], "variable": [] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a7a7e099-13e4-4cc4-801d-ffc9441a8016", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"content\": \"\u003cstring\u003e\",\n \"fileid\": \"\u003cstring\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"subject\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "messages" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b52e30a9-7dc6-4dfe-8a3c-4bcf3a137ccc", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"content\": \"\u003cstring\u003e\",\n \"fileid\": \"\u003cstring\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"subject\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "messages" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "88c2e4fc-3583-41bc-a333-d6575f2fa231", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"content\": \"\u003cstring\u003e\",\n \"fileid\": \"\u003cstring\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"subject\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "messages" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "5e3e8a93-2e55-4ada-a95a-2ce6e714ce2b", "name": "/messages/contacts", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Adds one or more Contacts to one or more Messages.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/messages/contacts", "url": { "host": [ "{{baseUrl}}" ], "path": [ "messages", "contacts" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "99e3931e-19e3-48bf-833a-982fd501a4c8", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "messages", "contacts" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e9b4112a-a715-4659-941d-143e34e158fd", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "messages", "contacts" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "cd403e77-eae8-47c8-a616-d58d40494ecb", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "messages", "contacts" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "0791c4cf-d456-4999-aeed-cf56d3df9b7f", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "messages", "contacts" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "b141e6ee-9007-404c-9a34-77fcbfad14bb", "name": "/messages/contacts", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Removes one or more Contacts from one or more Messages. Note: you cannot remove a recipient who has replied to the discussion.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/messages/contacts", "url": { "host": [ "{{baseUrl}}" ], "path": [ "messages", "contacts" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "37ed41d6-4a83-456d-a9d8-e3629d0f86f9", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "messages", "contacts" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "1fa5482f-08c6-49fd-8d1c-a44eee58e3f0", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "messages", "contacts" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d4c9b519-d560-45c3-bffe-fe94499b9de3", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "messages", "contacts" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "aa4968b3-5c6a-457b-abd6-a197506b799b", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "messages", "contacts" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "d5eee06f-a421-4f62-af10-ae7dd1962370", "name": "/messages/:messageid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns details of a single Message including all replies. The projectcontacts parameter (staff only) includes the list of contacts assigned to the message's project, for use when composing replies.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/messages/:messageid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "messages", ":messageid" ], "query": [ { "description": { "content": "Return project contacts (staff only) (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "projectcontacts", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Message ID", "type": "text/plain" }, "disabled": false, "key": "messageid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"authoremail\": \"\u003cstring\u003e\",\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorimage\": \"\u003cstring\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"authortype\": \"\u003cstring\u003e\",\n \"contacts\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"files\": \"\u003cstring\u003e\",\n \"filesenabled\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"itemname\": \"\u003cstring\u003e\",\n \"originalmessageid\": \"\u003cinteger\u003e\",\n \"projectcontacts\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectmanagerid\": \"\u003cinteger\u003e\",\n \"projectmanagername\": \"\u003cstring\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"replies\": [\n {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorimage\": \"\u003cstring\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"authortype\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"files\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n },\n {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorimage\": \"\u003cstring\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"authortype\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"files\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n }\n ],\n \"replycount\": \"\u003cinteger\u003e\",\n \"subject\": \"\u003cstring\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8b989db4-dcc0-4f34-a6ac-5d2d33f8c8fb", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "messages", ":messageid" ], "query": [ { "description": { "content": "Return project contacts (staff only) (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "projectcontacts", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Message ID", "type": "text/plain" }, "disabled": false, "key": "messageid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "eded61a5-fb7a-485a-8bae-4108167049ce", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "messages", ":messageid" ], "query": [ { "description": { "content": "Return project contacts (staff only) (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "projectcontacts", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Message ID", "type": "text/plain" }, "disabled": false, "key": "messageid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f47fc33d-635f-4d92-a7ae-b835d3da3b47", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "messages", ":messageid" ], "query": [ { "description": { "content": "Return project contacts (staff only) (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "projectcontacts", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Message ID", "type": "text/plain" }, "disabled": false, "key": "messageid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "21a0f768-539c-47c9-b57c-140904aed758", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "messages", ":messageid" ], "query": [ { "description": { "content": "Return project contacts (staff only) (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "projectcontacts", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Message ID", "type": "text/plain" }, "disabled": false, "key": "messageid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "303f9ed6-b4b1-40d0-8946-89e4cfc57f5e", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "messages", ":messageid" ], "query": [ { "description": { "content": "Return project contacts (staff only) (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "projectcontacts", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Message ID", "type": "text/plain" }, "disabled": false, "key": "messageid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "4e988e0c-18b9-480f-a29e-18622c88e038", "name": "/messages/:messageid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"notifications\": \"\u003cboolean\u003e\",\n \"public\": \"\u003cboolean\u003e\"\n}" }, "description": { "content": "Updates a Message.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/messages/:messageid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "messages", ":messageid" ], "query": [], "variable": [ { "description": { "content": "(Required) Message ID", "type": "text/plain" }, "disabled": false, "key": "messageid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "cd49fc50-33da-4f2a-95db-11c22ed15424", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"notifications\": \"\u003cboolean\u003e\",\n \"public\": \"\u003cboolean\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "messages", ":messageid" ], "query": [], "variable": [ { "description": { "content": "(Required) Message ID", "type": "text/plain" }, "disabled": false, "key": "messageid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7c952262-bfc4-4648-8e76-0a42f0e3d48b", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"notifications\": \"\u003cboolean\u003e\",\n \"public\": \"\u003cboolean\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "messages", ":messageid" ], "query": [], "variable": [ { "description": { "content": "(Required) Message ID", "type": "text/plain" }, "disabled": false, "key": "messageid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "00782e15-e752-4ce9-b759-e817288a10ef", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"notifications\": \"\u003cboolean\u003e\",\n \"public\": \"\u003cboolean\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "messages", ":messageid" ], "query": [], "variable": [ { "description": { "content": "(Required) Message ID", "type": "text/plain" }, "disabled": false, "key": "messageid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c8f3fa3f-4aa4-4532-9d52-8c20093ab842", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"notifications\": \"\u003cboolean\u003e\",\n \"public\": \"\u003cboolean\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "messages", ":messageid" ], "query": [], "variable": [ { "description": { "content": "(Required) Message ID", "type": "text/plain" }, "disabled": false, "key": "messageid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c71c4f08-5965-4d4b-b310-9c47bec3a665", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"notifications\": \"\u003cboolean\u003e\",\n \"public\": \"\u003cboolean\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "messages", ":messageid" ], "query": [], "variable": [ { "description": { "content": "(Required) Message ID", "type": "text/plain" }, "disabled": false, "key": "messageid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "57fb6c25-a61f-4673-9960-41b25b406eee", "name": "/messages/:messageid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Deletes a Message.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/messages/:messageid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "messages", ":messageid" ], "query": [], "variable": [ { "description": { "content": "(Required) Message ID", "type": "text/plain" }, "disabled": false, "key": "messageid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "fc987db1-719e-4e00-b695-50c708af3797", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "messages", ":messageid" ], "query": [], "variable": [ { "description": { "content": "(Required) Message ID", "type": "text/plain" }, "disabled": false, "key": "messageid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "33cecc3c-8da3-4fd0-bdb1-02d0748f779a", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "messages", ":messageid" ], "query": [], "variable": [ { "description": { "content": "(Required) Message ID", "type": "text/plain" }, "disabled": false, "key": "messageid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ecd37c45-88e3-4360-8de6-626607a27930", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "messages", ":messageid" ], "query": [], "variable": [ { "description": { "content": "(Required) Message ID", "type": "text/plain" }, "disabled": false, "key": "messageid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "90829ac4-861e-41ea-94c3-1f0e04d6e077", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "messages", ":messageid" ], "query": [], "variable": [ { "description": { "content": "(Required) Message ID", "type": "text/plain" }, "disabled": false, "key": "messageid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ae74bd65-d313-47ce-b8e7-5e4537182777", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "messages", ":messageid" ], "query": [], "variable": [ { "description": { "content": "(Required) Message ID", "type": "text/plain" }, "disabled": false, "key": "messageid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] } ], "name": "messages" }, { "description": "", "item": [ { "event": [], "id": "6386a1ee-787f-4198-868b-81b1d1f8f004", "name": "/projectnotes", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Project Notes based on the filters specified. The fields parameter allows you to choose which data fields to return for each Project Note.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/projectnotes", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projectnotes" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- company - Company ID and name\n- content - Note body text\n- lastmodified - Last modified date (UTC)\n- project - Project ID, number, and title\n- title - Note title", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "content,title" }, { "description": { "content": "Search by title. Use ! for negation. Example: website or !layout", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Project Category ID or comma-separated list of IDs. Example: 1,2", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project completion status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "active" }, { "description": { "content": "Project ID or comma-separated list of IDs. Example: 1,2", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company ID or comma-separated list of IDs. Example: 1,2,3", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only). Example: 1", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Notes with ID greater than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Notes with ID less than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated list of Note IDs. Example: 1,2,3,4", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,projectid,title)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize). Example: 2", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber). Example: 10", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"title\": \"\u003cstring\u003e\"\n },\n {\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"title\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "db13b6fe-9818-486e-8e67-442d1baea968", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projectnotes" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- company - Company ID and name\n- content - Note body text\n- lastmodified - Last modified date (UTC)\n- project - Project ID, number, and title\n- title - Note title", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "content,title" }, { "description": { "content": "Search by title. Use ! for negation. Example: website or !layout", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Project Category ID or comma-separated list of IDs. Example: 1,2", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project completion status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "active" }, { "description": { "content": "Project ID or comma-separated list of IDs. Example: 1,2", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company ID or comma-separated list of IDs. Example: 1,2,3", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only). Example: 1", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Notes with ID greater than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Notes with ID less than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated list of Note IDs. Example: 1,2,3,4", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,projectid,title)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize). Example: 2", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber). Example: 10", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "178b6f4c-09cf-4b05-9b72-baa1a441ce0c", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projectnotes" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- company - Company ID and name\n- content - Note body text\n- lastmodified - Last modified date (UTC)\n- project - Project ID, number, and title\n- title - Note title", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "content,title" }, { "description": { "content": "Search by title. Use ! for negation. Example: website or !layout", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Project Category ID or comma-separated list of IDs. Example: 1,2", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project completion status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "active" }, { "description": { "content": "Project ID or comma-separated list of IDs. Example: 1,2", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company ID or comma-separated list of IDs. Example: 1,2,3", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only). Example: 1", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Notes with ID greater than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Notes with ID less than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated list of Note IDs. Example: 1,2,3,4", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,projectid,title)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize). Example: 2", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber). Example: 10", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "cdc35a8e-987b-46ae-8bc3-c5c85dfa5c15", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projectnotes" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- company - Company ID and name\n- content - Note body text\n- lastmodified - Last modified date (UTC)\n- project - Project ID, number, and title\n- title - Note title", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "content,title" }, { "description": { "content": "Search by title. Use ! for negation. Example: website or !layout", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Project Category ID or comma-separated list of IDs. Example: 1,2", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project completion status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "active" }, { "description": { "content": "Project ID or comma-separated list of IDs. Example: 1,2", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company ID or comma-separated list of IDs. Example: 1,2,3", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only). Example: 1", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Notes with ID greater than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Notes with ID less than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated list of Note IDs. Example: 1,2,3,4", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,projectid,title)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize). Example: 2", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber). Example: 10", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "464a923a-c3ba-40db-bdba-98fd6ab2c22e", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projectnotes" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- company - Company ID and name\n- content - Note body text\n- lastmodified - Last modified date (UTC)\n- project - Project ID, number, and title\n- title - Note title", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "content,title" }, { "description": { "content": "Search by title. Use ! for negation. Example: website or !layout", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Project Category ID or comma-separated list of IDs. Example: 1,2", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project completion status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "active" }, { "description": { "content": "Project ID or comma-separated list of IDs. Example: 1,2", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company ID or comma-separated list of IDs. Example: 1,2,3", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only). Example: 1", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Notes with ID greater than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Notes with ID less than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated list of Note IDs. Example: 1,2,3,4", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,projectid,title)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize). Example: 2", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber). Example: 10", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "916927ea-29ed-478c-a49e-1dc6286918a9", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projectnotes" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- company - Company ID and name\n- content - Note body text\n- lastmodified - Last modified date (UTC)\n- project - Project ID, number, and title\n- title - Note title", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "content,title" }, { "description": { "content": "Search by title. Use ! for negation. Example: website or !layout", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Project Category ID or comma-separated list of IDs. Example: 1,2", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project completion status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "active" }, { "description": { "content": "Project ID or comma-separated list of IDs. Example: 1,2", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company ID or comma-separated list of IDs. Example: 1,2,3", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only). Example: 1", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Notes with ID greater than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Notes with ID less than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated list of Note IDs. Example: 1,2,3,4", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,projectid,title)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize). Example: 2", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber). Example: 10", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Not Found" } ] }, { "event": [], "id": "ca16e675-edb8-4d78-add9-b5bd62ec89fc", "name": "/projectnotes", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"content\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Creates a new Project Note.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/projectnotes", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projectnotes" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "197e88bc-468b-4018-a7b6-eb9a96331d89", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"content\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projectnotes" ], "query": [], "variable": [] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "91bb685a-dee5-4314-9ec0-1706bd7c636e", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"content\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projectnotes" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9a7fc3f9-1d99-4fd8-b5ac-8ab11ab88b17", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"content\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projectnotes" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b903250d-e22e-4ee6-bc36-81dd15a1656f", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"content\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projectnotes" ], "query": [], "variable": [] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c667de9f-8047-45a8-b27e-a9660ec77ca6", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"content\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projectnotes" ], "query": [], "variable": [] } }, "status": "Not Found" } ] }, { "event": [], "id": "57f82f33-5dc4-4a02-9051-c3dec0add899", "name": "/projectnotes/:noteid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns details of a single Project Note.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/projectnotes/:noteid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projectnotes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"title\": \"\u003cstring\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "205ca8ae-3244-4713-856a-f36c618861b2", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projectnotes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3cee32ae-daad-44b4-ad65-876b80bc644e", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projectnotes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "20eb49d0-b2b6-4070-b6b4-112fbf8609e6", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projectnotes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ed891cd5-aa6a-416e-b57e-601e8f23feec", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projectnotes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "25f42ffa-6336-445e-ad3f-9724a42f29cc", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projectnotes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "45b8bf71-5fd4-4112-9000-457e08f38916", "name": "/projectnotes/:noteid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"content\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Updates a Project Note.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/projectnotes/:noteid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projectnotes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "068612e9-4b05-4341-ab6e-0f1d0db34823", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"content\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projectnotes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9093aaa0-a046-4821-86e3-5d33a3139610", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"content\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projectnotes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9bd13493-3fcc-4e59-96dd-3f96f278fe4e", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"content\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projectnotes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b91284c2-0023-4094-9c8b-cf004340c90b", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"content\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projectnotes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "62e2cd9b-9308-49fd-913d-138986593f82", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"content\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projectnotes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "aaf03a10-53c6-4358-956b-bdb5c81eaf67", "name": "/projectnotes/:noteid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Soft deletes a Project Note.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/projectnotes/:noteid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projectnotes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "dc383ee6-c671-41c6-9592-d115b84c0e8c", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projectnotes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f997d7fa-2c47-4093-bd8c-08516543d88a", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projectnotes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e341e9d0-c2d2-4476-85ff-0895af4fb101", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projectnotes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "0ad60c8e-70ae-46e4-a6ba-b2b0934285fe", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projectnotes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "46f2e357-74fd-45d0-ab47-afc58421431e", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projectnotes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] } ], "name": "projectnotes" }, { "description": "", "item": [ { "event": [], "id": "ae7d3ee4-e777-4696-a2a4-c15ad69faf22", "name": "/projects", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Projects based on the filters specified.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/projects", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- title - Project title\n- number - Project number/reference code\n- description - Project description (HTML)\n- privatenotes - Private notes as HTML (staff only)\n- sortorder - Sort position\n- deleted - Deleted flag\n- createdate - Date project was created (yyyy-mm-dd)\n- activeworkstate - Work state (active, complete, deleted)\n- template - Whether the project is a template (boolean)\n- isclassic - Whether the project uses classic mode (boolean)\n- status - Returns activeworkstate\n- type - Client type: internal or external (Advanced plan only)\n- workstage - Work stage ID and name\n- workstate - Returns activeworkstate\n- company - Client company ID and name\n- internalclientcontactid - Internal client contact ID (Advanced plan only)\n- internalclientteamid - Internal client team ID (Advanced plan only)\n- internalclientteamname - Internal client team name (Advanced plan only)\n- internalclientgroupid - Internal client group ID (Advanced plan only)\n- internalclientgroupname - Internal client group name (Advanced plan only)\n- manager - Project manager contact ID and full name\n- category - Project category ID and name\n- priority - Priority level (integer: 1=Very High, 2=High, 3=Medium, 4=Low, 5=Very Low)\n- contacts - Returns clients, contractors, and staff as JSON arrays of contact objects [{id, firstname, lastname}]\n- tags - Project tags as a JSON array [{id, name, color}]\n- customfields - Custom field options (Advanced plan only)\n- team - Team ID and name (Advanced plan only)\n- group - Group ID and name (Advanced plan only)\n- staffid - Staff contact IDs (comma-separated)\n- contractorid - Contractor contact IDs (comma-separated)\n- clientid - Client contact IDs (comma-separated)\n- contactid - All contact IDs (comma-separated)\n- tagid - Tag IDs (comma-separated)\n- icalcontactid - iCal contact IDs (comma-separated)\n- integrationfolderid - Integration folder IDs (comma-separated)\n- customfieldoptionid - Custom field option IDs (comma-separated)\n- dates - All date fields: startdate, duedate, completedate\n- startdate - Start date (yyyy-mm-dd)\n- duedate - Due date (yyyy-mm-dd)\n- completedate - Completion date (yyyy-mm-dd)\n- lastmodified - Last modified date in ISO8601 format (UTC)\n- clientaccess - Client access enabled (boolean)\n- clientviewalltasks - Client can view all tasks (boolean)\n- clientviewtime - Client can view time (boolean)\n- staffviewalltasks - Staff can view all tasks (boolean)\n- purchaseordernumber - Client purchase order reference\n- notification - Notifications enabled (boolean)\n- messagessortorder - Messages sort order\n- pdmodulesrightcontainer - Right container module config\n- pdmodulesmaincontainer - Main container module config\n- timeallocated - Total time allocated in decimal hours\n- timetracked - Total time spent/tracked in decimal hours\n- timebillable - Total billable time in decimal hours\n- budget - Project budget including tax (decimal, 2dp)\n- burn - Financial burn (decimal, 2dp)\n- billtotal - Total bill amount including tax (decimal, 2dp)\n- invoicetotal - Total invoiced amount including tax (decimal, 2dp)\n- paidamount - Total paid amount including tax (decimal, 2dp)\n- invoiced - Invoiced status (boolean)\n- percentcomplete - Percentage of tasks completed (integer 0-100, heading tasks excluded)\n- scoring - Scoring/aggregate fields: storypoints, itemscompleted, itemsactive, itemstartdate, itemduedate\n- discount - Discount fields: itemsdiscount\n- units - Unit/pricing fields: inunittotal, outunittotal, costratetype, chargeratetype\n- budgetdetail - Budget detail fields: budgettype, budgettax\n- billingdetail - Billing detail fields: billtype, billamount, billamounttax\n- estimated - Estimated cost/revenue: estinlabour, estintotal, estintotaltax, estoutlabour, estbillamount, estbillamounttax\n- actual - Actual cost/revenue: actualinlabour, actualintotal, actualintotaltax, actualoutlabour\n- projected - Projected values: projectedtimemanual, projectedtimespent, projectedbillamount, projectedbillamounttax\n- profit - Profit/margin fields: estprofit, projectedprofit, estgrossmargin, projectedgrossmargin\n- invoiceddetail - Invoiced detail fields: invoicedamount, invoicedamounttax, paidamounttax\n- all - Returns all available scalar fieldsSub-entity fields (heavy — NOT included by all, must be named explicitly): phases - project phases and their tasks; timerecords - time records; messages - messages; files - files; folders - folders; invoices - linked invoices; workstages - project workstage history; bookmarks - bookmarks; projectnotes - project notes. Use e.g. fields=all,phases or fields=phases,timerecords.", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "\u003cstring\u003e" }, { "description": { "content": "[Deprecated: use title instead] Search. \n- string - Projects where Number or Title contains string Example: website\n- !string - Projects where Number and Title do not contain string Example: !layout", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "[Deprecated: use number instead] Search Number. \n- string - Projects where Number contains string Example: PRJ-2024\n- !string - Projects where Number does not contain string Example: !TEST", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by exact Title. Example: Website Redesign", "type": "text/plain" }, "disabled": true, "key": "title", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by exact Number. Example: PRJ-001", "type": "text/plain" }, "disabled": true, "key": "number", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term. Searches the fields specified by qfields (default: number and title). Example: website", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated list of fields to apply fuzzy search (q) to. Allowed values: number, title. Defaults to both when q is set. Example: number,title", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "\u003cstring\u003e" }, { "description": { "content": "Status (activeworkstate). \n- active - Active Projects\n- complete - Completed Projects\n- deleted - Deleted Projects\n- all - All Projects (excludes deleted) (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "active" }, { "description": { "content": "Alias for status parameter. (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "deleted" }, { "description": { "content": "Company ID or List of Company IDs. \n- companyid/s - Projects in specified Company/ies Example: 1,2,3\n- !companyid/s - Projects NOT for specified Company/ies", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Manager. \n- managerid/s - Contact ID or List of Contact IDs - Projects Managed by any of the specified Contact/s Example: 1,2\n- !managerid/s - Contact ID or List of Contact IDs - Projects NOT Managed by any of the specified Contact/s Example: !1,2\n- me - Projects Managed by Contact making request\n- all - All Projects", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "all" }, { "description": { "content": "Contacts. \n- contactid/s - Contact ID or List of Contact IDs - Projects assigned to ANY/ALL specified Contact/s (see contactsmode parameter) Example: 1,2\n- !contactid/s - Contact ID or List of Contact IDs - Projects NOT assigned to ANY/ALL specified Contact/s (see contactsmode parameter) Example: !1,2\n- me - Projects assigned to Contact making request\n- all - All Projects", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "all" }, { "description": { "content": "Mode used for the contacts parameter. \n- any - Projects assigned to ANY of the specified contacts\n- all - Projects assigned to ALL of the specified contacts (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Team (Advanced plan only). \n- teamid/s - Team ID or List of Team IDs - Projects Managed by any of the specified Team/s Example: 1,2\n- !teamid/s - Team ID or List of Team IDs - Projects NOT Managed by any of the specified Team/s Example: !1,2", "type": "text/plain" }, "disabled": true, "key": "teamid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group (Advanced plan only). \n- groupid/s - Group ID or List of Group IDs - Projects Managed by any of the specified Group/s Example: 1,2\n- !groupid/s - Group ID or List of Group IDs - Projects NOT Managed by any of the specified Group/s Example: !1,2", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Category ID or List of Category IDs. \n- categoryid/s - Projects in specified Category/ies Example: 1,2,3\n- !categoryid/s - Projects NOT in specified Category/ies Example: !1,2,3", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Tag ID or List of Tag IDs. \n- tagid/s - Projects with specified Tag/s Example: 1,2,3\n- !tagid/s - Projects without specified Tag/s Example: !1,2,3", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Priority or List of Priorities (1-5 representing Very High-Very Low). \n- priority/ies - Projects with specified Priority/ies Example: 1,2\n- !priority/ies - Projects NOT with specified Priority/ies Example: !4,5", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Workstage ID or List of Workstage IDs . \n- workstageid/s - Projects with specified Workstages Example: 1,2\n- !workstageid/s - Projects without specified Workstages Example: !1,2", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects starting on or after this date. \n- Specific date - Date in yyyy-mm-dd format Example: 2014-01-18\n- Relative date - +/-Xd/w/m/y Examples: -3w - 3 weeks ago OR +1m - 1 month ahead", "type": "text/plain" }, "disabled": true, "key": "startdatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects starting on or before this date. \n- Specific date - Date in yyyy-mm-dd format Example: 2014-01-18\n- Relative date - +/-Xd/w/m/y Examples: -3w - 3 weeks ago OR +1m - 1 month ahead", "type": "text/plain" }, "disabled": true, "key": "startdateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects due on or after this date. \n- Specific date - Date in yyyy-mm-dd format Example: 2014-01-18\n- Relative date - +/-Xd/w/m/y Examples: -3w - 3 weeks ago OR +1m - 1 month ahead", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects due on or before this date. \n- Specific date - Date in yyyy-mm-dd format Example: 2014-01-18\n- Relative date - +/-Xd/w/m/y Examples: -3w - 3 weeks ago OR +1m - 1 month ahead", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects completed on or after this date. \n- Specific date - Date in yyyy-mm-dd format Example: 2014-01-18\n- Relative date - +/-Xd/w/m/y Examples: -3w - 3 weeks ago OR +1m - 1 month ahead", "type": "text/plain" }, "disabled": true, "key": "completedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects completed on or before this date. \n- Specific date - Date in yyyy-mm-dd format Example: 2014-01-18\n- Relative date - +/-Xd/w/m/y Examples: -3w - 3 weeks ago OR +1m - 1 month ahead", "type": "text/plain" }, "disabled": true, "key": "completedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects added/edited on or after this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects added/edited on or before this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,startdate,duedate,completedate,companyname,categoryname,priority)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"actualInLabour\": \"\u003cnumber\u003e\",\n \"actualInTotal\": \"\u003cnumber\u003e\",\n \"actualInTotalTax\": \"\u003cnumber\u003e\",\n \"actualOutLabour\": \"\u003cnumber\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billtotal\": \"\u003cnumber\u003e\",\n \"bookmarks\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"url\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"url\": \"\u003cstring\u003e\"\n }\n ],\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"burn\": \"\u003cnumber\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"categoryname\": \"\u003cstring\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"clients\": [\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"clienttype\": \"\u003cstring\u003e\",\n \"clientviewalltasks\": \"\u003cboolean\u003e\",\n \"clientviewtime\": \"\u003cboolean\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"contractorid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"contractors\": [\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"createdate\": \"\u003cstring\u003e\",\n \"customfieldoptionid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"customfields\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"value\": \"\u003cstring\u003e\",\n \"valuename\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"value\": \"\u003cstring\u003e\",\n \"valuename\": \"\u003cstring\u003e\"\n }\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"estBillAmount\": \"\u003cnumber\u003e\",\n \"estBillAmountTax\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"files\": [\n {\n \"description\": \"\u003cstring\u003e\",\n \"folderid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"modified\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"uniquetoken\": \"\u003cstring\u003e\"\n },\n {\n \"description\": \"\u003cstring\u003e\",\n \"folderid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"modified\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"uniquetoken\": \"\u003cstring\u003e\"\n }\n ],\n \"folders\": [\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"modified\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"modified\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"groupid\": \"\u003cinteger\u003e\",\n \"groupname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"internalclientcontactid\": \"\u003cinteger\u003e\",\n \"internalclientgroupid\": \"\u003cinteger\u003e\",\n \"internalclientgroupname\": \"\u003cstring\u003e\",\n \"internalclientteamid\": \"\u003cinteger\u003e\",\n \"internalclientteamname\": \"\u003cstring\u003e\",\n \"invoiced\": \"\u003cboolean\u003e\",\n \"invoicedAmount\": \"\u003cnumber\u003e\",\n \"invoicedAmountTax\": \"\u003cnumber\u003e\",\n \"invoices\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoicedate\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"paid\": \"\u003cboolean\u003e\",\n \"paiddate\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoicedate\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"paid\": \"\u003cboolean\u003e\",\n \"paiddate\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\"\n }\n ],\n \"invoicetotal\": \"\u003cnumber\u003e\",\n \"itemDueDate\": \"\u003cstring\u003e\",\n \"itemStartDate\": \"\u003cstring\u003e\",\n \"itemsActive\": \"\u003cinteger\u003e\",\n \"itemsCompleted\": \"\u003cinteger\u003e\",\n \"itemsDiscount\": \"\u003cnumber\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"managerfirstname\": \"\u003cstring\u003e\",\n \"managerid\": \"\u003cinteger\u003e\",\n \"managerlastname\": \"\u003cstring\u003e\",\n \"messages\": [\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"replycount\": \"\u003cinteger\u003e\",\n \"senddate\": \"\u003cstring\u003e\",\n \"senderid\": \"\u003cinteger\u003e\",\n \"shortdetails\": \"\u003cstring\u003e\",\n \"subject\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"replycount\": \"\u003cinteger\u003e\",\n \"senddate\": \"\u003cstring\u003e\",\n \"senderid\": \"\u003cinteger\u003e\",\n \"shortdetails\": \"\u003cstring\u003e\",\n \"subject\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"notification\": \"\u003cboolean\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"paid\": \"\u003cboolean\u003e\",\n \"paidAmountTax\": \"\u003cnumber\u003e\",\n \"paidamount\": \"\u003cnumber\u003e\",\n \"percentcomplete\": \"\u003cinteger\u003e\",\n \"phases\": [\n {\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n }\n ],\n \"name\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n },\n {\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n }\n ],\n \"name\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n }\n ],\n \"priority\": \"\u003cinteger\u003e\",\n \"privatenotes\": \"\u003cstring\u003e\",\n \"projectedBillAmount\": \"\u003cnumber\u003e\",\n \"projectedBillAmountTax\": \"\u003cnumber\u003e\",\n \"projectedGrossMargin\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"projectedTimeManual\": \"\u003cnumber\u003e\",\n \"projectedTimeSpent\": \"\u003cnumber\u003e\",\n \"projectnotes\": [\n {\n \"content\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n },\n {\n \"content\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n }\n ],\n \"purchaseorder\": \"\u003cstring\u003e\",\n \"staff\": [\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"staffid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"staffviewalltasks\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cnumber\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tags\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"teamid\": \"\u003cinteger\u003e\",\n \"teamname\": \"\u003cstring\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\",\n \"timerecords\": [\n {\n \"accountedfor\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"endtime\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"notes\": \"\u003cstring\u003e\",\n \"running\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n },\n {\n \"accountedfor\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"endtime\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"notes\": \"\u003cstring\u003e\",\n \"running\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n }\n ],\n \"timetracked\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\",\n \"workstagename\": \"\u003cstring\u003e\",\n \"workstages\": [\n {\n \"active\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"setdatetime\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\"\n },\n {\n \"active\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"setdatetime\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\"\n }\n ]\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"actualInLabour\": \"\u003cnumber\u003e\",\n \"actualInTotal\": \"\u003cnumber\u003e\",\n \"actualInTotalTax\": \"\u003cnumber\u003e\",\n \"actualOutLabour\": \"\u003cnumber\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billtotal\": \"\u003cnumber\u003e\",\n \"bookmarks\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"url\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"url\": \"\u003cstring\u003e\"\n }\n ],\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"burn\": \"\u003cnumber\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"categoryname\": \"\u003cstring\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"clients\": [\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"clienttype\": \"\u003cstring\u003e\",\n \"clientviewalltasks\": \"\u003cboolean\u003e\",\n \"clientviewtime\": \"\u003cboolean\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"contractorid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"contractors\": [\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"createdate\": \"\u003cstring\u003e\",\n \"customfieldoptionid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"customfields\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"value\": \"\u003cstring\u003e\",\n \"valuename\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"value\": \"\u003cstring\u003e\",\n \"valuename\": \"\u003cstring\u003e\"\n }\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"estBillAmount\": \"\u003cnumber\u003e\",\n \"estBillAmountTax\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"files\": [\n {\n \"description\": \"\u003cstring\u003e\",\n \"folderid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"modified\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"uniquetoken\": \"\u003cstring\u003e\"\n },\n {\n \"description\": \"\u003cstring\u003e\",\n \"folderid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"modified\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"uniquetoken\": \"\u003cstring\u003e\"\n }\n ],\n \"folders\": [\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"modified\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"modified\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"groupid\": \"\u003cinteger\u003e\",\n \"groupname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"internalclientcontactid\": \"\u003cinteger\u003e\",\n \"internalclientgroupid\": \"\u003cinteger\u003e\",\n \"internalclientgroupname\": \"\u003cstring\u003e\",\n \"internalclientteamid\": \"\u003cinteger\u003e\",\n \"internalclientteamname\": \"\u003cstring\u003e\",\n \"invoiced\": \"\u003cboolean\u003e\",\n \"invoicedAmount\": \"\u003cnumber\u003e\",\n \"invoicedAmountTax\": \"\u003cnumber\u003e\",\n \"invoices\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoicedate\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"paid\": \"\u003cboolean\u003e\",\n \"paiddate\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoicedate\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"paid\": \"\u003cboolean\u003e\",\n \"paiddate\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\"\n }\n ],\n \"invoicetotal\": \"\u003cnumber\u003e\",\n \"itemDueDate\": \"\u003cstring\u003e\",\n \"itemStartDate\": \"\u003cstring\u003e\",\n \"itemsActive\": \"\u003cinteger\u003e\",\n \"itemsCompleted\": \"\u003cinteger\u003e\",\n \"itemsDiscount\": \"\u003cnumber\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"managerfirstname\": \"\u003cstring\u003e\",\n \"managerid\": \"\u003cinteger\u003e\",\n \"managerlastname\": \"\u003cstring\u003e\",\n \"messages\": [\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"replycount\": \"\u003cinteger\u003e\",\n \"senddate\": \"\u003cstring\u003e\",\n \"senderid\": \"\u003cinteger\u003e\",\n \"shortdetails\": \"\u003cstring\u003e\",\n \"subject\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"replycount\": \"\u003cinteger\u003e\",\n \"senddate\": \"\u003cstring\u003e\",\n \"senderid\": \"\u003cinteger\u003e\",\n \"shortdetails\": \"\u003cstring\u003e\",\n \"subject\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"notification\": \"\u003cboolean\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"paid\": \"\u003cboolean\u003e\",\n \"paidAmountTax\": \"\u003cnumber\u003e\",\n \"paidamount\": \"\u003cnumber\u003e\",\n \"percentcomplete\": \"\u003cinteger\u003e\",\n \"phases\": [\n {\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n }\n ],\n \"name\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n },\n {\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n }\n ],\n \"name\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n }\n ],\n \"priority\": \"\u003cinteger\u003e\",\n \"privatenotes\": \"\u003cstring\u003e\",\n \"projectedBillAmount\": \"\u003cnumber\u003e\",\n \"projectedBillAmountTax\": \"\u003cnumber\u003e\",\n \"projectedGrossMargin\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"projectedTimeManual\": \"\u003cnumber\u003e\",\n \"projectedTimeSpent\": \"\u003cnumber\u003e\",\n \"projectnotes\": [\n {\n \"content\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n },\n {\n \"content\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n }\n ],\n \"purchaseorder\": \"\u003cstring\u003e\",\n \"staff\": [\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"staffid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"staffviewalltasks\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cnumber\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tags\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"teamid\": \"\u003cinteger\u003e\",\n \"teamname\": \"\u003cstring\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\",\n \"timerecords\": [\n {\n \"accountedfor\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"endtime\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"notes\": \"\u003cstring\u003e\",\n \"running\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n },\n {\n \"accountedfor\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"endtime\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"notes\": \"\u003cstring\u003e\",\n \"running\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n }\n ],\n \"timetracked\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\",\n \"workstagename\": \"\u003cstring\u003e\",\n \"workstages\": [\n {\n \"active\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"setdatetime\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\"\n },\n {\n \"active\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"setdatetime\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\"\n }\n ]\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5257b4a4-c55b-4ff3-bbbe-e2d1ae69529e", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- title - Project title\n- number - Project number/reference code\n- description - Project description (HTML)\n- privatenotes - Private notes as HTML (staff only)\n- sortorder - Sort position\n- deleted - Deleted flag\n- createdate - Date project was created (yyyy-mm-dd)\n- activeworkstate - Work state (active, complete, deleted)\n- template - Whether the project is a template (boolean)\n- isclassic - Whether the project uses classic mode (boolean)\n- status - Returns activeworkstate\n- type - Client type: internal or external (Advanced plan only)\n- workstage - Work stage ID and name\n- workstate - Returns activeworkstate\n- company - Client company ID and name\n- internalclientcontactid - Internal client contact ID (Advanced plan only)\n- internalclientteamid - Internal client team ID (Advanced plan only)\n- internalclientteamname - Internal client team name (Advanced plan only)\n- internalclientgroupid - Internal client group ID (Advanced plan only)\n- internalclientgroupname - Internal client group name (Advanced plan only)\n- manager - Project manager contact ID and full name\n- category - Project category ID and name\n- priority - Priority level (integer: 1=Very High, 2=High, 3=Medium, 4=Low, 5=Very Low)\n- contacts - Returns clients, contractors, and staff as JSON arrays of contact objects [{id, firstname, lastname}]\n- tags - Project tags as a JSON array [{id, name, color}]\n- customfields - Custom field options (Advanced plan only)\n- team - Team ID and name (Advanced plan only)\n- group - Group ID and name (Advanced plan only)\n- staffid - Staff contact IDs (comma-separated)\n- contractorid - Contractor contact IDs (comma-separated)\n- clientid - Client contact IDs (comma-separated)\n- contactid - All contact IDs (comma-separated)\n- tagid - Tag IDs (comma-separated)\n- icalcontactid - iCal contact IDs (comma-separated)\n- integrationfolderid - Integration folder IDs (comma-separated)\n- customfieldoptionid - Custom field option IDs (comma-separated)\n- dates - All date fields: startdate, duedate, completedate\n- startdate - Start date (yyyy-mm-dd)\n- duedate - Due date (yyyy-mm-dd)\n- completedate - Completion date (yyyy-mm-dd)\n- lastmodified - Last modified date in ISO8601 format (UTC)\n- clientaccess - Client access enabled (boolean)\n- clientviewalltasks - Client can view all tasks (boolean)\n- clientviewtime - Client can view time (boolean)\n- staffviewalltasks - Staff can view all tasks (boolean)\n- purchaseordernumber - Client purchase order reference\n- notification - Notifications enabled (boolean)\n- messagessortorder - Messages sort order\n- pdmodulesrightcontainer - Right container module config\n- pdmodulesmaincontainer - Main container module config\n- timeallocated - Total time allocated in decimal hours\n- timetracked - Total time spent/tracked in decimal hours\n- timebillable - Total billable time in decimal hours\n- budget - Project budget including tax (decimal, 2dp)\n- burn - Financial burn (decimal, 2dp)\n- billtotal - Total bill amount including tax (decimal, 2dp)\n- invoicetotal - Total invoiced amount including tax (decimal, 2dp)\n- paidamount - Total paid amount including tax (decimal, 2dp)\n- invoiced - Invoiced status (boolean)\n- percentcomplete - Percentage of tasks completed (integer 0-100, heading tasks excluded)\n- scoring - Scoring/aggregate fields: storypoints, itemscompleted, itemsactive, itemstartdate, itemduedate\n- discount - Discount fields: itemsdiscount\n- units - Unit/pricing fields: inunittotal, outunittotal, costratetype, chargeratetype\n- budgetdetail - Budget detail fields: budgettype, budgettax\n- billingdetail - Billing detail fields: billtype, billamount, billamounttax\n- estimated - Estimated cost/revenue: estinlabour, estintotal, estintotaltax, estoutlabour, estbillamount, estbillamounttax\n- actual - Actual cost/revenue: actualinlabour, actualintotal, actualintotaltax, actualoutlabour\n- projected - Projected values: projectedtimemanual, projectedtimespent, projectedbillamount, projectedbillamounttax\n- profit - Profit/margin fields: estprofit, projectedprofit, estgrossmargin, projectedgrossmargin\n- invoiceddetail - Invoiced detail fields: invoicedamount, invoicedamounttax, paidamounttax\n- all - Returns all available scalar fieldsSub-entity fields (heavy — NOT included by all, must be named explicitly): phases - project phases and their tasks; timerecords - time records; messages - messages; files - files; folders - folders; invoices - linked invoices; workstages - project workstage history; bookmarks - bookmarks; projectnotes - project notes. Use e.g. fields=all,phases or fields=phases,timerecords.", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "\u003cstring\u003e" }, { "description": { "content": "[Deprecated: use title instead] Search. \n- string - Projects where Number or Title contains string Example: website\n- !string - Projects where Number and Title do not contain string Example: !layout", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "[Deprecated: use number instead] Search Number. \n- string - Projects where Number contains string Example: PRJ-2024\n- !string - Projects where Number does not contain string Example: !TEST", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by exact Title. Example: Website Redesign", "type": "text/plain" }, "disabled": true, "key": "title", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by exact Number. Example: PRJ-001", "type": "text/plain" }, "disabled": true, "key": "number", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term. Searches the fields specified by qfields (default: number and title). Example: website", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated list of fields to apply fuzzy search (q) to. Allowed values: number, title. Defaults to both when q is set. Example: number,title", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "\u003cstring\u003e" }, { "description": { "content": "Status (activeworkstate). \n- active - Active Projects\n- complete - Completed Projects\n- deleted - Deleted Projects\n- all - All Projects (excludes deleted) (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "active" }, { "description": { "content": "Alias for status parameter. (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "deleted" }, { "description": { "content": "Company ID or List of Company IDs. \n- companyid/s - Projects in specified Company/ies Example: 1,2,3\n- !companyid/s - Projects NOT for specified Company/ies", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Manager. \n- managerid/s - Contact ID or List of Contact IDs - Projects Managed by any of the specified Contact/s Example: 1,2\n- !managerid/s - Contact ID or List of Contact IDs - Projects NOT Managed by any of the specified Contact/s Example: !1,2\n- me - Projects Managed by Contact making request\n- all - All Projects", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "all" }, { "description": { "content": "Contacts. \n- contactid/s - Contact ID or List of Contact IDs - Projects assigned to ANY/ALL specified Contact/s (see contactsmode parameter) Example: 1,2\n- !contactid/s - Contact ID or List of Contact IDs - Projects NOT assigned to ANY/ALL specified Contact/s (see contactsmode parameter) Example: !1,2\n- me - Projects assigned to Contact making request\n- all - All Projects", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "all" }, { "description": { "content": "Mode used for the contacts parameter. \n- any - Projects assigned to ANY of the specified contacts\n- all - Projects assigned to ALL of the specified contacts (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Team (Advanced plan only). \n- teamid/s - Team ID or List of Team IDs - Projects Managed by any of the specified Team/s Example: 1,2\n- !teamid/s - Team ID or List of Team IDs - Projects NOT Managed by any of the specified Team/s Example: !1,2", "type": "text/plain" }, "disabled": true, "key": "teamid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group (Advanced plan only). \n- groupid/s - Group ID or List of Group IDs - Projects Managed by any of the specified Group/s Example: 1,2\n- !groupid/s - Group ID or List of Group IDs - Projects NOT Managed by any of the specified Group/s Example: !1,2", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Category ID or List of Category IDs. \n- categoryid/s - Projects in specified Category/ies Example: 1,2,3\n- !categoryid/s - Projects NOT in specified Category/ies Example: !1,2,3", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Tag ID or List of Tag IDs. \n- tagid/s - Projects with specified Tag/s Example: 1,2,3\n- !tagid/s - Projects without specified Tag/s Example: !1,2,3", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Priority or List of Priorities (1-5 representing Very High-Very Low). \n- priority/ies - Projects with specified Priority/ies Example: 1,2\n- !priority/ies - Projects NOT with specified Priority/ies Example: !4,5", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Workstage ID or List of Workstage IDs . \n- workstageid/s - Projects with specified Workstages Example: 1,2\n- !workstageid/s - Projects without specified Workstages Example: !1,2", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects starting on or after this date. \n- Specific date - Date in yyyy-mm-dd format Example: 2014-01-18\n- Relative date - +/-Xd/w/m/y Examples: -3w - 3 weeks ago OR +1m - 1 month ahead", "type": "text/plain" }, "disabled": true, "key": "startdatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects starting on or before this date. \n- Specific date - Date in yyyy-mm-dd format Example: 2014-01-18\n- Relative date - +/-Xd/w/m/y Examples: -3w - 3 weeks ago OR +1m - 1 month ahead", "type": "text/plain" }, "disabled": true, "key": "startdateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects due on or after this date. \n- Specific date - Date in yyyy-mm-dd format Example: 2014-01-18\n- Relative date - +/-Xd/w/m/y Examples: -3w - 3 weeks ago OR +1m - 1 month ahead", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects due on or before this date. \n- Specific date - Date in yyyy-mm-dd format Example: 2014-01-18\n- Relative date - +/-Xd/w/m/y Examples: -3w - 3 weeks ago OR +1m - 1 month ahead", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects completed on or after this date. \n- Specific date - Date in yyyy-mm-dd format Example: 2014-01-18\n- Relative date - +/-Xd/w/m/y Examples: -3w - 3 weeks ago OR +1m - 1 month ahead", "type": "text/plain" }, "disabled": true, "key": "completedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects completed on or before this date. \n- Specific date - Date in yyyy-mm-dd format Example: 2014-01-18\n- Relative date - +/-Xd/w/m/y Examples: -3w - 3 weeks ago OR +1m - 1 month ahead", "type": "text/plain" }, "disabled": true, "key": "completedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects added/edited on or after this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects added/edited on or before this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,startdate,duedate,completedate,companyname,categoryname,priority)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "630f8da3-4aee-429c-9b2d-fce02321defb", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- title - Project title\n- number - Project number/reference code\n- description - Project description (HTML)\n- privatenotes - Private notes as HTML (staff only)\n- sortorder - Sort position\n- deleted - Deleted flag\n- createdate - Date project was created (yyyy-mm-dd)\n- activeworkstate - Work state (active, complete, deleted)\n- template - Whether the project is a template (boolean)\n- isclassic - Whether the project uses classic mode (boolean)\n- status - Returns activeworkstate\n- type - Client type: internal or external (Advanced plan only)\n- workstage - Work stage ID and name\n- workstate - Returns activeworkstate\n- company - Client company ID and name\n- internalclientcontactid - Internal client contact ID (Advanced plan only)\n- internalclientteamid - Internal client team ID (Advanced plan only)\n- internalclientteamname - Internal client team name (Advanced plan only)\n- internalclientgroupid - Internal client group ID (Advanced plan only)\n- internalclientgroupname - Internal client group name (Advanced plan only)\n- manager - Project manager contact ID and full name\n- category - Project category ID and name\n- priority - Priority level (integer: 1=Very High, 2=High, 3=Medium, 4=Low, 5=Very Low)\n- contacts - Returns clients, contractors, and staff as JSON arrays of contact objects [{id, firstname, lastname}]\n- tags - Project tags as a JSON array [{id, name, color}]\n- customfields - Custom field options (Advanced plan only)\n- team - Team ID and name (Advanced plan only)\n- group - Group ID and name (Advanced plan only)\n- staffid - Staff contact IDs (comma-separated)\n- contractorid - Contractor contact IDs (comma-separated)\n- clientid - Client contact IDs (comma-separated)\n- contactid - All contact IDs (comma-separated)\n- tagid - Tag IDs (comma-separated)\n- icalcontactid - iCal contact IDs (comma-separated)\n- integrationfolderid - Integration folder IDs (comma-separated)\n- customfieldoptionid - Custom field option IDs (comma-separated)\n- dates - All date fields: startdate, duedate, completedate\n- startdate - Start date (yyyy-mm-dd)\n- duedate - Due date (yyyy-mm-dd)\n- completedate - Completion date (yyyy-mm-dd)\n- lastmodified - Last modified date in ISO8601 format (UTC)\n- clientaccess - Client access enabled (boolean)\n- clientviewalltasks - Client can view all tasks (boolean)\n- clientviewtime - Client can view time (boolean)\n- staffviewalltasks - Staff can view all tasks (boolean)\n- purchaseordernumber - Client purchase order reference\n- notification - Notifications enabled (boolean)\n- messagessortorder - Messages sort order\n- pdmodulesrightcontainer - Right container module config\n- pdmodulesmaincontainer - Main container module config\n- timeallocated - Total time allocated in decimal hours\n- timetracked - Total time spent/tracked in decimal hours\n- timebillable - Total billable time in decimal hours\n- budget - Project budget including tax (decimal, 2dp)\n- burn - Financial burn (decimal, 2dp)\n- billtotal - Total bill amount including tax (decimal, 2dp)\n- invoicetotal - Total invoiced amount including tax (decimal, 2dp)\n- paidamount - Total paid amount including tax (decimal, 2dp)\n- invoiced - Invoiced status (boolean)\n- percentcomplete - Percentage of tasks completed (integer 0-100, heading tasks excluded)\n- scoring - Scoring/aggregate fields: storypoints, itemscompleted, itemsactive, itemstartdate, itemduedate\n- discount - Discount fields: itemsdiscount\n- units - Unit/pricing fields: inunittotal, outunittotal, costratetype, chargeratetype\n- budgetdetail - Budget detail fields: budgettype, budgettax\n- billingdetail - Billing detail fields: billtype, billamount, billamounttax\n- estimated - Estimated cost/revenue: estinlabour, estintotal, estintotaltax, estoutlabour, estbillamount, estbillamounttax\n- actual - Actual cost/revenue: actualinlabour, actualintotal, actualintotaltax, actualoutlabour\n- projected - Projected values: projectedtimemanual, projectedtimespent, projectedbillamount, projectedbillamounttax\n- profit - Profit/margin fields: estprofit, projectedprofit, estgrossmargin, projectedgrossmargin\n- invoiceddetail - Invoiced detail fields: invoicedamount, invoicedamounttax, paidamounttax\n- all - Returns all available scalar fieldsSub-entity fields (heavy — NOT included by all, must be named explicitly): phases - project phases and their tasks; timerecords - time records; messages - messages; files - files; folders - folders; invoices - linked invoices; workstages - project workstage history; bookmarks - bookmarks; projectnotes - project notes. Use e.g. fields=all,phases or fields=phases,timerecords.", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "\u003cstring\u003e" }, { "description": { "content": "[Deprecated: use title instead] Search. \n- string - Projects where Number or Title contains string Example: website\n- !string - Projects where Number and Title do not contain string Example: !layout", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "[Deprecated: use number instead] Search Number. \n- string - Projects where Number contains string Example: PRJ-2024\n- !string - Projects where Number does not contain string Example: !TEST", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by exact Title. Example: Website Redesign", "type": "text/plain" }, "disabled": true, "key": "title", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by exact Number. Example: PRJ-001", "type": "text/plain" }, "disabled": true, "key": "number", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term. Searches the fields specified by qfields (default: number and title). Example: website", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated list of fields to apply fuzzy search (q) to. Allowed values: number, title. Defaults to both when q is set. Example: number,title", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "\u003cstring\u003e" }, { "description": { "content": "Status (activeworkstate). \n- active - Active Projects\n- complete - Completed Projects\n- deleted - Deleted Projects\n- all - All Projects (excludes deleted) (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "active" }, { "description": { "content": "Alias for status parameter. (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "deleted" }, { "description": { "content": "Company ID or List of Company IDs. \n- companyid/s - Projects in specified Company/ies Example: 1,2,3\n- !companyid/s - Projects NOT for specified Company/ies", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Manager. \n- managerid/s - Contact ID or List of Contact IDs - Projects Managed by any of the specified Contact/s Example: 1,2\n- !managerid/s - Contact ID or List of Contact IDs - Projects NOT Managed by any of the specified Contact/s Example: !1,2\n- me - Projects Managed by Contact making request\n- all - All Projects", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "all" }, { "description": { "content": "Contacts. \n- contactid/s - Contact ID or List of Contact IDs - Projects assigned to ANY/ALL specified Contact/s (see contactsmode parameter) Example: 1,2\n- !contactid/s - Contact ID or List of Contact IDs - Projects NOT assigned to ANY/ALL specified Contact/s (see contactsmode parameter) Example: !1,2\n- me - Projects assigned to Contact making request\n- all - All Projects", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "all" }, { "description": { "content": "Mode used for the contacts parameter. \n- any - Projects assigned to ANY of the specified contacts\n- all - Projects assigned to ALL of the specified contacts (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Team (Advanced plan only). \n- teamid/s - Team ID or List of Team IDs - Projects Managed by any of the specified Team/s Example: 1,2\n- !teamid/s - Team ID or List of Team IDs - Projects NOT Managed by any of the specified Team/s Example: !1,2", "type": "text/plain" }, "disabled": true, "key": "teamid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group (Advanced plan only). \n- groupid/s - Group ID or List of Group IDs - Projects Managed by any of the specified Group/s Example: 1,2\n- !groupid/s - Group ID or List of Group IDs - Projects NOT Managed by any of the specified Group/s Example: !1,2", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Category ID or List of Category IDs. \n- categoryid/s - Projects in specified Category/ies Example: 1,2,3\n- !categoryid/s - Projects NOT in specified Category/ies Example: !1,2,3", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Tag ID or List of Tag IDs. \n- tagid/s - Projects with specified Tag/s Example: 1,2,3\n- !tagid/s - Projects without specified Tag/s Example: !1,2,3", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Priority or List of Priorities (1-5 representing Very High-Very Low). \n- priority/ies - Projects with specified Priority/ies Example: 1,2\n- !priority/ies - Projects NOT with specified Priority/ies Example: !4,5", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Workstage ID or List of Workstage IDs . \n- workstageid/s - Projects with specified Workstages Example: 1,2\n- !workstageid/s - Projects without specified Workstages Example: !1,2", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects starting on or after this date. \n- Specific date - Date in yyyy-mm-dd format Example: 2014-01-18\n- Relative date - +/-Xd/w/m/y Examples: -3w - 3 weeks ago OR +1m - 1 month ahead", "type": "text/plain" }, "disabled": true, "key": "startdatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects starting on or before this date. \n- Specific date - Date in yyyy-mm-dd format Example: 2014-01-18\n- Relative date - +/-Xd/w/m/y Examples: -3w - 3 weeks ago OR +1m - 1 month ahead", "type": "text/plain" }, "disabled": true, "key": "startdateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects due on or after this date. \n- Specific date - Date in yyyy-mm-dd format Example: 2014-01-18\n- Relative date - +/-Xd/w/m/y Examples: -3w - 3 weeks ago OR +1m - 1 month ahead", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects due on or before this date. \n- Specific date - Date in yyyy-mm-dd format Example: 2014-01-18\n- Relative date - +/-Xd/w/m/y Examples: -3w - 3 weeks ago OR +1m - 1 month ahead", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects completed on or after this date. \n- Specific date - Date in yyyy-mm-dd format Example: 2014-01-18\n- Relative date - +/-Xd/w/m/y Examples: -3w - 3 weeks ago OR +1m - 1 month ahead", "type": "text/plain" }, "disabled": true, "key": "completedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects completed on or before this date. \n- Specific date - Date in yyyy-mm-dd format Example: 2014-01-18\n- Relative date - +/-Xd/w/m/y Examples: -3w - 3 weeks ago OR +1m - 1 month ahead", "type": "text/plain" }, "disabled": true, "key": "completedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects added/edited on or after this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects added/edited on or before this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,startdate,duedate,completedate,companyname,categoryname,priority)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d28f5893-bfbf-4ad9-807e-17ba24770c03", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- title - Project title\n- number - Project number/reference code\n- description - Project description (HTML)\n- privatenotes - Private notes as HTML (staff only)\n- sortorder - Sort position\n- deleted - Deleted flag\n- createdate - Date project was created (yyyy-mm-dd)\n- activeworkstate - Work state (active, complete, deleted)\n- template - Whether the project is a template (boolean)\n- isclassic - Whether the project uses classic mode (boolean)\n- status - Returns activeworkstate\n- type - Client type: internal or external (Advanced plan only)\n- workstage - Work stage ID and name\n- workstate - Returns activeworkstate\n- company - Client company ID and name\n- internalclientcontactid - Internal client contact ID (Advanced plan only)\n- internalclientteamid - Internal client team ID (Advanced plan only)\n- internalclientteamname - Internal client team name (Advanced plan only)\n- internalclientgroupid - Internal client group ID (Advanced plan only)\n- internalclientgroupname - Internal client group name (Advanced plan only)\n- manager - Project manager contact ID and full name\n- category - Project category ID and name\n- priority - Priority level (integer: 1=Very High, 2=High, 3=Medium, 4=Low, 5=Very Low)\n- contacts - Returns clients, contractors, and staff as JSON arrays of contact objects [{id, firstname, lastname}]\n- tags - Project tags as a JSON array [{id, name, color}]\n- customfields - Custom field options (Advanced plan only)\n- team - Team ID and name (Advanced plan only)\n- group - Group ID and name (Advanced plan only)\n- staffid - Staff contact IDs (comma-separated)\n- contractorid - Contractor contact IDs (comma-separated)\n- clientid - Client contact IDs (comma-separated)\n- contactid - All contact IDs (comma-separated)\n- tagid - Tag IDs (comma-separated)\n- icalcontactid - iCal contact IDs (comma-separated)\n- integrationfolderid - Integration folder IDs (comma-separated)\n- customfieldoptionid - Custom field option IDs (comma-separated)\n- dates - All date fields: startdate, duedate, completedate\n- startdate - Start date (yyyy-mm-dd)\n- duedate - Due date (yyyy-mm-dd)\n- completedate - Completion date (yyyy-mm-dd)\n- lastmodified - Last modified date in ISO8601 format (UTC)\n- clientaccess - Client access enabled (boolean)\n- clientviewalltasks - Client can view all tasks (boolean)\n- clientviewtime - Client can view time (boolean)\n- staffviewalltasks - Staff can view all tasks (boolean)\n- purchaseordernumber - Client purchase order reference\n- notification - Notifications enabled (boolean)\n- messagessortorder - Messages sort order\n- pdmodulesrightcontainer - Right container module config\n- pdmodulesmaincontainer - Main container module config\n- timeallocated - Total time allocated in decimal hours\n- timetracked - Total time spent/tracked in decimal hours\n- timebillable - Total billable time in decimal hours\n- budget - Project budget including tax (decimal, 2dp)\n- burn - Financial burn (decimal, 2dp)\n- billtotal - Total bill amount including tax (decimal, 2dp)\n- invoicetotal - Total invoiced amount including tax (decimal, 2dp)\n- paidamount - Total paid amount including tax (decimal, 2dp)\n- invoiced - Invoiced status (boolean)\n- percentcomplete - Percentage of tasks completed (integer 0-100, heading tasks excluded)\n- scoring - Scoring/aggregate fields: storypoints, itemscompleted, itemsactive, itemstartdate, itemduedate\n- discount - Discount fields: itemsdiscount\n- units - Unit/pricing fields: inunittotal, outunittotal, costratetype, chargeratetype\n- budgetdetail - Budget detail fields: budgettype, budgettax\n- billingdetail - Billing detail fields: billtype, billamount, billamounttax\n- estimated - Estimated cost/revenue: estinlabour, estintotal, estintotaltax, estoutlabour, estbillamount, estbillamounttax\n- actual - Actual cost/revenue: actualinlabour, actualintotal, actualintotaltax, actualoutlabour\n- projected - Projected values: projectedtimemanual, projectedtimespent, projectedbillamount, projectedbillamounttax\n- profit - Profit/margin fields: estprofit, projectedprofit, estgrossmargin, projectedgrossmargin\n- invoiceddetail - Invoiced detail fields: invoicedamount, invoicedamounttax, paidamounttax\n- all - Returns all available scalar fieldsSub-entity fields (heavy — NOT included by all, must be named explicitly): phases - project phases and their tasks; timerecords - time records; messages - messages; files - files; folders - folders; invoices - linked invoices; workstages - project workstage history; bookmarks - bookmarks; projectnotes - project notes. Use e.g. fields=all,phases or fields=phases,timerecords.", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "\u003cstring\u003e" }, { "description": { "content": "[Deprecated: use title instead] Search. \n- string - Projects where Number or Title contains string Example: website\n- !string - Projects where Number and Title do not contain string Example: !layout", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "[Deprecated: use number instead] Search Number. \n- string - Projects where Number contains string Example: PRJ-2024\n- !string - Projects where Number does not contain string Example: !TEST", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by exact Title. Example: Website Redesign", "type": "text/plain" }, "disabled": true, "key": "title", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by exact Number. Example: PRJ-001", "type": "text/plain" }, "disabled": true, "key": "number", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term. Searches the fields specified by qfields (default: number and title). Example: website", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated list of fields to apply fuzzy search (q) to. Allowed values: number, title. Defaults to both when q is set. Example: number,title", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "\u003cstring\u003e" }, { "description": { "content": "Status (activeworkstate). \n- active - Active Projects\n- complete - Completed Projects\n- deleted - Deleted Projects\n- all - All Projects (excludes deleted) (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "active" }, { "description": { "content": "Alias for status parameter. (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "deleted" }, { "description": { "content": "Company ID or List of Company IDs. \n- companyid/s - Projects in specified Company/ies Example: 1,2,3\n- !companyid/s - Projects NOT for specified Company/ies", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Manager. \n- managerid/s - Contact ID or List of Contact IDs - Projects Managed by any of the specified Contact/s Example: 1,2\n- !managerid/s - Contact ID or List of Contact IDs - Projects NOT Managed by any of the specified Contact/s Example: !1,2\n- me - Projects Managed by Contact making request\n- all - All Projects", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "all" }, { "description": { "content": "Contacts. \n- contactid/s - Contact ID or List of Contact IDs - Projects assigned to ANY/ALL specified Contact/s (see contactsmode parameter) Example: 1,2\n- !contactid/s - Contact ID or List of Contact IDs - Projects NOT assigned to ANY/ALL specified Contact/s (see contactsmode parameter) Example: !1,2\n- me - Projects assigned to Contact making request\n- all - All Projects", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "all" }, { "description": { "content": "Mode used for the contacts parameter. \n- any - Projects assigned to ANY of the specified contacts\n- all - Projects assigned to ALL of the specified contacts (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Team (Advanced plan only). \n- teamid/s - Team ID or List of Team IDs - Projects Managed by any of the specified Team/s Example: 1,2\n- !teamid/s - Team ID or List of Team IDs - Projects NOT Managed by any of the specified Team/s Example: !1,2", "type": "text/plain" }, "disabled": true, "key": "teamid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group (Advanced plan only). \n- groupid/s - Group ID or List of Group IDs - Projects Managed by any of the specified Group/s Example: 1,2\n- !groupid/s - Group ID or List of Group IDs - Projects NOT Managed by any of the specified Group/s Example: !1,2", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Category ID or List of Category IDs. \n- categoryid/s - Projects in specified Category/ies Example: 1,2,3\n- !categoryid/s - Projects NOT in specified Category/ies Example: !1,2,3", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Tag ID or List of Tag IDs. \n- tagid/s - Projects with specified Tag/s Example: 1,2,3\n- !tagid/s - Projects without specified Tag/s Example: !1,2,3", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Priority or List of Priorities (1-5 representing Very High-Very Low). \n- priority/ies - Projects with specified Priority/ies Example: 1,2\n- !priority/ies - Projects NOT with specified Priority/ies Example: !4,5", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Workstage ID or List of Workstage IDs . \n- workstageid/s - Projects with specified Workstages Example: 1,2\n- !workstageid/s - Projects without specified Workstages Example: !1,2", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects starting on or after this date. \n- Specific date - Date in yyyy-mm-dd format Example: 2014-01-18\n- Relative date - +/-Xd/w/m/y Examples: -3w - 3 weeks ago OR +1m - 1 month ahead", "type": "text/plain" }, "disabled": true, "key": "startdatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects starting on or before this date. \n- Specific date - Date in yyyy-mm-dd format Example: 2014-01-18\n- Relative date - +/-Xd/w/m/y Examples: -3w - 3 weeks ago OR +1m - 1 month ahead", "type": "text/plain" }, "disabled": true, "key": "startdateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects due on or after this date. \n- Specific date - Date in yyyy-mm-dd format Example: 2014-01-18\n- Relative date - +/-Xd/w/m/y Examples: -3w - 3 weeks ago OR +1m - 1 month ahead", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects due on or before this date. \n- Specific date - Date in yyyy-mm-dd format Example: 2014-01-18\n- Relative date - +/-Xd/w/m/y Examples: -3w - 3 weeks ago OR +1m - 1 month ahead", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects completed on or after this date. \n- Specific date - Date in yyyy-mm-dd format Example: 2014-01-18\n- Relative date - +/-Xd/w/m/y Examples: -3w - 3 weeks ago OR +1m - 1 month ahead", "type": "text/plain" }, "disabled": true, "key": "completedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects completed on or before this date. \n- Specific date - Date in yyyy-mm-dd format Example: 2014-01-18\n- Relative date - +/-Xd/w/m/y Examples: -3w - 3 weeks ago OR +1m - 1 month ahead", "type": "text/plain" }, "disabled": true, "key": "completedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects added/edited on or after this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects added/edited on or before this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,startdate,duedate,completedate,companyname,categoryname,priority)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d81be3f9-a6a3-4135-b720-34e6238fb12e", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- title - Project title\n- number - Project number/reference code\n- description - Project description (HTML)\n- privatenotes - Private notes as HTML (staff only)\n- sortorder - Sort position\n- deleted - Deleted flag\n- createdate - Date project was created (yyyy-mm-dd)\n- activeworkstate - Work state (active, complete, deleted)\n- template - Whether the project is a template (boolean)\n- isclassic - Whether the project uses classic mode (boolean)\n- status - Returns activeworkstate\n- type - Client type: internal or external (Advanced plan only)\n- workstage - Work stage ID and name\n- workstate - Returns activeworkstate\n- company - Client company ID and name\n- internalclientcontactid - Internal client contact ID (Advanced plan only)\n- internalclientteamid - Internal client team ID (Advanced plan only)\n- internalclientteamname - Internal client team name (Advanced plan only)\n- internalclientgroupid - Internal client group ID (Advanced plan only)\n- internalclientgroupname - Internal client group name (Advanced plan only)\n- manager - Project manager contact ID and full name\n- category - Project category ID and name\n- priority - Priority level (integer: 1=Very High, 2=High, 3=Medium, 4=Low, 5=Very Low)\n- contacts - Returns clients, contractors, and staff as JSON arrays of contact objects [{id, firstname, lastname}]\n- tags - Project tags as a JSON array [{id, name, color}]\n- customfields - Custom field options (Advanced plan only)\n- team - Team ID and name (Advanced plan only)\n- group - Group ID and name (Advanced plan only)\n- staffid - Staff contact IDs (comma-separated)\n- contractorid - Contractor contact IDs (comma-separated)\n- clientid - Client contact IDs (comma-separated)\n- contactid - All contact IDs (comma-separated)\n- tagid - Tag IDs (comma-separated)\n- icalcontactid - iCal contact IDs (comma-separated)\n- integrationfolderid - Integration folder IDs (comma-separated)\n- customfieldoptionid - Custom field option IDs (comma-separated)\n- dates - All date fields: startdate, duedate, completedate\n- startdate - Start date (yyyy-mm-dd)\n- duedate - Due date (yyyy-mm-dd)\n- completedate - Completion date (yyyy-mm-dd)\n- lastmodified - Last modified date in ISO8601 format (UTC)\n- clientaccess - Client access enabled (boolean)\n- clientviewalltasks - Client can view all tasks (boolean)\n- clientviewtime - Client can view time (boolean)\n- staffviewalltasks - Staff can view all tasks (boolean)\n- purchaseordernumber - Client purchase order reference\n- notification - Notifications enabled (boolean)\n- messagessortorder - Messages sort order\n- pdmodulesrightcontainer - Right container module config\n- pdmodulesmaincontainer - Main container module config\n- timeallocated - Total time allocated in decimal hours\n- timetracked - Total time spent/tracked in decimal hours\n- timebillable - Total billable time in decimal hours\n- budget - Project budget including tax (decimal, 2dp)\n- burn - Financial burn (decimal, 2dp)\n- billtotal - Total bill amount including tax (decimal, 2dp)\n- invoicetotal - Total invoiced amount including tax (decimal, 2dp)\n- paidamount - Total paid amount including tax (decimal, 2dp)\n- invoiced - Invoiced status (boolean)\n- percentcomplete - Percentage of tasks completed (integer 0-100, heading tasks excluded)\n- scoring - Scoring/aggregate fields: storypoints, itemscompleted, itemsactive, itemstartdate, itemduedate\n- discount - Discount fields: itemsdiscount\n- units - Unit/pricing fields: inunittotal, outunittotal, costratetype, chargeratetype\n- budgetdetail - Budget detail fields: budgettype, budgettax\n- billingdetail - Billing detail fields: billtype, billamount, billamounttax\n- estimated - Estimated cost/revenue: estinlabour, estintotal, estintotaltax, estoutlabour, estbillamount, estbillamounttax\n- actual - Actual cost/revenue: actualinlabour, actualintotal, actualintotaltax, actualoutlabour\n- projected - Projected values: projectedtimemanual, projectedtimespent, projectedbillamount, projectedbillamounttax\n- profit - Profit/margin fields: estprofit, projectedprofit, estgrossmargin, projectedgrossmargin\n- invoiceddetail - Invoiced detail fields: invoicedamount, invoicedamounttax, paidamounttax\n- all - Returns all available scalar fieldsSub-entity fields (heavy — NOT included by all, must be named explicitly): phases - project phases and their tasks; timerecords - time records; messages - messages; files - files; folders - folders; invoices - linked invoices; workstages - project workstage history; bookmarks - bookmarks; projectnotes - project notes. Use e.g. fields=all,phases or fields=phases,timerecords.", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "\u003cstring\u003e" }, { "description": { "content": "[Deprecated: use title instead] Search. \n- string - Projects where Number or Title contains string Example: website\n- !string - Projects where Number and Title do not contain string Example: !layout", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "[Deprecated: use number instead] Search Number. \n- string - Projects where Number contains string Example: PRJ-2024\n- !string - Projects where Number does not contain string Example: !TEST", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by exact Title. Example: Website Redesign", "type": "text/plain" }, "disabled": true, "key": "title", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by exact Number. Example: PRJ-001", "type": "text/plain" }, "disabled": true, "key": "number", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term. Searches the fields specified by qfields (default: number and title). Example: website", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated list of fields to apply fuzzy search (q) to. Allowed values: number, title. Defaults to both when q is set. Example: number,title", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "\u003cstring\u003e" }, { "description": { "content": "Status (activeworkstate). \n- active - Active Projects\n- complete - Completed Projects\n- deleted - Deleted Projects\n- all - All Projects (excludes deleted) (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "active" }, { "description": { "content": "Alias for status parameter. (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "deleted" }, { "description": { "content": "Company ID or List of Company IDs. \n- companyid/s - Projects in specified Company/ies Example: 1,2,3\n- !companyid/s - Projects NOT for specified Company/ies", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Manager. \n- managerid/s - Contact ID or List of Contact IDs - Projects Managed by any of the specified Contact/s Example: 1,2\n- !managerid/s - Contact ID or List of Contact IDs - Projects NOT Managed by any of the specified Contact/s Example: !1,2\n- me - Projects Managed by Contact making request\n- all - All Projects", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "all" }, { "description": { "content": "Contacts. \n- contactid/s - Contact ID or List of Contact IDs - Projects assigned to ANY/ALL specified Contact/s (see contactsmode parameter) Example: 1,2\n- !contactid/s - Contact ID or List of Contact IDs - Projects NOT assigned to ANY/ALL specified Contact/s (see contactsmode parameter) Example: !1,2\n- me - Projects assigned to Contact making request\n- all - All Projects", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "all" }, { "description": { "content": "Mode used for the contacts parameter. \n- any - Projects assigned to ANY of the specified contacts\n- all - Projects assigned to ALL of the specified contacts (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Team (Advanced plan only). \n- teamid/s - Team ID or List of Team IDs - Projects Managed by any of the specified Team/s Example: 1,2\n- !teamid/s - Team ID or List of Team IDs - Projects NOT Managed by any of the specified Team/s Example: !1,2", "type": "text/plain" }, "disabled": true, "key": "teamid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group (Advanced plan only). \n- groupid/s - Group ID or List of Group IDs - Projects Managed by any of the specified Group/s Example: 1,2\n- !groupid/s - Group ID or List of Group IDs - Projects NOT Managed by any of the specified Group/s Example: !1,2", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Category ID or List of Category IDs. \n- categoryid/s - Projects in specified Category/ies Example: 1,2,3\n- !categoryid/s - Projects NOT in specified Category/ies Example: !1,2,3", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Tag ID or List of Tag IDs. \n- tagid/s - Projects with specified Tag/s Example: 1,2,3\n- !tagid/s - Projects without specified Tag/s Example: !1,2,3", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Priority or List of Priorities (1-5 representing Very High-Very Low). \n- priority/ies - Projects with specified Priority/ies Example: 1,2\n- !priority/ies - Projects NOT with specified Priority/ies Example: !4,5", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Workstage ID or List of Workstage IDs . \n- workstageid/s - Projects with specified Workstages Example: 1,2\n- !workstageid/s - Projects without specified Workstages Example: !1,2", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects starting on or after this date. \n- Specific date - Date in yyyy-mm-dd format Example: 2014-01-18\n- Relative date - +/-Xd/w/m/y Examples: -3w - 3 weeks ago OR +1m - 1 month ahead", "type": "text/plain" }, "disabled": true, "key": "startdatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects starting on or before this date. \n- Specific date - Date in yyyy-mm-dd format Example: 2014-01-18\n- Relative date - +/-Xd/w/m/y Examples: -3w - 3 weeks ago OR +1m - 1 month ahead", "type": "text/plain" }, "disabled": true, "key": "startdateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects due on or after this date. \n- Specific date - Date in yyyy-mm-dd format Example: 2014-01-18\n- Relative date - +/-Xd/w/m/y Examples: -3w - 3 weeks ago OR +1m - 1 month ahead", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects due on or before this date. \n- Specific date - Date in yyyy-mm-dd format Example: 2014-01-18\n- Relative date - +/-Xd/w/m/y Examples: -3w - 3 weeks ago OR +1m - 1 month ahead", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects completed on or after this date. \n- Specific date - Date in yyyy-mm-dd format Example: 2014-01-18\n- Relative date - +/-Xd/w/m/y Examples: -3w - 3 weeks ago OR +1m - 1 month ahead", "type": "text/plain" }, "disabled": true, "key": "completedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects completed on or before this date. \n- Specific date - Date in yyyy-mm-dd format Example: 2014-01-18\n- Relative date - +/-Xd/w/m/y Examples: -3w - 3 weeks ago OR +1m - 1 month ahead", "type": "text/plain" }, "disabled": true, "key": "completedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects added/edited on or after this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects added/edited on or before this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,startdate,duedate,completedate,companyname,categoryname,priority)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "58756eda-85e5-4a05-83a8-75582426299d", "name": "/projects", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"categoryid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"notification\": \"\u003cboolean\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Updates one or more projects by ID. All fields except ids are optional — only provided fields are updated.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/projects", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "235d63ad-d955-40f1-aba1-3aa4fffb2ab1", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"categoryid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"notification\": \"\u003cboolean\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6d4ebb16-7cc4-499a-8a9e-5fff0e5f7421", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"categoryid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"notification\": \"\u003cboolean\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "cee67d63-f953-46ca-b8e3-dfb8143b8302", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"categoryid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"notification\": \"\u003cboolean\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects" ], "query": [], "variable": [] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "d1430c94-9578-496f-b719-0a0c11955c41", "name": "/projects", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"clientviewalltasks\": \"\u003cboolean\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contractorid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"customfields\": [\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"staff\",\n \"value\": \"\u003cstring\u003e\"\n },\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"rating\",\n \"value\": \"\u003cstring\u003e\"\n }\n ],\n \"customformtitle\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"icalcontactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"managementteam\": {\n \"groupid\": \"\u003cinteger\u003e\",\n \"managerid\": \"\u003cinteger\u003e\",\n \"teamid\": \"\u003cinteger\u003e\"\n },\n \"notification\": \"\u003cboolean\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"privatenotes\": \"\u003cstring\u003e\",\n \"purchaseorder\": \"\u003cstring\u003e\",\n \"staffid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"staffviewalltasks\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"template\": \"\u003cboolean\u003e\",\n \"templateused\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"worktypeid\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Creates a new external project with a company as the client. This endpoint now proxies to POST /projects/external.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/projects", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3319686e-8ddf-45c2-8f66-ce134e684678", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"clientviewalltasks\": \"\u003cboolean\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contractorid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"customfields\": [\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"staff\",\n \"value\": \"\u003cstring\u003e\"\n },\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"rating\",\n \"value\": \"\u003cstring\u003e\"\n }\n ],\n \"customformtitle\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"icalcontactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"managementteam\": {\n \"groupid\": \"\u003cinteger\u003e\",\n \"managerid\": \"\u003cinteger\u003e\",\n \"teamid\": \"\u003cinteger\u003e\"\n },\n \"notification\": \"\u003cboolean\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"privatenotes\": \"\u003cstring\u003e\",\n \"purchaseorder\": \"\u003cstring\u003e\",\n \"staffid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"staffviewalltasks\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"template\": \"\u003cboolean\u003e\",\n \"templateused\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"worktypeid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects" ], "query": [], "variable": [] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "eb78c97b-a0d0-476e-960f-fc2ce44cff8f", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"clientviewalltasks\": \"\u003cboolean\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contractorid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"customfields\": [\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"staff\",\n \"value\": \"\u003cstring\u003e\"\n },\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"rating\",\n \"value\": \"\u003cstring\u003e\"\n }\n ],\n \"customformtitle\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"icalcontactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"managementteam\": {\n \"groupid\": \"\u003cinteger\u003e\",\n \"managerid\": \"\u003cinteger\u003e\",\n \"teamid\": \"\u003cinteger\u003e\"\n },\n \"notification\": \"\u003cboolean\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"privatenotes\": \"\u003cstring\u003e\",\n \"purchaseorder\": \"\u003cstring\u003e\",\n \"staffid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"staffviewalltasks\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"template\": \"\u003cboolean\u003e\",\n \"templateused\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"worktypeid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "049bb469-6aab-42a5-81f3-234056bfd3fe", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"clientviewalltasks\": \"\u003cboolean\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contractorid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"customfields\": [\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"staff\",\n \"value\": \"\u003cstring\u003e\"\n },\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"rating\",\n \"value\": \"\u003cstring\u003e\"\n }\n ],\n \"customformtitle\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"icalcontactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"managementteam\": {\n \"groupid\": \"\u003cinteger\u003e\",\n \"managerid\": \"\u003cinteger\u003e\",\n \"teamid\": \"\u003cinteger\u003e\"\n },\n \"notification\": \"\u003cboolean\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"privatenotes\": \"\u003cstring\u003e\",\n \"purchaseorder\": \"\u003cstring\u003e\",\n \"staffid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"staffviewalltasks\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"template\": \"\u003cboolean\u003e\",\n \"templateused\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"worktypeid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7b3b5968-7de5-43f2-8075-6530cea33124", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"clientviewalltasks\": \"\u003cboolean\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contractorid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"customfields\": [\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"staff\",\n \"value\": \"\u003cstring\u003e\"\n },\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"rating\",\n \"value\": \"\u003cstring\u003e\"\n }\n ],\n \"customformtitle\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"icalcontactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"managementteam\": {\n \"groupid\": \"\u003cinteger\u003e\",\n \"managerid\": \"\u003cinteger\u003e\",\n \"teamid\": \"\u003cinteger\u003e\"\n },\n \"notification\": \"\u003cboolean\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"privatenotes\": \"\u003cstring\u003e\",\n \"purchaseorder\": \"\u003cstring\u003e\",\n \"staffid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"staffviewalltasks\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"template\": \"\u003cboolean\u003e\",\n \"templateused\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"worktypeid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "62005bb7-4c8a-487b-bcc7-a36e82ab7c10", "name": "/projects", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Soft deletes one or more projects by ID.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/projects", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "828d14db-c60b-4e04-8560-a8e0609bde15", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c965efca-432a-4df0-a4e2-7054ed7a9c88", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4703d426-f922-429b-8329-fb32cbfc6099", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects" ], "query": [], "variable": [] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "f1c6b9ad-e51e-4a01-92ba-c881312cdedd", "name": "/projects/adjustdates", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"shiftchilddates\": \"\u003cinteger\u003e\",\n \"shiftdates\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Shifts start and due dates on one or more projects by a number of days. Negative values shift backwards. Optionally shifts child item dates too.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/projects/adjustdates", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "adjustdates" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f416620a-8643-4e37-916e-8576fe0ab5e7", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"shiftchilddates\": \"\u003cinteger\u003e\",\n \"shiftdates\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "adjustdates" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d9a4027c-f9a0-4115-939b-ba1a29e3f7fb", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"shiftchilddates\": \"\u003cinteger\u003e\",\n \"shiftdates\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "adjustdates" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "80a32989-adc7-4a42-8f94-66ea2a7362c0", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"shiftchilddates\": \"\u003cinteger\u003e\",\n \"shiftdates\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "adjustdates" ], "query": [], "variable": [] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "658d69d0-049a-44af-931e-3aa8db54f662", "name": "/projects/bookmarks", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Bookmarks across all Projects.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/projects/bookmarks", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "bookmarks" ], "query": [ { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"url\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"url\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4f19002e-d2cb-48b6-b509-8094eb06639e", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "bookmarks" ], "query": [ { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "382a35db-0677-406e-b4ad-2b0d8c791a64", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "bookmarks" ], "query": [ { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f39b0566-0412-48bf-98d3-4838174184b5", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "bookmarks" ], "query": [ { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3407e8bf-d616-4fa2-8b54-282852ef8dd0", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "bookmarks" ], "query": [ { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "ccc5cfab-a232-42f1-ab65-896e4276e9d7", "name": "/projects/contacts", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Removes one or more Contacts from one or more Projects.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/projects/contacts", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "contacts" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a948135e-564e-40e4-8eec-8ef0fdb1263d", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "contacts" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3123f794-c674-412f-9da3-5d1bf99b3edd", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "contacts" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b417630a-e937-4a20-a8f8-db3b5252e3ee", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "contacts" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "80fd462f-ca0d-4fae-9b55-db09ae1dc670", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "contacts" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "23346ecb-6e71-43d0-8430-853072732b4f", "name": "/projects/external", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"clientviewalltasks\": \"\u003cboolean\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contractorid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"customfields\": [\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"staff\",\n \"value\": \"\u003cstring\u003e\"\n },\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"rating\",\n \"value\": \"\u003cstring\u003e\"\n }\n ],\n \"customformtitle\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"icalcontactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"managementteam\": {\n \"groupid\": \"\u003cinteger\u003e\",\n \"managerid\": \"\u003cinteger\u003e\",\n \"teamid\": \"\u003cinteger\u003e\"\n },\n \"notification\": \"\u003cboolean\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"privatenotes\": \"\u003cstring\u003e\",\n \"purchaseorder\": \"\u003cstring\u003e\",\n \"staffid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"staffviewalltasks\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"template\": \"\u003cboolean\u003e\",\n \"templateused\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"worktypeid\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Creates a new external project with a company as the client.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/projects/external", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "external" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "99f423fe-046a-4b05-9b03-f2bd17c0dc0a", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"clientviewalltasks\": \"\u003cboolean\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contractorid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"customfields\": [\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"staff\",\n \"value\": \"\u003cstring\u003e\"\n },\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"rating\",\n \"value\": \"\u003cstring\u003e\"\n }\n ],\n \"customformtitle\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"icalcontactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"managementteam\": {\n \"groupid\": \"\u003cinteger\u003e\",\n \"managerid\": \"\u003cinteger\u003e\",\n \"teamid\": \"\u003cinteger\u003e\"\n },\n \"notification\": \"\u003cboolean\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"privatenotes\": \"\u003cstring\u003e\",\n \"purchaseorder\": \"\u003cstring\u003e\",\n \"staffid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"staffviewalltasks\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"template\": \"\u003cboolean\u003e\",\n \"templateused\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"worktypeid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "external" ], "query": [], "variable": [] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "edb5cb68-df91-4b4c-b50e-14b962ad60b3", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"clientviewalltasks\": \"\u003cboolean\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contractorid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"customfields\": [\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"staff\",\n \"value\": \"\u003cstring\u003e\"\n },\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"rating\",\n \"value\": \"\u003cstring\u003e\"\n }\n ],\n \"customformtitle\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"icalcontactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"managementteam\": {\n \"groupid\": \"\u003cinteger\u003e\",\n \"managerid\": \"\u003cinteger\u003e\",\n \"teamid\": \"\u003cinteger\u003e\"\n },\n \"notification\": \"\u003cboolean\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"privatenotes\": \"\u003cstring\u003e\",\n \"purchaseorder\": \"\u003cstring\u003e\",\n \"staffid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"staffviewalltasks\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"template\": \"\u003cboolean\u003e\",\n \"templateused\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"worktypeid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "external" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "daa3a82e-739a-4eff-86c6-79bcb286a4fa", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"clientviewalltasks\": \"\u003cboolean\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contractorid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"customfields\": [\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"staff\",\n \"value\": \"\u003cstring\u003e\"\n },\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"rating\",\n \"value\": \"\u003cstring\u003e\"\n }\n ],\n \"customformtitle\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"icalcontactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"managementteam\": {\n \"groupid\": \"\u003cinteger\u003e\",\n \"managerid\": \"\u003cinteger\u003e\",\n \"teamid\": \"\u003cinteger\u003e\"\n },\n \"notification\": \"\u003cboolean\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"privatenotes\": \"\u003cstring\u003e\",\n \"purchaseorder\": \"\u003cstring\u003e\",\n \"staffid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"staffviewalltasks\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"template\": \"\u003cboolean\u003e\",\n \"templateused\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"worktypeid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "external" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "cb394419-96fb-4ab4-bacb-c78168d3beed", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"clientviewalltasks\": \"\u003cboolean\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contractorid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"customfields\": [\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"staff\",\n \"value\": \"\u003cstring\u003e\"\n },\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"rating\",\n \"value\": \"\u003cstring\u003e\"\n }\n ],\n \"customformtitle\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"icalcontactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"managementteam\": {\n \"groupid\": \"\u003cinteger\u003e\",\n \"managerid\": \"\u003cinteger\u003e\",\n \"teamid\": \"\u003cinteger\u003e\"\n },\n \"notification\": \"\u003cboolean\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"privatenotes\": \"\u003cstring\u003e\",\n \"purchaseorder\": \"\u003cstring\u003e\",\n \"staffid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"staffviewalltasks\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"template\": \"\u003cboolean\u003e\",\n \"templateused\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"worktypeid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "external" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "b8147a93-4985-4d29-aa67-dc7d4a28eb60", "name": "/projects/internal", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientviewalltasks\": \"\u003cboolean\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"contractorid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"customfields\": [\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"rating\",\n \"value\": \"\u003cstring\u003e\"\n },\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"checkbox\",\n \"value\": \"\u003cstring\u003e\"\n }\n ],\n \"customformtitle\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"groupid\": \"\u003cinteger\u003e\",\n \"icalcontactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"managementteam\": {\n \"groupid\": \"\u003cinteger\u003e\",\n \"managerid\": \"\u003cinteger\u003e\",\n \"teamid\": \"\u003cinteger\u003e\"\n },\n \"notification\": \"\u003cboolean\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"privatenotes\": \"\u003cstring\u003e\",\n \"purchaseorder\": \"\u003cstring\u003e\",\n \"staffid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"staffviewalltasks\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"teamid\": \"\u003cinteger\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"templateused\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"worktypeid\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Creates a new internal project with a staff member as the client.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/projects/internal", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "internal" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "81a68a88-eb33-4918-8f2c-01745549bf73", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientviewalltasks\": \"\u003cboolean\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"contractorid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"customfields\": [\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"rating\",\n \"value\": \"\u003cstring\u003e\"\n },\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"checkbox\",\n \"value\": \"\u003cstring\u003e\"\n }\n ],\n \"customformtitle\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"groupid\": \"\u003cinteger\u003e\",\n \"icalcontactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"managementteam\": {\n \"groupid\": \"\u003cinteger\u003e\",\n \"managerid\": \"\u003cinteger\u003e\",\n \"teamid\": \"\u003cinteger\u003e\"\n },\n \"notification\": \"\u003cboolean\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"privatenotes\": \"\u003cstring\u003e\",\n \"purchaseorder\": \"\u003cstring\u003e\",\n \"staffid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"staffviewalltasks\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"teamid\": \"\u003cinteger\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"templateused\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"worktypeid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "internal" ], "query": [], "variable": [] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "81f6be28-5f6f-4186-bdb2-ef780b73cfcf", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientviewalltasks\": \"\u003cboolean\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"contractorid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"customfields\": [\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"rating\",\n \"value\": \"\u003cstring\u003e\"\n },\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"checkbox\",\n \"value\": \"\u003cstring\u003e\"\n }\n ],\n \"customformtitle\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"groupid\": \"\u003cinteger\u003e\",\n \"icalcontactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"managementteam\": {\n \"groupid\": \"\u003cinteger\u003e\",\n \"managerid\": \"\u003cinteger\u003e\",\n \"teamid\": \"\u003cinteger\u003e\"\n },\n \"notification\": \"\u003cboolean\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"privatenotes\": \"\u003cstring\u003e\",\n \"purchaseorder\": \"\u003cstring\u003e\",\n \"staffid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"staffviewalltasks\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"teamid\": \"\u003cinteger\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"templateused\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"worktypeid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "internal" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6bb1793e-8527-4b2d-9c6c-7d8ded593f68", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientviewalltasks\": \"\u003cboolean\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"contractorid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"customfields\": [\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"rating\",\n \"value\": \"\u003cstring\u003e\"\n },\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"checkbox\",\n \"value\": \"\u003cstring\u003e\"\n }\n ],\n \"customformtitle\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"groupid\": \"\u003cinteger\u003e\",\n \"icalcontactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"managementteam\": {\n \"groupid\": \"\u003cinteger\u003e\",\n \"managerid\": \"\u003cinteger\u003e\",\n \"teamid\": \"\u003cinteger\u003e\"\n },\n \"notification\": \"\u003cboolean\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"privatenotes\": \"\u003cstring\u003e\",\n \"purchaseorder\": \"\u003cstring\u003e\",\n \"staffid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"staffviewalltasks\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"teamid\": \"\u003cinteger\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"templateused\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"worktypeid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "internal" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "335de294-9f96-486a-86e4-b848297cd09b", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientviewalltasks\": \"\u003cboolean\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"contractorid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"customfields\": [\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"rating\",\n \"value\": \"\u003cstring\u003e\"\n },\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"checkbox\",\n \"value\": \"\u003cstring\u003e\"\n }\n ],\n \"customformtitle\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"groupid\": \"\u003cinteger\u003e\",\n \"icalcontactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"managementteam\": {\n \"groupid\": \"\u003cinteger\u003e\",\n \"managerid\": \"\u003cinteger\u003e\",\n \"teamid\": \"\u003cinteger\u003e\"\n },\n \"notification\": \"\u003cboolean\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"privatenotes\": \"\u003cstring\u003e\",\n \"purchaseorder\": \"\u003cstring\u003e\",\n \"staffid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"staffviewalltasks\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"teamid\": \"\u003cinteger\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"templateused\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"worktypeid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "internal" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "27586cd5-4f59-46b0-b5d8-50988129ede1", "name": "/projects/invoices", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"groupby\": \"item\",\n \"invoicedate\": \"\u003cstring\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicetermid\": \"\u003cinteger\u003e\",\n \"itemcollectionName\": \"\u003cstring\u003e\",\n \"itemid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"number\": \"\u003cstring\u003e\",\n \"timelogid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"title\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Creates an Invoice based on project items.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/projects/invoices", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "invoices" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b43d7e13-36c5-4b36-a059-fb46c3ba8f4e", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"groupby\": \"item\",\n \"invoicedate\": \"\u003cstring\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicetermid\": \"\u003cinteger\u003e\",\n \"itemcollectionName\": \"\u003cstring\u003e\",\n \"itemid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"number\": \"\u003cstring\u003e\",\n \"timelogid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "invoices" ], "query": [], "variable": [] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5905be44-3f14-48b8-b610-e55017c8cf8c", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"groupby\": \"item\",\n \"invoicedate\": \"\u003cstring\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicetermid\": \"\u003cinteger\u003e\",\n \"itemcollectionName\": \"\u003cstring\u003e\",\n \"itemid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"number\": \"\u003cstring\u003e\",\n \"timelogid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "invoices" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "0f15703e-ad4a-4014-8105-c7116824463a", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"groupby\": \"item\",\n \"invoicedate\": \"\u003cstring\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicetermid\": \"\u003cinteger\u003e\",\n \"itemcollectionName\": \"\u003cstring\u003e\",\n \"itemid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"number\": \"\u003cstring\u003e\",\n \"timelogid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "invoices" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "050d2d73-553d-4db4-8a85-2139b7d9b1ae", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"groupby\": \"item\",\n \"invoicedate\": \"\u003cstring\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicetermid\": \"\u003cinteger\u003e\",\n \"itemcollectionName\": \"\u003cstring\u003e\",\n \"itemid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"number\": \"\u003cstring\u003e\",\n \"timelogid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "invoices" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "23e5fb3a-a9b1-4d66-b1a3-d9ebdbbf5f73", "name": "/projects/items", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of all project Items across all projects, based on the filters specified. The fields parameter allows you to choose which data fields to return for each Item.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/projects/items", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- name\n- code\n- number\n- description\n- status\n- priority\n- percentcomplete\n- position\n- project\n- company\n- dates\n- time\n- billable\n- workstageid\n- parentid\n- phasename\n- categoryid\n- itemcollectionid\n- itemtypeid\n- createdon\n- contacts\n- tags\n- lastmodified\n- hourlyrateserviceid\n- productid\n- timebillable\n- creatorid\n- uniquetoken\n- deleted\n- prerequisiteid\n- dependenttaskid\n- contactid\n- tagid\n- quoteitemid\n- invoiceitemid\n- trackingoptionid\n- scoring\n- discount\n- units\n- tax\n- estimated\n- actual\n- projected\n- profit\n- budget\n- billing\n- invoiced\n- all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,status,priority" }, { "description": { "content": "Deprecated: use name, code, or q+qfields instead. Search by name or code. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by description. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchdescription", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use code or q+qfields instead. Search by code. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact code match", "type": "text/plain" }, "disabled": true, "key": "code", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,code,description)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "code" }, { "description": { "content": "Status filter (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "active" }, { "description": { "content": "Alias for status parameter. (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "deleted" }, { "description": { "content": "Priority filter (comma-separated: 1=Very High … 5=Very Low)", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Contact IDs assigned to item, 'me', or 'unassigned' for items with no contacts", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Mode for contacts filter (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Work Stage ID", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Start date from (yyyy-mm-dd)", "type": "text/plain" }, "disabled": true, "key": "startdatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Start date to (yyyy-mm-dd)", "type": "text/plain" }, "disabled": true, "key": "startdateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (yyyy-mm-dd)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date to (yyyy-mm-dd)", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Last modified UTC from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified UTC to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Items with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cinteger\u003e" }, { "description": { "content": "Items with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cinteger\u003e" }, { "description": { "content": "List of Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,code,priority,startdate,duedate,completedate,status,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"actualInLabour\": \"\u003cnumber\u003e\",\n \"actualInTotal\": \"\u003cnumber\u003e\",\n \"actualInTotalTax\": \"\u003cnumber\u003e\",\n \"actualOutLabour\": \"\u003cnumber\u003e\",\n \"actualProfit\": \"\u003cnumber\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"contacts\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cstring\u003e\",\n \"createdatetime\": \"\u003cstring\u003e\",\n \"creatorid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"dependenttaskid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"discountRate\": \"\u003cnumber\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScoreId\": \"\u003cinteger\u003e\",\n \"estBillAmount\": \"\u003cnumber\u003e\",\n \"estBillAmountTax\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"impactScoreId\": \"\u003cinteger\u003e\",\n \"importanceScoreId\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inTaxRate\": \"\u003cnumber\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoicedAmount\": \"\u003cnumber\u003e\",\n \"invoicedAmountTax\": \"\u003cnumber\u003e\",\n \"invoiceitemid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"isDiscountPercent\": \"\u003cboolean\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"manualPercentageComplete\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"number\": \"\u003cinteger\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outTaxRate\": \"\u003cnumber\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"paidAmount\": \"\u003cnumber\u003e\",\n \"paidAmountTax\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"phasename\": \"\u003cstring\u003e\",\n \"prerequisiteid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedBillAmount\": \"\u003cnumber\u003e\",\n \"projectedBillAmountTax\": \"\u003cnumber\u003e\",\n \"projectedGrossMargin\": \"\u003cnumber\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"projectedOutLabour\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"projectedTimeManual\": \"\u003cnumber\u003e\",\n \"projectedTimeSpent\": \"\u003cnumber\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"quoteitemid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cinteger\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tags\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"uniquetoken\": \"\u003cstring\u003e\",\n \"urgencyScoreId\": \"\u003cinteger\u003e\"\n },\n {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"actualInLabour\": \"\u003cnumber\u003e\",\n \"actualInTotal\": \"\u003cnumber\u003e\",\n \"actualInTotalTax\": \"\u003cnumber\u003e\",\n \"actualOutLabour\": \"\u003cnumber\u003e\",\n \"actualProfit\": \"\u003cnumber\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"contacts\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cstring\u003e\",\n \"createdatetime\": \"\u003cstring\u003e\",\n \"creatorid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"dependenttaskid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"discountRate\": \"\u003cnumber\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScoreId\": \"\u003cinteger\u003e\",\n \"estBillAmount\": \"\u003cnumber\u003e\",\n \"estBillAmountTax\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"impactScoreId\": \"\u003cinteger\u003e\",\n \"importanceScoreId\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inTaxRate\": \"\u003cnumber\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoicedAmount\": \"\u003cnumber\u003e\",\n \"invoicedAmountTax\": \"\u003cnumber\u003e\",\n \"invoiceitemid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"isDiscountPercent\": \"\u003cboolean\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"manualPercentageComplete\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"number\": \"\u003cinteger\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outTaxRate\": \"\u003cnumber\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"paidAmount\": \"\u003cnumber\u003e\",\n \"paidAmountTax\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"phasename\": \"\u003cstring\u003e\",\n \"prerequisiteid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedBillAmount\": \"\u003cnumber\u003e\",\n \"projectedBillAmountTax\": \"\u003cnumber\u003e\",\n \"projectedGrossMargin\": \"\u003cnumber\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"projectedOutLabour\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"projectedTimeManual\": \"\u003cnumber\u003e\",\n \"projectedTimeSpent\": \"\u003cnumber\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"quoteitemid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cinteger\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tags\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"uniquetoken\": \"\u003cstring\u003e\",\n \"urgencyScoreId\": \"\u003cinteger\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "766bf4df-53fa-4961-bba5-1197d4643350", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- name\n- code\n- number\n- description\n- status\n- priority\n- percentcomplete\n- position\n- project\n- company\n- dates\n- time\n- billable\n- workstageid\n- parentid\n- phasename\n- categoryid\n- itemcollectionid\n- itemtypeid\n- createdon\n- contacts\n- tags\n- lastmodified\n- hourlyrateserviceid\n- productid\n- timebillable\n- creatorid\n- uniquetoken\n- deleted\n- prerequisiteid\n- dependenttaskid\n- contactid\n- tagid\n- quoteitemid\n- invoiceitemid\n- trackingoptionid\n- scoring\n- discount\n- units\n- tax\n- estimated\n- actual\n- projected\n- profit\n- budget\n- billing\n- invoiced\n- all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,status,priority" }, { "description": { "content": "Deprecated: use name, code, or q+qfields instead. Search by name or code. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by description. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchdescription", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use code or q+qfields instead. Search by code. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact code match", "type": "text/plain" }, "disabled": true, "key": "code", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,code,description)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "code" }, { "description": { "content": "Status filter (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "active" }, { "description": { "content": "Alias for status parameter. (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "deleted" }, { "description": { "content": "Priority filter (comma-separated: 1=Very High … 5=Very Low)", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Contact IDs assigned to item, 'me', or 'unassigned' for items with no contacts", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Mode for contacts filter (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Work Stage ID", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Start date from (yyyy-mm-dd)", "type": "text/plain" }, "disabled": true, "key": "startdatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Start date to (yyyy-mm-dd)", "type": "text/plain" }, "disabled": true, "key": "startdateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (yyyy-mm-dd)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date to (yyyy-mm-dd)", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Last modified UTC from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified UTC to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Items with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cinteger\u003e" }, { "description": { "content": "Items with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cinteger\u003e" }, { "description": { "content": "List of Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,code,priority,startdate,duedate,completedate,status,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "40a4aa5a-3933-4416-961f-5ec6ee32d72f", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- name\n- code\n- number\n- description\n- status\n- priority\n- percentcomplete\n- position\n- project\n- company\n- dates\n- time\n- billable\n- workstageid\n- parentid\n- phasename\n- categoryid\n- itemcollectionid\n- itemtypeid\n- createdon\n- contacts\n- tags\n- lastmodified\n- hourlyrateserviceid\n- productid\n- timebillable\n- creatorid\n- uniquetoken\n- deleted\n- prerequisiteid\n- dependenttaskid\n- contactid\n- tagid\n- quoteitemid\n- invoiceitemid\n- trackingoptionid\n- scoring\n- discount\n- units\n- tax\n- estimated\n- actual\n- projected\n- profit\n- budget\n- billing\n- invoiced\n- all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,status,priority" }, { "description": { "content": "Deprecated: use name, code, or q+qfields instead. Search by name or code. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by description. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchdescription", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use code or q+qfields instead. Search by code. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact code match", "type": "text/plain" }, "disabled": true, "key": "code", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,code,description)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "code" }, { "description": { "content": "Status filter (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "active" }, { "description": { "content": "Alias for status parameter. (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "deleted" }, { "description": { "content": "Priority filter (comma-separated: 1=Very High … 5=Very Low)", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Contact IDs assigned to item, 'me', or 'unassigned' for items with no contacts", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Mode for contacts filter (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Work Stage ID", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Start date from (yyyy-mm-dd)", "type": "text/plain" }, "disabled": true, "key": "startdatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Start date to (yyyy-mm-dd)", "type": "text/plain" }, "disabled": true, "key": "startdateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (yyyy-mm-dd)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date to (yyyy-mm-dd)", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Last modified UTC from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified UTC to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Items with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cinteger\u003e" }, { "description": { "content": "Items with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cinteger\u003e" }, { "description": { "content": "List of Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,code,priority,startdate,duedate,completedate,status,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9b43ae25-f23f-4a24-92bc-44efdc552961", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- name\n- code\n- number\n- description\n- status\n- priority\n- percentcomplete\n- position\n- project\n- company\n- dates\n- time\n- billable\n- workstageid\n- parentid\n- phasename\n- categoryid\n- itemcollectionid\n- itemtypeid\n- createdon\n- contacts\n- tags\n- lastmodified\n- hourlyrateserviceid\n- productid\n- timebillable\n- creatorid\n- uniquetoken\n- deleted\n- prerequisiteid\n- dependenttaskid\n- contactid\n- tagid\n- quoteitemid\n- invoiceitemid\n- trackingoptionid\n- scoring\n- discount\n- units\n- tax\n- estimated\n- actual\n- projected\n- profit\n- budget\n- billing\n- invoiced\n- all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,status,priority" }, { "description": { "content": "Deprecated: use name, code, or q+qfields instead. Search by name or code. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by description. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchdescription", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use code or q+qfields instead. Search by code. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact code match", "type": "text/plain" }, "disabled": true, "key": "code", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,code,description)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "code" }, { "description": { "content": "Status filter (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "active" }, { "description": { "content": "Alias for status parameter. (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "deleted" }, { "description": { "content": "Priority filter (comma-separated: 1=Very High … 5=Very Low)", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Contact IDs assigned to item, 'me', or 'unassigned' for items with no contacts", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Mode for contacts filter (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Work Stage ID", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Start date from (yyyy-mm-dd)", "type": "text/plain" }, "disabled": true, "key": "startdatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Start date to (yyyy-mm-dd)", "type": "text/plain" }, "disabled": true, "key": "startdateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (yyyy-mm-dd)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date to (yyyy-mm-dd)", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Last modified UTC from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified UTC to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Items with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cinteger\u003e" }, { "description": { "content": "Items with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cinteger\u003e" }, { "description": { "content": "List of Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,code,priority,startdate,duedate,completedate,status,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6da14892-a389-4743-b0a3-02fd80828302", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- name\n- code\n- number\n- description\n- status\n- priority\n- percentcomplete\n- position\n- project\n- company\n- dates\n- time\n- billable\n- workstageid\n- parentid\n- phasename\n- categoryid\n- itemcollectionid\n- itemtypeid\n- createdon\n- contacts\n- tags\n- lastmodified\n- hourlyrateserviceid\n- productid\n- timebillable\n- creatorid\n- uniquetoken\n- deleted\n- prerequisiteid\n- dependenttaskid\n- contactid\n- tagid\n- quoteitemid\n- invoiceitemid\n- trackingoptionid\n- scoring\n- discount\n- units\n- tax\n- estimated\n- actual\n- projected\n- profit\n- budget\n- billing\n- invoiced\n- all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,status,priority" }, { "description": { "content": "Deprecated: use name, code, or q+qfields instead. Search by name or code. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by description. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchdescription", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use code or q+qfields instead. Search by code. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact code match", "type": "text/plain" }, "disabled": true, "key": "code", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,code,description)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "code" }, { "description": { "content": "Status filter (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "active" }, { "description": { "content": "Alias for status parameter. (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "deleted" }, { "description": { "content": "Priority filter (comma-separated: 1=Very High … 5=Very Low)", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Contact IDs assigned to item, 'me', or 'unassigned' for items with no contacts", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Mode for contacts filter (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Work Stage ID", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Start date from (yyyy-mm-dd)", "type": "text/plain" }, "disabled": true, "key": "startdatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Start date to (yyyy-mm-dd)", "type": "text/plain" }, "disabled": true, "key": "startdateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (yyyy-mm-dd)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date to (yyyy-mm-dd)", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Last modified UTC from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Last modified UTC to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Items with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cinteger\u003e" }, { "description": { "content": "Items with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cinteger\u003e" }, { "description": { "content": "List of Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,code,priority,startdate,duedate,completedate,status,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "c27a8ed1-765c-4bf1-ba1e-f6ea33ab02c6", "name": "/projects/items", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billType\": \"\u003cinteger\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"discount\": {\n \"amount\": \"\u003cnumber\u003e\",\n \"percent\": \"\u003cnumber\u003e\"\n },\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScore\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"impactScore\": \"\u003cinteger\u003e\",\n \"importanceScore\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"manualPercentageComplete\": \"\u003cnumber\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedTimeManual\": \"\u003cinteger\u003e\",\n \"projectedTimeSpent\": \"\u003cinteger\u003e\",\n \"shiftDates\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cinteger\u003e\",\n \"urgencyScore\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Updates one or more project items by ID. All fields except ids are optional — only provided fields are updated.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/projects/items", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2415b6d6-b72e-4016-b482-0bbb552d0a2f", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billType\": \"\u003cinteger\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"discount\": {\n \"amount\": \"\u003cnumber\u003e\",\n \"percent\": \"\u003cnumber\u003e\"\n },\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScore\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"impactScore\": \"\u003cinteger\u003e\",\n \"importanceScore\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"manualPercentageComplete\": \"\u003cnumber\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedTimeManual\": \"\u003cinteger\u003e\",\n \"projectedTimeSpent\": \"\u003cinteger\u003e\",\n \"shiftDates\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cinteger\u003e\",\n \"urgencyScore\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3f812bf7-041f-4e6a-b301-56f68d040a66", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billType\": \"\u003cinteger\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"discount\": {\n \"amount\": \"\u003cnumber\u003e\",\n \"percent\": \"\u003cnumber\u003e\"\n },\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScore\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"impactScore\": \"\u003cinteger\u003e\",\n \"importanceScore\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"manualPercentageComplete\": \"\u003cnumber\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedTimeManual\": \"\u003cinteger\u003e\",\n \"projectedTimeSpent\": \"\u003cinteger\u003e\",\n \"shiftDates\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cinteger\u003e\",\n \"urgencyScore\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f6266753-7a63-4882-97f7-e39ea4da9518", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billType\": \"\u003cinteger\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"discount\": {\n \"amount\": \"\u003cnumber\u003e\",\n \"percent\": \"\u003cnumber\u003e\"\n },\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScore\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"impactScore\": \"\u003cinteger\u003e\",\n \"importanceScore\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"manualPercentageComplete\": \"\u003cnumber\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedTimeManual\": \"\u003cinteger\u003e\",\n \"projectedTimeSpent\": \"\u003cinteger\u003e\",\n \"shiftDates\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cinteger\u003e\",\n \"urgencyScore\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items" ], "query": [], "variable": [] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "d2213423-8fb4-437a-a3d9-7fad8be3d104", "name": "/projects/items", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billType\": \"\u003cinteger\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": \"\u003cstring\u003e\",\n \"costRateType\": \"\u003cinteger\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScore\": \"\u003cstring\u003e\",\n \"effortScoreId\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"impactScore\": \"\u003cstring\u003e\",\n \"impactScoreId\": \"\u003cinteger\u003e\",\n \"importanceScore\": \"\u003cstring\u003e\",\n \"importanceScoreId\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"value\": \"\u003cCircular reference to #/components/schemas/handlers.CreateItemPayload detected\u003e\"\n },\n {\n \"value\": \"\u003cCircular reference to #/components/schemas/handlers.CreateItemPayload detected\u003e\"\n }\n ],\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"manualPercentageComplete\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"prerequisiteid\": \"\u003cstring\u003e\",\n \"priority\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedTimeManual\": \"\u003cinteger\u003e\",\n \"projectedTimeSpent\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"status\": \"active\",\n \"storyPoints\": \"\u003cinteger\u003e\",\n \"tagid\": \"\u003cstring\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\",\n \"urgencyScore\": \"\u003cstring\u003e\",\n \"urgencyScoreId\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Create an Item (assigns to a project via projectid in the request body).", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/projects/items", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "1a84e55a-7ca6-4d9e-97ac-f73fdaf2dbfc", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billType\": \"\u003cinteger\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": \"\u003cstring\u003e\",\n \"costRateType\": \"\u003cinteger\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScore\": \"\u003cstring\u003e\",\n \"effortScoreId\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"impactScore\": \"\u003cstring\u003e\",\n \"impactScoreId\": \"\u003cinteger\u003e\",\n \"importanceScore\": \"\u003cstring\u003e\",\n \"importanceScoreId\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"value\": \"\u003cCircular reference to #/components/schemas/handlers.CreateItemPayload detected\u003e\"\n },\n {\n \"value\": \"\u003cCircular reference to #/components/schemas/handlers.CreateItemPayload detected\u003e\"\n }\n ],\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"manualPercentageComplete\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"prerequisiteid\": \"\u003cstring\u003e\",\n \"priority\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedTimeManual\": \"\u003cinteger\u003e\",\n \"projectedTimeSpent\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"status\": \"active\",\n \"storyPoints\": \"\u003cinteger\u003e\",\n \"tagid\": \"\u003cstring\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\",\n \"urgencyScore\": \"\u003cstring\u003e\",\n \"urgencyScoreId\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items" ], "query": [], "variable": [] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "913cdc09-f05d-4999-8275-8ce5d2bdac3e", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billType\": \"\u003cinteger\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": \"\u003cstring\u003e\",\n \"costRateType\": \"\u003cinteger\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScore\": \"\u003cstring\u003e\",\n \"effortScoreId\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"impactScore\": \"\u003cstring\u003e\",\n \"impactScoreId\": \"\u003cinteger\u003e\",\n \"importanceScore\": \"\u003cstring\u003e\",\n \"importanceScoreId\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"value\": \"\u003cCircular reference to #/components/schemas/handlers.CreateItemPayload detected\u003e\"\n },\n {\n \"value\": \"\u003cCircular reference to #/components/schemas/handlers.CreateItemPayload detected\u003e\"\n }\n ],\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"manualPercentageComplete\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"prerequisiteid\": \"\u003cstring\u003e\",\n \"priority\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedTimeManual\": \"\u003cinteger\u003e\",\n \"projectedTimeSpent\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"status\": \"active\",\n \"storyPoints\": \"\u003cinteger\u003e\",\n \"tagid\": \"\u003cstring\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\",\n \"urgencyScore\": \"\u003cstring\u003e\",\n \"urgencyScoreId\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "642b72c8-7772-4000-9275-bd0467c7f499", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billType\": \"\u003cinteger\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": \"\u003cstring\u003e\",\n \"costRateType\": \"\u003cinteger\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScore\": \"\u003cstring\u003e\",\n \"effortScoreId\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"impactScore\": \"\u003cstring\u003e\",\n \"impactScoreId\": \"\u003cinteger\u003e\",\n \"importanceScore\": \"\u003cstring\u003e\",\n \"importanceScoreId\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"value\": \"\u003cCircular reference to #/components/schemas/handlers.CreateItemPayload detected\u003e\"\n },\n {\n \"value\": \"\u003cCircular reference to #/components/schemas/handlers.CreateItemPayload detected\u003e\"\n }\n ],\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"manualPercentageComplete\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"prerequisiteid\": \"\u003cstring\u003e\",\n \"priority\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedTimeManual\": \"\u003cinteger\u003e\",\n \"projectedTimeSpent\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"status\": \"active\",\n \"storyPoints\": \"\u003cinteger\u003e\",\n \"tagid\": \"\u003cstring\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\",\n \"urgencyScore\": \"\u003cstring\u003e\",\n \"urgencyScoreId\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "0fb56950-7a14-4f71-978e-4d0624ce6b70", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billType\": \"\u003cinteger\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": \"\u003cstring\u003e\",\n \"costRateType\": \"\u003cinteger\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScore\": \"\u003cstring\u003e\",\n \"effortScoreId\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"impactScore\": \"\u003cstring\u003e\",\n \"impactScoreId\": \"\u003cinteger\u003e\",\n \"importanceScore\": \"\u003cstring\u003e\",\n \"importanceScoreId\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"value\": \"\u003cCircular reference to #/components/schemas/handlers.CreateItemPayload detected\u003e\"\n },\n {\n \"value\": \"\u003cCircular reference to #/components/schemas/handlers.CreateItemPayload detected\u003e\"\n }\n ],\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"manualPercentageComplete\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"prerequisiteid\": \"\u003cstring\u003e\",\n \"priority\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedTimeManual\": \"\u003cinteger\u003e\",\n \"projectedTimeSpent\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"status\": \"active\",\n \"storyPoints\": \"\u003cinteger\u003e\",\n \"tagid\": \"\u003cstring\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\",\n \"urgencyScore\": \"\u003cstring\u003e\",\n \"urgencyScoreId\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "ecc4262c-601f-4e45-9929-47e9cfb7b8ec", "name": "/projects/items/clone", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"intoCollectionId\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Clones one or more project items (tasks) into a target phase (item collection).", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/projects/items/clone", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "clone" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "57597c5a-847b-4cf1-9950-85e1031d6f2d", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"intoCollectionId\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "clone" ], "query": [], "variable": [] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5fb6b1ad-87d9-4a8f-93d7-6c7632fe2be6", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"intoCollectionId\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "clone" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "258e42e3-c416-416e-9e93-2fcec0a3e6f1", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"intoCollectionId\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "clone" ], "query": [], "variable": [] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "ae2520ad-f70b-448d-a858-f5f9bda34a87", "name": "/projects/items/complete", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Marks one or more project items as complete.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/projects/items/complete", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "complete" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4d13cf31-1b12-4f5e-8d63-fffbfa6e469a", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "complete" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9c69d4f0-e0cc-4331-91f8-936d59e49dd7", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "complete" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "1f07620f-c760-48bf-86f1-e6793034406c", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "complete" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "de1f83ef-6b85-46ae-9604-ebf972dc4ce6", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "complete" ], "query": [], "variable": [] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "183c597a-4889-4ff6-94da-bc3a47d5e33a", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "complete" ], "query": [], "variable": [] } }, "status": "Not Found" } ] }, { "event": [], "id": "1130a377-d682-49f3-9686-d92458a22a4e", "name": "/projects/items/contacts", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Adds one or more Contacts to one or more Items (Tasks).", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/projects/items/contacts", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "contacts" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d00da4b6-4061-4449-b535-1ebbb6558a5a", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "contacts" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7f6214c8-ce88-4471-a4aa-b97514c08943", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "contacts" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "bb068a2b-05de-4102-aacc-3a48d187072c", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "contacts" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "07625cf1-074c-4fbe-8eae-0d34cadbddad", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "contacts" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "98fef39e-6eae-4dcd-9f87-f1aa504b4710", "name": "/projects/items/contacts", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Removes one or more Contacts from one or more Items (Tasks).", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/projects/items/contacts", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "contacts" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "953610af-b1de-4142-aef5-2fc13738fb5b", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "contacts" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "66984484-01f6-4c34-9439-a04e07349fb1", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "contacts" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8b8128fc-120d-46d7-81d7-0c4d46190cd1", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "contacts" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d12b0929-3f13-4a25-b2bc-b1f185c4f363", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "contacts" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "bd2215fa-0d44-4a29-8091-de945b6e595b", "name": "/projects/items/contacts/all", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Removes all Contacts from one or more Items (Tasks).", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/projects/items/contacts/all", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "contacts", "all" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "602ce698-22f5-4371-93e1-5f87fa514532", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "contacts", "all" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e65c1288-f933-495e-9f57-eabb21b5f312", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "contacts", "all" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "86dd4634-add9-4982-836f-eabfc9860ae2", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "contacts", "all" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "eea54568-e07d-48a4-bc3d-ff34263f07dc", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "contacts", "all" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "a24af70c-8140-498f-80f0-e67f4fb67c4e", "name": "/projects/items/move", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"itemcollectionid\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Moves one or more project items (tasks) to a different phase (item collection).", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/projects/items/move", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "move" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "dd188ca2-5bb3-4d06-8e05-dfad45ad1d94", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"itemcollectionid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "move" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d33887c6-8b69-4b32-b5fa-0892967530f2", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"itemcollectionid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "move" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5283b266-4114-4480-839c-f4849d93ea26", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"itemcollectionid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "move" ], "query": [], "variable": [] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "72b8697c-5d78-4d18-a0b3-9c73dd46d481", "name": "/projects/items/prerequisites", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"prerequisiteid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Adds one or more prerequisite Items to one or more Items (Tasks).", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/projects/items/prerequisites", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "prerequisites" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c634ecbc-2ebd-4a98-9ba7-515eeb9c8a68", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"prerequisiteid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "prerequisites" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "167f459a-6b21-46ef-b6a9-c63bef142303", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"prerequisiteid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "prerequisites" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6e08ad3c-8d37-4ce9-be32-f910c8b195da", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"prerequisiteid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "prerequisites" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "40e90204-93f5-4695-ade2-80c9d6b1a4cb", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"prerequisiteid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "prerequisites" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "ed9dc0e2-c62d-4dd8-86e2-b8a25e7db9f5", "name": "/projects/items/prerequisites", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"prerequisiteid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Removes one or more prerequisite Items from one or more Items (Tasks).", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/projects/items/prerequisites", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "prerequisites" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "53317e02-131c-4622-84e1-efa7d8922a04", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"prerequisiteid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "prerequisites" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "dc91dc61-7570-445e-badf-65d1906c0f0d", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"prerequisiteid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "prerequisites" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e6f90fae-f7e8-419e-bc12-47829c4c4a50", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"prerequisiteid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "prerequisites" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a0dfce9a-43c4-461c-90d5-60079d296155", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"prerequisiteid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "prerequisites" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "ee0e393b-0df1-4bc1-a7d8-0c9d2cd92784", "name": "/projects/items/tags", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Adds one or more Tags to one or more Items (Tasks).", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/projects/items/tags", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "tags" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f092fe70-6a48-44a3-8b85-4efdcb2c3f72", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "tags" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "bd3f7d2c-3063-4350-950f-31ca546e5b9d", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "tags" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "1cdd8c23-4f9d-45e9-bdc1-c40070d48d12", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "tags" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b361d92e-0389-4b5f-8206-5ff09aea6254", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "tags" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "ea1787bb-8f2c-4c82-b774-f008d582ae43", "name": "/projects/items/tags", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Removes one or more Tags from one or more Items (Tasks).", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/projects/items/tags", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "tags" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "cd8ea49a-4eae-4d38-b61d-fa475d99831e", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "tags" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ca8c6d77-4bb5-40cc-80f6-43b8d1aba355", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "tags" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f25ce734-4cfe-4d77-bc6f-e483af20691a", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "tags" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "518884bc-551b-4437-85b5-9f66fa636788", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "tags" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "14dcf468-8613-42a3-a34c-b14802c87c75", "name": "/projects/items/tags/all", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Removes all Tags from one or more Items (Tasks).", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/projects/items/tags/all", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "tags", "all" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4140f24c-1e78-44b1-91cb-e1ae166da8ab", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "tags", "all" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5be1d72d-d4f2-48b4-b713-392650a2459d", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "tags", "all" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9da05476-8dac-454f-af8f-0365296f6b4d", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "tags", "all" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d4c8b0af-5b05-4ff4-ab8a-c1e91f443a49", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "tags", "all" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "b022e676-ae23-4fea-adba-2217b0ef7c82", "name": "/projects/items/tracking", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Adds accounting integration tracking options to one or more Items (Tasks).", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/projects/items/tracking", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "tracking" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "45303536-7001-4c2c-97db-b1a54e0659b8", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "tracking" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "289a4760-f05c-4ee0-8485-0b9a3e7e3932", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "tracking" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "47429d93-3e91-48c9-9e79-889ff5d1dd9c", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "tracking" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ec074a83-b57d-43a4-8865-085c05d75772", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "tracking" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "fa5e2816-53aa-4e51-afdc-ea9a86de8e08", "name": "/projects/items/tracking", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Removes accounting integration tracking options from one or more Items (Tasks).", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/projects/items/tracking", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "tracking" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "794b299f-2eac-4cbb-af27-7b2e122b56ac", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "tracking" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "fe090b23-b640-4a8b-b1e0-4b0a52eea4ba", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "tracking" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "69a6080b-f6a3-4197-b97f-65f31ac4ecd4", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "tracking" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2f6056df-3fb0-42d7-a83d-c9c14e1eaa37", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "tracking" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "43c1f2ba-7e00-4b93-bdbf-81ba917496f3", "name": "/projects/items/workstage", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Sets the active work stage for multiple project items.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/projects/items/workstage", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "workstage" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f6b14d2b-368e-4290-84f5-604f234fef3c", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "workstage" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "97316145-4c8d-40f4-8bf6-bba23791190d", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "workstage" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "81749967-eebc-4543-87ee-0619b6a1b642", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", "workstage" ], "query": [], "variable": [] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "8cf8cde8-1e84-48dd-be8b-60e5396ee80c", "name": "/projects/items/:itemid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns full details of a single project item by ID.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/projects/items/:itemid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"actualInLabour\": \"\u003cnumber\u003e\",\n \"actualInTotal\": \"\u003cnumber\u003e\",\n \"actualInTotalTax\": \"\u003cnumber\u003e\",\n \"actualOutLabour\": \"\u003cnumber\u003e\",\n \"actualProfit\": \"\u003cnumber\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"contacts\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cstring\u003e\",\n \"createdatetime\": \"\u003cstring\u003e\",\n \"creatorid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"dependenttaskid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"discountRate\": \"\u003cnumber\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScoreId\": \"\u003cinteger\u003e\",\n \"estBillAmount\": \"\u003cnumber\u003e\",\n \"estBillAmountTax\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"impactScoreId\": \"\u003cinteger\u003e\",\n \"importanceScoreId\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inTaxRate\": \"\u003cnumber\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoicedAmount\": \"\u003cnumber\u003e\",\n \"invoicedAmountTax\": \"\u003cnumber\u003e\",\n \"invoiceitemid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"isDiscountPercent\": \"\u003cboolean\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"manualPercentageComplete\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"number\": \"\u003cinteger\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outTaxRate\": \"\u003cnumber\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"paidAmount\": \"\u003cnumber\u003e\",\n \"paidAmountTax\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"phasename\": \"\u003cstring\u003e\",\n \"prerequisiteid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedBillAmount\": \"\u003cnumber\u003e\",\n \"projectedBillAmountTax\": \"\u003cnumber\u003e\",\n \"projectedGrossMargin\": \"\u003cnumber\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"projectedOutLabour\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"projectedTimeManual\": \"\u003cnumber\u003e\",\n \"projectedTimeSpent\": \"\u003cnumber\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"quoteitemid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cinteger\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tags\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"uniquetoken\": \"\u003cstring\u003e\",\n \"urgencyScoreId\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "17cb8168-5a1b-4f84-b5ca-3b11c28d140d", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "486ce2e8-013f-4a99-8846-d308fcc4d1aa", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "579c0269-e69b-4f8c-bfbb-11ecebeace52", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2463d50b-17d3-4198-9ce4-05ff8c23fb3e", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a7485c0a-3655-45bb-aaca-fcc20ebda04f", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "c2909955-76f2-4e14-81a3-f776783a275b", "name": "/projects/items/:itemid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billType\": \"\u003cinteger\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScore\": \"\u003cstring\u003e\",\n \"effortScoreId\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"impactScore\": \"\u003cstring\u003e\",\n \"impactScoreId\": \"\u003cinteger\u003e\",\n \"importanceScore\": \"\u003cstring\u003e\",\n \"importanceScoreId\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"manualPercentageComplete\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"prerequisiteid\": \"\u003cstring\u003e\",\n \"priority\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedTimeManual\": \"\u003cinteger\u003e\",\n \"projectedTimeSpent\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"status\": \"complete\",\n \"storyPoints\": \"\u003cinteger\u003e\",\n \"tagid\": \"\u003cstring\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\",\n \"urgencyScore\": \"\u003cstring\u003e\",\n \"urgencyScoreId\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Update an existing Item. Only provide the fields you want to update.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/projects/items/:itemid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "54a904da-6b84-4fce-82f9-84f02a78bd27", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billType\": \"\u003cinteger\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScore\": \"\u003cstring\u003e\",\n \"effortScoreId\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"impactScore\": \"\u003cstring\u003e\",\n \"impactScoreId\": \"\u003cinteger\u003e\",\n \"importanceScore\": \"\u003cstring\u003e\",\n \"importanceScoreId\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"manualPercentageComplete\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"prerequisiteid\": \"\u003cstring\u003e\",\n \"priority\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedTimeManual\": \"\u003cinteger\u003e\",\n \"projectedTimeSpent\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"status\": \"complete\",\n \"storyPoints\": \"\u003cinteger\u003e\",\n \"tagid\": \"\u003cstring\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\",\n \"urgencyScore\": \"\u003cstring\u003e\",\n \"urgencyScoreId\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7796123e-cb01-4ead-a2cc-80c8c1fbf966", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billType\": \"\u003cinteger\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScore\": \"\u003cstring\u003e\",\n \"effortScoreId\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"impactScore\": \"\u003cstring\u003e\",\n \"impactScoreId\": \"\u003cinteger\u003e\",\n \"importanceScore\": \"\u003cstring\u003e\",\n \"importanceScoreId\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"manualPercentageComplete\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"prerequisiteid\": \"\u003cstring\u003e\",\n \"priority\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedTimeManual\": \"\u003cinteger\u003e\",\n \"projectedTimeSpent\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"status\": \"complete\",\n \"storyPoints\": \"\u003cinteger\u003e\",\n \"tagid\": \"\u003cstring\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\",\n \"urgencyScore\": \"\u003cstring\u003e\",\n \"urgencyScoreId\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9aeb2b8d-b676-4e57-bedc-62f15dd15cd5", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billType\": \"\u003cinteger\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScore\": \"\u003cstring\u003e\",\n \"effortScoreId\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"impactScore\": \"\u003cstring\u003e\",\n \"impactScoreId\": \"\u003cinteger\u003e\",\n \"importanceScore\": \"\u003cstring\u003e\",\n \"importanceScoreId\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"manualPercentageComplete\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"prerequisiteid\": \"\u003cstring\u003e\",\n \"priority\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedTimeManual\": \"\u003cinteger\u003e\",\n \"projectedTimeSpent\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"status\": \"complete\",\n \"storyPoints\": \"\u003cinteger\u003e\",\n \"tagid\": \"\u003cstring\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\",\n \"urgencyScore\": \"\u003cstring\u003e\",\n \"urgencyScoreId\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3b140ec7-d143-44f6-ba97-a186bcb8eba4", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billType\": \"\u003cinteger\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScore\": \"\u003cstring\u003e\",\n \"effortScoreId\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"impactScore\": \"\u003cstring\u003e\",\n \"impactScoreId\": \"\u003cinteger\u003e\",\n \"importanceScore\": \"\u003cstring\u003e\",\n \"importanceScoreId\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"manualPercentageComplete\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"prerequisiteid\": \"\u003cstring\u003e\",\n \"priority\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedTimeManual\": \"\u003cinteger\u003e\",\n \"projectedTimeSpent\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"status\": \"complete\",\n \"storyPoints\": \"\u003cinteger\u003e\",\n \"tagid\": \"\u003cstring\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\",\n \"urgencyScore\": \"\u003cstring\u003e\",\n \"urgencyScoreId\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5aeaa6da-d046-45cc-ba34-179e4daf434c", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billType\": \"\u003cinteger\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScore\": \"\u003cstring\u003e\",\n \"effortScoreId\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"impactScore\": \"\u003cstring\u003e\",\n \"impactScoreId\": \"\u003cinteger\u003e\",\n \"importanceScore\": \"\u003cstring\u003e\",\n \"importanceScoreId\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"manualPercentageComplete\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"prerequisiteid\": \"\u003cstring\u003e\",\n \"priority\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedTimeManual\": \"\u003cinteger\u003e\",\n \"projectedTimeSpent\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"status\": \"complete\",\n \"storyPoints\": \"\u003cinteger\u003e\",\n \"tagid\": \"\u003cstring\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\",\n \"urgencyScore\": \"\u003cstring\u003e\",\n \"urgencyScoreId\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "d926bf03-1628-4a62-ac18-fad3d86375cf", "name": "/projects/items/:itemid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Soft delete an Item.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/projects/items/:itemid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6c4d9018-34ee-40d4-8f5f-2ac441bf4cfa", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9fefed37-ba65-421f-bd6e-e472cec7e830", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "eecad0ff-6f69-4c70-9156-3ad97f215165", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "eee3c5fc-263b-4a35-b38c-93eb32cbdff5", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5e602ba3-a01c-4ade-bc88-6dc12c581a8d", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "c2d7d3dd-35e1-44fb-a4e0-3ba648961da8", "name": "/projects/items/:itemid/files", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" } ], "mode": "formdata" }, "description": { "content": "Upload a file to a Project Item (task folder). Send a multipart/form-data request with the file in the \"file\" field. The file is placed in the item's task folder. Blocked extensions: exe, msi, ini, bin, bat, cfm, cfc, asp, aspx, php, config, vb, java, pl.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/projects/items/:itemid/files", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", ":itemid", "files" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"fileid\": \"\u003cinteger\u003e\",\n \"filesize\": \"\u003cinteger\u003e\",\n \"folderid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4b12d160-fdbb-46bf-ae50-e0232b51ba29", "name": "Created", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" } ], "mode": "formdata" }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", ":itemid", "files" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "188d51ab-1196-4cab-bc21-6e5db624bdd6", "name": "Bad Request", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" } ], "mode": "formdata" }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", ":itemid", "files" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b038cd3d-a696-4666-86b8-b74bfb488ef2", "name": "Unauthorized", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" } ], "mode": "formdata" }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", ":itemid", "files" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "98512905-1513-45fa-b6d0-6dfd7492699a", "name": "Forbidden", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" } ], "mode": "formdata" }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", ":itemid", "files" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "55b04050-da4b-4458-941a-bbd0aa258398", "name": "Not Found", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" } ], "mode": "formdata" }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", ":itemid", "files" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "333b7d51-dac9-430b-b8ee-74cdce6ff07d", "name": "/projects/items/:itemid/order", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"placeafterid\": \"\u003cinteger\u003e\",\n \"placebeforeid\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Moves a project item before or after another item using sortorder. Provide exactly one of placeafterid or placebeforeid.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/projects/items/:itemid/order", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", ":itemid", "order" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "af122fba-52ab-418e-9f47-0a305aecd79a", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"placeafterid\": \"\u003cinteger\u003e\",\n \"placebeforeid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", ":itemid", "order" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9413ed09-4304-456a-ba7f-a5805294e78d", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"placeafterid\": \"\u003cinteger\u003e\",\n \"placebeforeid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", ":itemid", "order" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5f2b2c45-9cb8-4d02-8ca7-71ed443614b4", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"placeafterid\": \"\u003cinteger\u003e\",\n \"placebeforeid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", ":itemid", "order" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "a125ec00-9d50-403a-87cd-97c2ea8238ec", "name": "/projects/items/:itemid/workstage", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Sets the active work stage for a project item.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/projects/items/:itemid/workstage", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", ":itemid", "workstage" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "46b58064-dfae-43f6-9c3a-88f4ec589ab8", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", ":itemid", "workstage" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "cfd599d7-d41c-4cff-badd-41bb325ced18", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", ":itemid", "workstage" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "41ff723d-e4f5-41d5-a340-317a59821823", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "items", ":itemid", "workstage" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "00ebf789-2662-4713-af04-a8e8fb92bea3", "name": "/projects/overdue", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns active projects that are past their due date. Supports the same field selection, filtering, sorting, and pagination as GET /projects.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/projects/overdue", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "overdue" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "title,number,company,startdate,duedate" }, { "description": { "content": "Search by number or title. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by project number. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Company ID or list of Company IDs. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Manager Contact IDs, 'me', or 'all'. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Contact IDs, 'me', or 'all'. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Mode for contacts filter (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Team IDs (Advanced plan only). Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "teamid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group IDs (Advanced plan only). Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Category IDs. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Tag IDs. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Priority or list of Priorities (1-5). Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Workstage IDs. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects starting on or after this date (yyyy-mm-dd or relative: -3w)", "type": "text/plain" }, "disabled": true, "key": "startdatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects starting on or before this date (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "startdateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects due on or after this date (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects completed on or after this date (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "completedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects completed on or before this date (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "completedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects modified on or after this date in UTC (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects modified on or before this date in UTC (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,startdate,duedate,completedate,companyname,categoryname,priority)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "duedate" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"actualInLabour\": \"\u003cnumber\u003e\",\n \"actualInTotal\": \"\u003cnumber\u003e\",\n \"actualInTotalTax\": \"\u003cnumber\u003e\",\n \"actualOutLabour\": \"\u003cnumber\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billtotal\": \"\u003cnumber\u003e\",\n \"bookmarks\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"url\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"url\": \"\u003cstring\u003e\"\n }\n ],\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"burn\": \"\u003cnumber\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"categoryname\": \"\u003cstring\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"clients\": [\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"clienttype\": \"\u003cstring\u003e\",\n \"clientviewalltasks\": \"\u003cboolean\u003e\",\n \"clientviewtime\": \"\u003cboolean\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"contractorid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"contractors\": [\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"createdate\": \"\u003cstring\u003e\",\n \"customfieldoptionid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"customfields\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"value\": \"\u003cstring\u003e\",\n \"valuename\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"value\": \"\u003cstring\u003e\",\n \"valuename\": \"\u003cstring\u003e\"\n }\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"estBillAmount\": \"\u003cnumber\u003e\",\n \"estBillAmountTax\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"files\": [\n {\n \"description\": \"\u003cstring\u003e\",\n \"folderid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"modified\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"uniquetoken\": \"\u003cstring\u003e\"\n },\n {\n \"description\": \"\u003cstring\u003e\",\n \"folderid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"modified\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"uniquetoken\": \"\u003cstring\u003e\"\n }\n ],\n \"folders\": [\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"modified\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"modified\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"groupid\": \"\u003cinteger\u003e\",\n \"groupname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"internalclientcontactid\": \"\u003cinteger\u003e\",\n \"internalclientgroupid\": \"\u003cinteger\u003e\",\n \"internalclientgroupname\": \"\u003cstring\u003e\",\n \"internalclientteamid\": \"\u003cinteger\u003e\",\n \"internalclientteamname\": \"\u003cstring\u003e\",\n \"invoiced\": \"\u003cboolean\u003e\",\n \"invoicedAmount\": \"\u003cnumber\u003e\",\n \"invoicedAmountTax\": \"\u003cnumber\u003e\",\n \"invoices\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoicedate\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"paid\": \"\u003cboolean\u003e\",\n \"paiddate\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoicedate\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"paid\": \"\u003cboolean\u003e\",\n \"paiddate\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\"\n }\n ],\n \"invoicetotal\": \"\u003cnumber\u003e\",\n \"itemDueDate\": \"\u003cstring\u003e\",\n \"itemStartDate\": \"\u003cstring\u003e\",\n \"itemsActive\": \"\u003cinteger\u003e\",\n \"itemsCompleted\": \"\u003cinteger\u003e\",\n \"itemsDiscount\": \"\u003cnumber\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"managerfirstname\": \"\u003cstring\u003e\",\n \"managerid\": \"\u003cinteger\u003e\",\n \"managerlastname\": \"\u003cstring\u003e\",\n \"messages\": [\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"replycount\": \"\u003cinteger\u003e\",\n \"senddate\": \"\u003cstring\u003e\",\n \"senderid\": \"\u003cinteger\u003e\",\n \"shortdetails\": \"\u003cstring\u003e\",\n \"subject\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"replycount\": \"\u003cinteger\u003e\",\n \"senddate\": \"\u003cstring\u003e\",\n \"senderid\": \"\u003cinteger\u003e\",\n \"shortdetails\": \"\u003cstring\u003e\",\n \"subject\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"notification\": \"\u003cboolean\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"paid\": \"\u003cboolean\u003e\",\n \"paidAmountTax\": \"\u003cnumber\u003e\",\n \"paidamount\": \"\u003cnumber\u003e\",\n \"percentcomplete\": \"\u003cinteger\u003e\",\n \"phases\": [\n {\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n }\n ],\n \"name\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n },\n {\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n }\n ],\n \"name\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n }\n ],\n \"priority\": \"\u003cinteger\u003e\",\n \"privatenotes\": \"\u003cstring\u003e\",\n \"projectedBillAmount\": \"\u003cnumber\u003e\",\n \"projectedBillAmountTax\": \"\u003cnumber\u003e\",\n \"projectedGrossMargin\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"projectedTimeManual\": \"\u003cnumber\u003e\",\n \"projectedTimeSpent\": \"\u003cnumber\u003e\",\n \"projectnotes\": [\n {\n \"content\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n },\n {\n \"content\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n }\n ],\n \"purchaseorder\": \"\u003cstring\u003e\",\n \"staff\": [\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"staffid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"staffviewalltasks\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cnumber\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tags\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"teamid\": \"\u003cinteger\u003e\",\n \"teamname\": \"\u003cstring\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\",\n \"timerecords\": [\n {\n \"accountedfor\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"endtime\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"notes\": \"\u003cstring\u003e\",\n \"running\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n },\n {\n \"accountedfor\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"endtime\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"notes\": \"\u003cstring\u003e\",\n \"running\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n }\n ],\n \"timetracked\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\",\n \"workstagename\": \"\u003cstring\u003e\",\n \"workstages\": [\n {\n \"active\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"setdatetime\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\"\n },\n {\n \"active\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"setdatetime\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\"\n }\n ]\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"actualInLabour\": \"\u003cnumber\u003e\",\n \"actualInTotal\": \"\u003cnumber\u003e\",\n \"actualInTotalTax\": \"\u003cnumber\u003e\",\n \"actualOutLabour\": \"\u003cnumber\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billtotal\": \"\u003cnumber\u003e\",\n \"bookmarks\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"url\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"url\": \"\u003cstring\u003e\"\n }\n ],\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"burn\": \"\u003cnumber\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"categoryname\": \"\u003cstring\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"clients\": [\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"clienttype\": \"\u003cstring\u003e\",\n \"clientviewalltasks\": \"\u003cboolean\u003e\",\n \"clientviewtime\": \"\u003cboolean\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"contractorid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"contractors\": [\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"createdate\": \"\u003cstring\u003e\",\n \"customfieldoptionid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"customfields\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"value\": \"\u003cstring\u003e\",\n \"valuename\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"value\": \"\u003cstring\u003e\",\n \"valuename\": \"\u003cstring\u003e\"\n }\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"estBillAmount\": \"\u003cnumber\u003e\",\n \"estBillAmountTax\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"files\": [\n {\n \"description\": \"\u003cstring\u003e\",\n \"folderid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"modified\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"uniquetoken\": \"\u003cstring\u003e\"\n },\n {\n \"description\": \"\u003cstring\u003e\",\n \"folderid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"modified\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"uniquetoken\": \"\u003cstring\u003e\"\n }\n ],\n \"folders\": [\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"modified\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"modified\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"groupid\": \"\u003cinteger\u003e\",\n \"groupname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"internalclientcontactid\": \"\u003cinteger\u003e\",\n \"internalclientgroupid\": \"\u003cinteger\u003e\",\n \"internalclientgroupname\": \"\u003cstring\u003e\",\n \"internalclientteamid\": \"\u003cinteger\u003e\",\n \"internalclientteamname\": \"\u003cstring\u003e\",\n \"invoiced\": \"\u003cboolean\u003e\",\n \"invoicedAmount\": \"\u003cnumber\u003e\",\n \"invoicedAmountTax\": \"\u003cnumber\u003e\",\n \"invoices\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoicedate\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"paid\": \"\u003cboolean\u003e\",\n \"paiddate\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoicedate\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"paid\": \"\u003cboolean\u003e\",\n \"paiddate\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\"\n }\n ],\n \"invoicetotal\": \"\u003cnumber\u003e\",\n \"itemDueDate\": \"\u003cstring\u003e\",\n \"itemStartDate\": \"\u003cstring\u003e\",\n \"itemsActive\": \"\u003cinteger\u003e\",\n \"itemsCompleted\": \"\u003cinteger\u003e\",\n \"itemsDiscount\": \"\u003cnumber\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"managerfirstname\": \"\u003cstring\u003e\",\n \"managerid\": \"\u003cinteger\u003e\",\n \"managerlastname\": \"\u003cstring\u003e\",\n \"messages\": [\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"replycount\": \"\u003cinteger\u003e\",\n \"senddate\": \"\u003cstring\u003e\",\n \"senderid\": \"\u003cinteger\u003e\",\n \"shortdetails\": \"\u003cstring\u003e\",\n \"subject\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"replycount\": \"\u003cinteger\u003e\",\n \"senddate\": \"\u003cstring\u003e\",\n \"senderid\": \"\u003cinteger\u003e\",\n \"shortdetails\": \"\u003cstring\u003e\",\n \"subject\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"notification\": \"\u003cboolean\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"paid\": \"\u003cboolean\u003e\",\n \"paidAmountTax\": \"\u003cnumber\u003e\",\n \"paidamount\": \"\u003cnumber\u003e\",\n \"percentcomplete\": \"\u003cinteger\u003e\",\n \"phases\": [\n {\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n }\n ],\n \"name\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n },\n {\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n }\n ],\n \"name\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n }\n ],\n \"priority\": \"\u003cinteger\u003e\",\n \"privatenotes\": \"\u003cstring\u003e\",\n \"projectedBillAmount\": \"\u003cnumber\u003e\",\n \"projectedBillAmountTax\": \"\u003cnumber\u003e\",\n \"projectedGrossMargin\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"projectedTimeManual\": \"\u003cnumber\u003e\",\n \"projectedTimeSpent\": \"\u003cnumber\u003e\",\n \"projectnotes\": [\n {\n \"content\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n },\n {\n \"content\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n }\n ],\n \"purchaseorder\": \"\u003cstring\u003e\",\n \"staff\": [\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"staffid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"staffviewalltasks\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cnumber\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tags\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"teamid\": \"\u003cinteger\u003e\",\n \"teamname\": \"\u003cstring\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\",\n \"timerecords\": [\n {\n \"accountedfor\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"endtime\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"notes\": \"\u003cstring\u003e\",\n \"running\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n },\n {\n \"accountedfor\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"endtime\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"notes\": \"\u003cstring\u003e\",\n \"running\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n }\n ],\n \"timetracked\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\",\n \"workstagename\": \"\u003cstring\u003e\",\n \"workstages\": [\n {\n \"active\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"setdatetime\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\"\n },\n {\n \"active\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"setdatetime\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\"\n }\n ]\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3090a2ab-6b75-4a5f-a37f-135dd08f0c25", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "overdue" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "title,number,company,startdate,duedate" }, { "description": { "content": "Search by number or title. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by project number. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Company ID or list of Company IDs. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Manager Contact IDs, 'me', or 'all'. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Contact IDs, 'me', or 'all'. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Mode for contacts filter (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Team IDs (Advanced plan only). Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "teamid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group IDs (Advanced plan only). Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Category IDs. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Tag IDs. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Priority or list of Priorities (1-5). Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Workstage IDs. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects starting on or after this date (yyyy-mm-dd or relative: -3w)", "type": "text/plain" }, "disabled": true, "key": "startdatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects starting on or before this date (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "startdateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects due on or after this date (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects completed on or after this date (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "completedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects completed on or before this date (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "completedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects modified on or after this date in UTC (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects modified on or before this date in UTC (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,startdate,duedate,completedate,companyname,categoryname,priority)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "duedate" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "009b4752-7a6c-42ef-84d6-dcb30fc88254", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "overdue" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "title,number,company,startdate,duedate" }, { "description": { "content": "Search by number or title. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by project number. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Company ID or list of Company IDs. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Manager Contact IDs, 'me', or 'all'. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Contact IDs, 'me', or 'all'. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Mode for contacts filter (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Team IDs (Advanced plan only). Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "teamid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group IDs (Advanced plan only). Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Category IDs. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Tag IDs. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Priority or list of Priorities (1-5). Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Workstage IDs. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects starting on or after this date (yyyy-mm-dd or relative: -3w)", "type": "text/plain" }, "disabled": true, "key": "startdatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects starting on or before this date (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "startdateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects due on or after this date (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects completed on or after this date (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "completedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects completed on or before this date (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "completedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects modified on or after this date in UTC (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects modified on or before this date in UTC (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,startdate,duedate,completedate,companyname,categoryname,priority)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "duedate" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "43bfbf2f-9372-4a39-8ca2-b2441b622009", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "overdue" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "title,number,company,startdate,duedate" }, { "description": { "content": "Search by number or title. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by project number. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Company ID or list of Company IDs. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Manager Contact IDs, 'me', or 'all'. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Contact IDs, 'me', or 'all'. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Mode for contacts filter (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Team IDs (Advanced plan only). Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "teamid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group IDs (Advanced plan only). Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Category IDs. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Tag IDs. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Priority or list of Priorities (1-5). Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Workstage IDs. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects starting on or after this date (yyyy-mm-dd or relative: -3w)", "type": "text/plain" }, "disabled": true, "key": "startdatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects starting on or before this date (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "startdateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects due on or after this date (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects completed on or after this date (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "completedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects completed on or before this date (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "completedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects modified on or after this date in UTC (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects modified on or before this date in UTC (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,startdate,duedate,completedate,companyname,categoryname,priority)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "duedate" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b466943d-48e0-4574-aa31-b3982b2dcec2", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "overdue" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "title,number,company,startdate,duedate" }, { "description": { "content": "Search by number or title. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by project number. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Company ID or list of Company IDs. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Manager Contact IDs, 'me', or 'all'. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Contact IDs, 'me', or 'all'. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Mode for contacts filter (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Team IDs (Advanced plan only). Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "teamid", "value": "\u003cstring\u003e" }, { "description": { "content": "Group IDs (Advanced plan only). Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "groupid", "value": "\u003cstring\u003e" }, { "description": { "content": "Category IDs. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Tag IDs. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Priority or list of Priorities (1-5). Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Workstage IDs. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects starting on or after this date (yyyy-mm-dd or relative: -3w)", "type": "text/plain" }, "disabled": true, "key": "startdatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects starting on or before this date (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "startdateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects due on or after this date (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects completed on or after this date (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "completedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects completed on or before this date (yyyy-mm-dd or relative)", "type": "text/plain" }, "disabled": true, "key": "completedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects modified on or after this date in UTC (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects modified on or before this date in UTC (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Projects with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,startdate,duedate,completedate,companyname,categoryname,priority)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "duedate" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "ffc2640f-de4e-43bf-beba-3b28d1819974", "name": "/projects/phases", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns phases (item collections) across all projects with aggregated financial and progress metrics. Optionally filter by one or more project IDs. Access is contact-filtered based on the authenticated user's project membership.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/projects/phases", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "phases" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,projectid,parentid,timeallocated,timespent,estBillAmount,billAmount" }, { "description": { "content": "Search by phase name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Project ID or comma-separated list of Project IDs to filter by", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to phases with a specific parent phase ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder,startdate,duedate)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" }, { "description": { "content": "Phases modified on or after this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Phases modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"actualInLabour\": \"\u003cnumber\u003e\",\n \"actualInTotal\": \"\u003cnumber\u003e\",\n \"actualInTotalTax\": \"\u003cnumber\u003e\",\n \"actualOutLabour\": \"\u003cnumber\u003e\",\n \"actualProfit\": \"\u003cnumber\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"datecreated\": \"\u003cstring\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"estBillAmount\": \"\u003cnumber\u003e\",\n \"estBillAmountTax\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoicedAmount\": \"\u003cnumber\u003e\",\n \"invoicedAmountTax\": \"\u003cnumber\u003e\",\n \"invoiceitemcollectionid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"itemsActive\": \"\u003cinteger\u003e\",\n \"itemsCompleted\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"paidAmount\": \"\u003cnumber\u003e\",\n \"paidAmountTax\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedBillAmount\": \"\u003cnumber\u003e\",\n \"projectedBillAmountTax\": \"\u003cnumber\u003e\",\n \"projectedGrossMargin\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"projectedTimeManual\": \"\u003cnumber\u003e\",\n \"projectedTimeSpent\": \"\u003cnumber\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"quoteitemcollectionid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n },\n {\n \"actualInLabour\": \"\u003cnumber\u003e\",\n \"actualInTotal\": \"\u003cnumber\u003e\",\n \"actualInTotalTax\": \"\u003cnumber\u003e\",\n \"actualOutLabour\": \"\u003cnumber\u003e\",\n \"actualProfit\": \"\u003cnumber\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"datecreated\": \"\u003cstring\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"estBillAmount\": \"\u003cnumber\u003e\",\n \"estBillAmountTax\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoicedAmount\": \"\u003cnumber\u003e\",\n \"invoicedAmountTax\": \"\u003cnumber\u003e\",\n \"invoiceitemcollectionid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"itemsActive\": \"\u003cinteger\u003e\",\n \"itemsCompleted\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"paidAmount\": \"\u003cnumber\u003e\",\n \"paidAmountTax\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedBillAmount\": \"\u003cnumber\u003e\",\n \"projectedBillAmountTax\": \"\u003cnumber\u003e\",\n \"projectedGrossMargin\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"projectedTimeManual\": \"\u003cnumber\u003e\",\n \"projectedTimeSpent\": \"\u003cnumber\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"quoteitemcollectionid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "123edf54-20aa-458b-8825-d6f7d2acb102", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "phases" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,projectid,parentid,timeallocated,timespent,estBillAmount,billAmount" }, { "description": { "content": "Search by phase name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Project ID or comma-separated list of Project IDs to filter by", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to phases with a specific parent phase ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder,startdate,duedate)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" }, { "description": { "content": "Phases modified on or after this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Phases modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d5a0bd8c-f4d8-4909-af23-5172468ba6a8", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "phases" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,projectid,parentid,timeallocated,timespent,estBillAmount,billAmount" }, { "description": { "content": "Search by phase name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Project ID or comma-separated list of Project IDs to filter by", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to phases with a specific parent phase ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder,startdate,duedate)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" }, { "description": { "content": "Phases modified on or after this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Phases modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b5aad851-fe1b-4a2f-964b-6274adb53dce", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "phases" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,projectid,parentid,timeallocated,timespent,estBillAmount,billAmount" }, { "description": { "content": "Search by phase name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Project ID or comma-separated list of Project IDs to filter by", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to phases with a specific parent phase ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder,startdate,duedate)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" }, { "description": { "content": "Phases modified on or after this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Phases modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" } ], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c8aaf967-9875-418c-b24e-e276e12a2b4e", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "phases" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,projectid,parentid,timeallocated,timespent,estBillAmount,billAmount" }, { "description": { "content": "Search by phase name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Project ID or comma-separated list of Project IDs to filter by", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to phases with a specific parent phase ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder,startdate,duedate)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" }, { "description": { "content": "Phases modified on or after this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Phases modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" } ], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "f6822941-ec77-4925-8739-b1f7fa94ae56", "name": "/projects/phases", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billType\": \"\u003cinteger\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Updates one or more project phases by ID. All fields except ids are optional.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/projects/phases", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "phases" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e449c15f-f0d9-4bfa-9d6e-985387627770", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billType\": \"\u003cinteger\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "phases" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "231a04ba-969e-4d19-bc7d-35b97fedaede", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billType\": \"\u003cinteger\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "phases" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "0fa11024-102b-4eef-be42-3c193dd8d157", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billType\": \"\u003cinteger\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "phases" ], "query": [], "variable": [] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "ce3baa15-b8a9-40d1-9b05-41a6a87d697f", "name": "/projects/phases", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Adds a Phase (Item Collection).", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/projects/phases", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "phases" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ed63dfb9-cb24-49e3-80fc-e390ad63691f", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "phases" ], "query": [], "variable": [] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e66b6cd2-2fae-44cb-82d2-ed574a835638", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "phases" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "33833ae5-e7e0-43bb-b391-700311cb9cff", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "phases" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a6e93dac-92ca-481c-95d4-f6cc69331eba", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "phases" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "bc350139-626f-46a5-82d4-6dfbfddbdf2c", "name": "/projects/phases/adjustdates", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"shiftchilddates\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Shifts item dates within one or more project phases by a number of days. Negative values shift backwards.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/projects/phases/adjustdates", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "phases", "adjustdates" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "fd71aef7-631b-40ce-8734-19a1ea9204e7", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"shiftchilddates\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "phases", "adjustdates" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5595206c-9873-4f79-99a0-b97b0bbbe957", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"shiftchilddates\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "phases", "adjustdates" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5939bc99-ea91-4ae7-b44a-b3e64e05f7df", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"shiftchilddates\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "phases", "adjustdates" ], "query": [], "variable": [] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "3f2460a8-cde3-45ae-8904-2e998f09e204", "name": "/projects/phases/:phaseid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns full details of a single phase (item collection) by ID. Equivalent to GET /projects/{projectid}/phases/{phaseid} but looks up the phase by ID alone.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/projects/phases/:phaseid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"actualInLabour\": \"\u003cnumber\u003e\",\n \"actualInTotal\": \"\u003cnumber\u003e\",\n \"actualInTotalTax\": \"\u003cnumber\u003e\",\n \"actualOutLabour\": \"\u003cnumber\u003e\",\n \"actualProfit\": \"\u003cnumber\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"datecreated\": \"\u003cstring\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"estBillAmount\": \"\u003cnumber\u003e\",\n \"estBillAmountTax\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoicedAmount\": \"\u003cnumber\u003e\",\n \"invoicedAmountTax\": \"\u003cnumber\u003e\",\n \"invoiceitemcollectionid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"itemsActive\": \"\u003cinteger\u003e\",\n \"itemsCompleted\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"paidAmount\": \"\u003cnumber\u003e\",\n \"paidAmountTax\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedBillAmount\": \"\u003cnumber\u003e\",\n \"projectedBillAmountTax\": \"\u003cnumber\u003e\",\n \"projectedGrossMargin\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"projectedTimeManual\": \"\u003cnumber\u003e\",\n \"projectedTimeSpent\": \"\u003cnumber\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"quoteitemcollectionid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6708e641-5c7e-4698-b679-2ac2e92ec4fc", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5e40f32f-9194-47f1-a0d6-706bcdfa21ca", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7b799337-7324-4742-b6d3-34a890db331b", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "83a33232-4351-4495-8574-e8c6680ac045", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7eefc5bb-4a21-4b1c-8bcb-2a71c6b4bca3", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "eda95536-da07-48ad-8898-8dab04796d77", "name": "/projects/phases/:phaseid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Updates an existing Phase.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/projects/phases/:phaseid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a932a0af-c2af-4c97-8c23-02c7bb7bc19e", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "51b14458-c6bd-418f-93cf-cf6787a142a2", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "fb399c75-4070-4750-be15-ceed24bf96ec", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "cce78d1e-7b25-4c38-b6d7-aa3499d56f68", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b214a4f6-7927-4f5e-9903-9ffc9303cb59", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "6440ae27-9516-411d-8a2b-47490f719f7c", "name": "/projects/phases/:phaseid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Soft deletes a Phase and its associated items.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/projects/phases/:phaseid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6c764104-9a9d-4d27-9b37-885b31388ad5", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "69561e69-7fb8-4c91-8d7d-4d5650694ad2", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "17d0fe20-7633-4233-82b0-77e5a739f662", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6e751ee7-6aac-4d56-9ef6-f74b550d08ae", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "bd5dddf3-562a-4221-95cc-09a52a480542", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "a612e83c-b279-48b9-9344-49f7703b49d7", "name": "/projects/quotes", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"itemid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"number\": \"\u003cstring\u003e\",\n \"quotedate\": \"\u003cstring\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Creates a Quote based on project items.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/projects/quotes", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "quotes" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6e599e6e-2282-4779-bc47-f8824eafeaa7", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"itemid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"number\": \"\u003cstring\u003e\",\n \"quotedate\": \"\u003cstring\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "quotes" ], "query": [], "variable": [] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7c047c5f-5b81-4116-a1d2-20d78d1af4bc", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"itemid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"number\": \"\u003cstring\u003e\",\n \"quotedate\": \"\u003cstring\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "quotes" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "aef2dbf8-f33d-4d06-861a-3144186df14d", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"itemid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"number\": \"\u003cstring\u003e\",\n \"quotedate\": \"\u003cstring\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "quotes" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "18369da6-8ca5-49e9-8589-82e7df93c5f2", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"itemid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"number\": \"\u003cstring\u003e\",\n \"quotedate\": \"\u003cstring\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "quotes" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "6b19d8da-d4b9-49b9-bd32-df21274fb4c1", "name": "/projects/tags", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Adds one or more Tags to one or more Projects.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/projects/tags", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "tags" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "566ccf3f-f9ee-41a7-a294-96aa936e5370", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "tags" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "62b2cb7a-0923-4917-8e85-6f661c10aa1a", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "tags" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "04e4b8e3-d398-4ce8-a610-1855620e99f8", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "tags" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c1af6a7e-bd15-4248-b220-96dd597e6089", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "tags" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "6c51e8c4-4607-43bf-b084-156392b4fc36", "name": "/projects/tags", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Removes one or more Tags from one or more Projects.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/projects/tags", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "tags" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8a23a829-477f-4a8b-ac60-29b509b4a7ab", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "tags" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7cfae955-3228-486d-837e-e7a1b064ecc5", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "tags" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "64589eea-48ab-4c66-a7d4-7fe861e748f2", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "tags" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8ccb5e5f-83b4-4152-a0c8-376c4a069416", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "tags" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "fc3decf3-2d35-425d-b415-9774d9223a10", "name": "/projects/tags/all", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Removes all Tags from one or more Projects.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/projects/tags/all", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "tags", "all" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a8cabbc5-dd4d-47ff-8fe3-0af8ec46ebd9", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "tags", "all" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "06c52fbe-9e5e-4431-b966-845f911eadfa", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "tags", "all" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c7c8d8f0-fc9d-443b-8dbb-17afd577e1bb", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "tags", "all" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5bed4620-7df5-491d-89b1-5ac6ebc81f1c", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", "tags", "all" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "a93b195e-134a-4c77-a5aa-85785f9f9e1d", "name": "/projects/:projectid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns details of a single Project. By default returns all scalar fields. Add sub-entity names to fields to include them (e.g. fields=all,phases). Sub-entities are never included by \"all\" — they must be requested explicitly.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/projects/:projectid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid" ], "query": [ { "description": { "content": "Comma-separated fields to return (or 'all'). Sub-entities: phases, timerecords, messages, files, folders, invoices, workstages, bookmarks, projectnotes. Example: all,phases or phases,timerecords", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "all" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"actualInLabour\": \"\u003cnumber\u003e\",\n \"actualInTotal\": \"\u003cnumber\u003e\",\n \"actualInTotalTax\": \"\u003cnumber\u003e\",\n \"actualOutLabour\": \"\u003cnumber\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billtotal\": \"\u003cnumber\u003e\",\n \"bookmarks\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"url\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"url\": \"\u003cstring\u003e\"\n }\n ],\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"burn\": \"\u003cnumber\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"categoryname\": \"\u003cstring\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"clients\": [\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"clienttype\": \"\u003cstring\u003e\",\n \"clientviewalltasks\": \"\u003cboolean\u003e\",\n \"clientviewtime\": \"\u003cboolean\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"contractorid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"contractors\": [\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"createdate\": \"\u003cstring\u003e\",\n \"customfieldoptionid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"customfields\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"value\": \"\u003cstring\u003e\",\n \"valuename\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"value\": \"\u003cstring\u003e\",\n \"valuename\": \"\u003cstring\u003e\"\n }\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"estBillAmount\": \"\u003cnumber\u003e\",\n \"estBillAmountTax\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"files\": [\n {\n \"description\": \"\u003cstring\u003e\",\n \"folderid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"modified\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"uniquetoken\": \"\u003cstring\u003e\"\n },\n {\n \"description\": \"\u003cstring\u003e\",\n \"folderid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"modified\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"uniquetoken\": \"\u003cstring\u003e\"\n }\n ],\n \"folders\": [\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"modified\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"modified\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"groupid\": \"\u003cinteger\u003e\",\n \"groupname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"internalclientcontactid\": \"\u003cinteger\u003e\",\n \"internalclientgroupid\": \"\u003cinteger\u003e\",\n \"internalclientgroupname\": \"\u003cstring\u003e\",\n \"internalclientteamid\": \"\u003cinteger\u003e\",\n \"internalclientteamname\": \"\u003cstring\u003e\",\n \"invoiced\": \"\u003cboolean\u003e\",\n \"invoicedAmount\": \"\u003cnumber\u003e\",\n \"invoicedAmountTax\": \"\u003cnumber\u003e\",\n \"invoices\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoicedate\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"paid\": \"\u003cboolean\u003e\",\n \"paiddate\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoicedate\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"paid\": \"\u003cboolean\u003e\",\n \"paiddate\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\"\n }\n ],\n \"invoicetotal\": \"\u003cnumber\u003e\",\n \"itemDueDate\": \"\u003cstring\u003e\",\n \"itemStartDate\": \"\u003cstring\u003e\",\n \"itemsActive\": \"\u003cinteger\u003e\",\n \"itemsCompleted\": \"\u003cinteger\u003e\",\n \"itemsDiscount\": \"\u003cnumber\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"managerfirstname\": \"\u003cstring\u003e\",\n \"managerid\": \"\u003cinteger\u003e\",\n \"managerlastname\": \"\u003cstring\u003e\",\n \"messages\": [\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"replycount\": \"\u003cinteger\u003e\",\n \"senddate\": \"\u003cstring\u003e\",\n \"senderid\": \"\u003cinteger\u003e\",\n \"shortdetails\": \"\u003cstring\u003e\",\n \"subject\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"replycount\": \"\u003cinteger\u003e\",\n \"senddate\": \"\u003cstring\u003e\",\n \"senderid\": \"\u003cinteger\u003e\",\n \"shortdetails\": \"\u003cstring\u003e\",\n \"subject\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"notification\": \"\u003cboolean\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"paid\": \"\u003cboolean\u003e\",\n \"paidAmountTax\": \"\u003cnumber\u003e\",\n \"paidamount\": \"\u003cnumber\u003e\",\n \"percentcomplete\": \"\u003cinteger\u003e\",\n \"phases\": [\n {\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n }\n ],\n \"name\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n },\n {\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n }\n ],\n \"name\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n }\n ],\n \"priority\": \"\u003cinteger\u003e\",\n \"privatenotes\": \"\u003cstring\u003e\",\n \"projectedBillAmount\": \"\u003cnumber\u003e\",\n \"projectedBillAmountTax\": \"\u003cnumber\u003e\",\n \"projectedGrossMargin\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"projectedTimeManual\": \"\u003cnumber\u003e\",\n \"projectedTimeSpent\": \"\u003cnumber\u003e\",\n \"projectnotes\": [\n {\n \"content\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n },\n {\n \"content\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n }\n ],\n \"purchaseorder\": \"\u003cstring\u003e\",\n \"staff\": [\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"staffid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"staffviewalltasks\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cnumber\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tags\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"teamid\": \"\u003cinteger\u003e\",\n \"teamname\": \"\u003cstring\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\",\n \"timerecords\": [\n {\n \"accountedfor\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"endtime\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"notes\": \"\u003cstring\u003e\",\n \"running\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n },\n {\n \"accountedfor\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"endtime\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"notes\": \"\u003cstring\u003e\",\n \"running\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n }\n ],\n \"timetracked\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\",\n \"workstagename\": \"\u003cstring\u003e\",\n \"workstages\": [\n {\n \"active\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"setdatetime\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\"\n },\n {\n \"active\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"setdatetime\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\"\n }\n ]\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d92ba85f-5c7d-4651-b079-3265adbc9575", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid" ], "query": [ { "description": { "content": "Comma-separated fields to return (or 'all'). Sub-entities: phases, timerecords, messages, files, folders, invoices, workstages, bookmarks, projectnotes. Example: all,phases or phases,timerecords", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "all" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2ad1689f-79e7-4d17-ac2a-faba539a2c00", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid" ], "query": [ { "description": { "content": "Comma-separated fields to return (or 'all'). Sub-entities: phases, timerecords, messages, files, folders, invoices, workstages, bookmarks, projectnotes. Example: all,phases or phases,timerecords", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "all" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a510c132-e21a-429c-9767-929d24135120", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid" ], "query": [ { "description": { "content": "Comma-separated fields to return (or 'all'). Sub-entities: phases, timerecords, messages, files, folders, invoices, workstages, bookmarks, projectnotes. Example: all,phases or phases,timerecords", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "all" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "89ac49cb-13fd-4735-8860-29e80256f0e1", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid" ], "query": [ { "description": { "content": "Comma-separated fields to return (or 'all'). Sub-entities: phases, timerecords, messages, files, folders, invoices, workstages, bookmarks, projectnotes. Example: all,phases or phases,timerecords", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "all" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c2cb8546-e358-4d66-9b15-7da2b9379e50", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid" ], "query": [ { "description": { "content": "Comma-separated fields to return (or 'all'). Sub-entities: phases, timerecords, messages, files, folders, invoices, workstages, bookmarks, projectnotes. Example: all,phases or phases,timerecords", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "all" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "189ffbea-b6ac-439d-8547-bb055b644d8a", "name": "/projects/:projectid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"clientviewalltasks\": \"\u003cboolean\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"contractorid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"customfields\": [\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"staff\",\n \"value\": \"\u003cstring\u003e\"\n },\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"text\",\n \"value\": \"\u003cstring\u003e\"\n }\n ],\n \"customformtitle\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"groupid\": \"\u003cinteger\u003e\",\n \"icalcontactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"managerid\": \"\u003cinteger\u003e\",\n \"notification\": \"\u003cboolean\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"privatenotes\": \"\u003cstring\u003e\",\n \"purchaseorder\": \"\u003cstring\u003e\",\n \"staffid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"staffviewalltasks\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"teamid\": \"\u003cinteger\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"templateused\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"worktypeid\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Updates an existing Project.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/projects/:projectid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "bddb8b8b-e7d2-4150-8c68-6569f027853b", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"clientviewalltasks\": \"\u003cboolean\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"contractorid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"customfields\": [\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"staff\",\n \"value\": \"\u003cstring\u003e\"\n },\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"text\",\n \"value\": \"\u003cstring\u003e\"\n }\n ],\n \"customformtitle\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"groupid\": \"\u003cinteger\u003e\",\n \"icalcontactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"managerid\": \"\u003cinteger\u003e\",\n \"notification\": \"\u003cboolean\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"privatenotes\": \"\u003cstring\u003e\",\n \"purchaseorder\": \"\u003cstring\u003e\",\n \"staffid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"staffviewalltasks\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"teamid\": \"\u003cinteger\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"templateused\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"worktypeid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "0dc2aefb-d635-4a03-9af4-bb3f040ea7f1", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"clientviewalltasks\": \"\u003cboolean\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"contractorid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"customfields\": [\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"staff\",\n \"value\": \"\u003cstring\u003e\"\n },\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"text\",\n \"value\": \"\u003cstring\u003e\"\n }\n ],\n \"customformtitle\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"groupid\": \"\u003cinteger\u003e\",\n \"icalcontactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"managerid\": \"\u003cinteger\u003e\",\n \"notification\": \"\u003cboolean\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"privatenotes\": \"\u003cstring\u003e\",\n \"purchaseorder\": \"\u003cstring\u003e\",\n \"staffid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"staffviewalltasks\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"teamid\": \"\u003cinteger\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"templateused\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"worktypeid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c5115527-2274-4653-ac85-a0f8f08d5388", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"clientviewalltasks\": \"\u003cboolean\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"contractorid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"customfields\": [\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"staff\",\n \"value\": \"\u003cstring\u003e\"\n },\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"text\",\n \"value\": \"\u003cstring\u003e\"\n }\n ],\n \"customformtitle\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"groupid\": \"\u003cinteger\u003e\",\n \"icalcontactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"managerid\": \"\u003cinteger\u003e\",\n \"notification\": \"\u003cboolean\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"privatenotes\": \"\u003cstring\u003e\",\n \"purchaseorder\": \"\u003cstring\u003e\",\n \"staffid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"staffviewalltasks\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"teamid\": \"\u003cinteger\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"templateused\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"worktypeid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5e93f948-176a-47fb-bda9-af34e261b929", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"clientviewalltasks\": \"\u003cboolean\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"contractorid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"customfields\": [\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"staff\",\n \"value\": \"\u003cstring\u003e\"\n },\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"text\",\n \"value\": \"\u003cstring\u003e\"\n }\n ],\n \"customformtitle\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"groupid\": \"\u003cinteger\u003e\",\n \"icalcontactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"managerid\": \"\u003cinteger\u003e\",\n \"notification\": \"\u003cboolean\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"privatenotes\": \"\u003cstring\u003e\",\n \"purchaseorder\": \"\u003cstring\u003e\",\n \"staffid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"staffviewalltasks\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"teamid\": \"\u003cinteger\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"templateused\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"worktypeid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5d3b7d8f-e1b2-4022-bc3d-7fcb3d9532cf", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"clientviewalltasks\": \"\u003cboolean\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"contractorid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"customfields\": [\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"staff\",\n \"value\": \"\u003cstring\u003e\"\n },\n {\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"text\",\n \"value\": \"\u003cstring\u003e\"\n }\n ],\n \"customformtitle\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"groupid\": \"\u003cinteger\u003e\",\n \"icalcontactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"managerid\": \"\u003cinteger\u003e\",\n \"notification\": \"\u003cboolean\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"privatenotes\": \"\u003cstring\u003e\",\n \"purchaseorder\": \"\u003cstring\u003e\",\n \"staffid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"staffviewalltasks\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"teamid\": \"\u003cinteger\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"templateused\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"worktypeid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "02ae61d6-0144-4de3-906c-4180810a6d78", "name": "/projects/:projectid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Soft deletes a Project.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/projects/:projectid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4af49788-0543-4723-9bae-49fad0b74499", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "0af7e7b1-762a-43e0-8e81-6b9ef7a01a0b", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e211f195-e430-4b0f-a8fe-d5f6d8c59d3e", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e47e87fe-c146-4002-9827-dc8cf7155b0b", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3a5e1bdc-d350-4b42-b8d9-252d94ada44f", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "461b02e2-33cb-42f8-98c7-b74d5d54f985", "name": "/projects/:projectid/access/:contactid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Check whether a contact can view a Project. Staff can check access for any contact; non-staff contacts are always checked against themselves.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/projects/:projectid/access/:contactid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "access", ":contactid" ], "query": [ { "description": { "content": "Return project title and number when access is granted (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "details", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Contact ID or 'me'", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cstring\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"access\": \"\u003cboolean\u003e\",\n \"details\": {\n \"number\": \"\u003cstring\u003e\",\n \"title\": \"\u003cstring\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8e8580bc-59a0-48db-a83c-a66987bd3c42", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "access", ":contactid" ], "query": [ { "description": { "content": "Return project title and number when access is granted (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "details", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Contact ID or 'me'", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cstring\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2940c185-76b4-4e1c-931b-59e493efa70f", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "access", ":contactid" ], "query": [ { "description": { "content": "Return project title and number when access is granted (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "details", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Contact ID or 'me'", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cstring\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "cab7c351-be79-46e9-a8f8-ada8252cb429", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "access", ":contactid" ], "query": [ { "description": { "content": "Return project title and number when access is granted (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "details", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Contact ID or 'me'", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cstring\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "1219118a-3952-4d7f-8309-2f51dfea9859", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "access", ":contactid" ], "query": [ { "description": { "content": "Return project title and number when access is granted (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "details", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Contact ID or 'me'", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cstring\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5dce505a-9b10-41b0-882c-8d001111e163", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "access", ":contactid" ], "query": [ { "description": { "content": "Return project title and number when access is granted (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "details", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Contact ID or 'me'", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cstring\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "2d10624f-2dec-4f0a-8612-642e88bd2885", "name": "/projects/:projectid/adjustdates", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"days\": \"\u003cinteger\u003e\",\n \"direction\": \"forward\",\n \"shiftchilddates\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Shifts all dates on a Project forward or backward by a specified number of days.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/projects/:projectid/adjustdates", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "adjustdates" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b9404d51-1c08-412d-a9b4-f00602869f67", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"days\": \"\u003cinteger\u003e\",\n \"direction\": \"forward\",\n \"shiftchilddates\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "adjustdates" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "71b7a053-fa8f-4d04-8ad6-5ce9b81a666e", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"days\": \"\u003cinteger\u003e\",\n \"direction\": \"forward\",\n \"shiftchilddates\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "adjustdates" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2c9a724c-586c-483b-8fcc-883fab2da94a", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"days\": \"\u003cinteger\u003e\",\n \"direction\": \"forward\",\n \"shiftchilddates\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "adjustdates" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "446c7369-464e-4899-b9b6-dbd4ea6c8f83", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"days\": \"\u003cinteger\u003e\",\n \"direction\": \"forward\",\n \"shiftchilddates\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "adjustdates" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3be615db-6f9c-4809-acae-e070bf5aab8b", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"days\": \"\u003cinteger\u003e\",\n \"direction\": \"forward\",\n \"shiftchilddates\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "adjustdates" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "f4a994ea-9e9e-47a1-b09f-69d564cc96fc", "name": "/projects/:projectid/bookmarks", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Bookmarks for a Project.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/projects/:projectid/bookmarks", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "bookmarks" ], "query": [ { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"url\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"url\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "50ab4016-2aaa-4468-9312-4d639062f3b0", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "bookmarks" ], "query": [ { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8724c17f-8fe4-49e4-871a-f80389bfedd8", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "bookmarks" ], "query": [ { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d16febec-6122-4936-a06d-48d891b86b50", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "bookmarks" ], "query": [ { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "139973a2-dd12-4ef0-9c46-daf3198ee8b2", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "bookmarks" ], "query": [ { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e98911bc-f167-47e4-871e-c41a3b3584a4", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "bookmarks" ], "query": [ { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "76806f89-8bdb-43df-b609-6f6aa72c2677", "name": "/projects/:projectid/bookmarks", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"title\": \"\u003cstring\u003e\",\n \"url\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Adds a Bookmark to a Project.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/projects/:projectid/bookmarks", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "bookmarks" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b593498d-64ea-44f4-aeda-96061b227af9", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"title\": \"\u003cstring\u003e\",\n \"url\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "bookmarks" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "bd2143e7-cd77-4b85-b07e-db428338e86a", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"title\": \"\u003cstring\u003e\",\n \"url\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "bookmarks" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "075cad52-2786-4be2-9f96-fe775be49d56", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"title\": \"\u003cstring\u003e\",\n \"url\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "bookmarks" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a1b112f9-73f0-4c58-859c-0d4c45d47b98", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"title\": \"\u003cstring\u003e\",\n \"url\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "bookmarks" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] }, { "event": [], "id": "2b1898b9-3528-43fc-8aaf-5733934b4b0b", "name": "/projects/:projectid/bookmarks/:bookmarkid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns details of a single Bookmark for a Project.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/projects/:projectid/bookmarks/:bookmarkid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "bookmarks", ":bookmarkid" ], "query": [ { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Bookmark ID", "type": "text/plain" }, "disabled": false, "key": "bookmarkid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"url\": \"\u003cstring\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f5c83946-eca2-4272-8146-53d4f161af5d", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "bookmarks", ":bookmarkid" ], "query": [ { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Bookmark ID", "type": "text/plain" }, "disabled": false, "key": "bookmarkid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "18e51419-3b7c-460a-a4c2-680bce2c2e88", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "bookmarks", ":bookmarkid" ], "query": [ { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Bookmark ID", "type": "text/plain" }, "disabled": false, "key": "bookmarkid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9c0a0687-548e-4825-84d3-68f01cd68e62", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "bookmarks", ":bookmarkid" ], "query": [ { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Bookmark ID", "type": "text/plain" }, "disabled": false, "key": "bookmarkid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e3d2c177-57ca-4df9-884d-91dd868eb54c", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "bookmarks", ":bookmarkid" ], "query": [ { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Bookmark ID", "type": "text/plain" }, "disabled": false, "key": "bookmarkid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3a15a5ce-5040-4e61-a9a2-d242e24b8c2a", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "bookmarks", ":bookmarkid" ], "query": [ { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Bookmark ID", "type": "text/plain" }, "disabled": false, "key": "bookmarkid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "fd34e0ce-0184-474b-bb4c-5299f20f7b4b", "name": "/projects/:projectid/bookmarks/:bookmarkid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"title\": \"\u003cstring\u003e\",\n \"url\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Updates a Project Bookmark.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/projects/:projectid/bookmarks/:bookmarkid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "bookmarks", ":bookmarkid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Bookmark ID", "type": "text/plain" }, "disabled": false, "key": "bookmarkid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "291f14b8-466e-4d61-9b25-f43a4add2263", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"title\": \"\u003cstring\u003e\",\n \"url\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "bookmarks", ":bookmarkid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Bookmark ID", "type": "text/plain" }, "disabled": false, "key": "bookmarkid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b978eefa-6dcd-49d1-b114-ccff0d67e993", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"title\": \"\u003cstring\u003e\",\n \"url\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "bookmarks", ":bookmarkid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Bookmark ID", "type": "text/plain" }, "disabled": false, "key": "bookmarkid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c4b6a78a-32cd-4794-8b86-f1156772a826", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"title\": \"\u003cstring\u003e\",\n \"url\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "bookmarks", ":bookmarkid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Bookmark ID", "type": "text/plain" }, "disabled": false, "key": "bookmarkid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "37d43a90-1e34-4df2-850c-b8af9f521463", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"title\": \"\u003cstring\u003e\",\n \"url\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "bookmarks", ":bookmarkid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Bookmark ID", "type": "text/plain" }, "disabled": false, "key": "bookmarkid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "0933eb31-72bc-4e9a-b2e2-44dfef56d225", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"title\": \"\u003cstring\u003e\",\n \"url\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "bookmarks", ":bookmarkid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Bookmark ID", "type": "text/plain" }, "disabled": false, "key": "bookmarkid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "9a5f256b-16d5-4676-b900-fe3e05d69402", "name": "/projects/:projectid/bookmarks/:bookmarkid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Soft deletes a Project Bookmark.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/projects/:projectid/bookmarks/:bookmarkid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "bookmarks", ":bookmarkid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Bookmark ID", "type": "text/plain" }, "disabled": false, "key": "bookmarkid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4c848101-c34e-4099-bd18-b42c345e68e3", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "bookmarks", ":bookmarkid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Bookmark ID", "type": "text/plain" }, "disabled": false, "key": "bookmarkid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8b0b8417-9d1f-4411-9651-bfc81cc7ab89", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "bookmarks", ":bookmarkid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Bookmark ID", "type": "text/plain" }, "disabled": false, "key": "bookmarkid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9dcf74ae-f071-4cc7-ba5c-bf54364f9737", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "bookmarks", ":bookmarkid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Bookmark ID", "type": "text/plain" }, "disabled": false, "key": "bookmarkid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "87414ff3-117e-43a5-806c-b4f81d73a7ac", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "bookmarks", ":bookmarkid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Bookmark ID", "type": "text/plain" }, "disabled": false, "key": "bookmarkid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "89445b41-9c59-49d4-b64d-6e0e509a90de", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "bookmarks", ":bookmarkid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Bookmark ID", "type": "text/plain" }, "disabled": false, "key": "bookmarkid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "3f97796d-ac26-4d16-88c9-627751a39c2d", "name": "/projects/:projectid/clone", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"dateSetting\": {\n \"keep\": \"\u003cboolean\u003e\",\n \"newStartDate\": \"\u003cstring\u003e\"\n },\n \"includeItems\": \"\u003cboolean\u003e\",\n \"includeTags\": \"\u003cboolean\u003e\",\n \"makeTemplate\": \"\u003cboolean\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"projectclient\": {\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": \"\u003cinteger\u003e\"\n },\n \"title\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Clones an existing project, optionally including its items and tags.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/projects/:projectid/clone", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "clone" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID to clone", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"id\": \"\u003cinteger\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"title\": \"\u003cstring\u003e\"\n },\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2a521287-5a87-4c24-b4b6-c437202419a4", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"dateSetting\": {\n \"keep\": \"\u003cboolean\u003e\",\n \"newStartDate\": \"\u003cstring\u003e\"\n },\n \"includeItems\": \"\u003cboolean\u003e\",\n \"includeTags\": \"\u003cboolean\u003e\",\n \"makeTemplate\": \"\u003cboolean\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"projectclient\": {\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": \"\u003cinteger\u003e\"\n },\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "clone" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID to clone", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3e8e4bbd-e5ab-44f2-a3bb-35be962f541d", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"dateSetting\": {\n \"keep\": \"\u003cboolean\u003e\",\n \"newStartDate\": \"\u003cstring\u003e\"\n },\n \"includeItems\": \"\u003cboolean\u003e\",\n \"includeTags\": \"\u003cboolean\u003e\",\n \"makeTemplate\": \"\u003cboolean\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"projectclient\": {\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": \"\u003cinteger\u003e\"\n },\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "clone" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID to clone", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a4f8903a-9194-42b8-8318-5ba51a5df1a3", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"dateSetting\": {\n \"keep\": \"\u003cboolean\u003e\",\n \"newStartDate\": \"\u003cstring\u003e\"\n },\n \"includeItems\": \"\u003cboolean\u003e\",\n \"includeTags\": \"\u003cboolean\u003e\",\n \"makeTemplate\": \"\u003cboolean\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"projectclient\": {\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": \"\u003cinteger\u003e\"\n },\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "clone" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID to clone", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a398aeca-d9bf-4613-aa4d-f68a9b6cc398", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"dateSetting\": {\n \"keep\": \"\u003cboolean\u003e\",\n \"newStartDate\": \"\u003cstring\u003e\"\n },\n \"includeItems\": \"\u003cboolean\u003e\",\n \"includeTags\": \"\u003cboolean\u003e\",\n \"makeTemplate\": \"\u003cboolean\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"projectclient\": {\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": \"\u003cinteger\u003e\"\n },\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "clone" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID to clone", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ea4ed83a-690a-43c5-8490-b09e84ff38df", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"dateSetting\": {\n \"keep\": \"\u003cboolean\u003e\",\n \"newStartDate\": \"\u003cstring\u003e\"\n },\n \"includeItems\": \"\u003cboolean\u003e\",\n \"includeTags\": \"\u003cboolean\u003e\",\n \"makeTemplate\": \"\u003cboolean\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"projectclient\": {\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": \"\u003cinteger\u003e\"\n },\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "clone" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID to clone", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "004ad6a4-41ac-4a39-9504-9f06007d0696", "name": "/projects/:projectid/complete", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Marks a Project as complete.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/projects/:projectid/complete", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "complete" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b36c826e-c17d-48c8-aab0-838935b2076a", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "complete" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2a55454c-9716-4576-b059-813e26a4816e", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "complete" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a6ee934b-300b-4d6a-a911-fe2a40c20502", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "complete" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "80677645-99a2-4566-acab-f194a8183070", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "complete" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "dfd08f69-6535-4a9a-bade-01aea8658978", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "complete" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "6af84699-dae4-42ec-be44-3411a832937f", "name": "/projects/:projectid/customfields/:customfieldid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"staff\",\n \"value\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Sets the value of a single custom field on a project.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/projects/:projectid/customfields/:customfieldid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "customfields", ":customfieldid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Custom Field ID", "type": "text/plain" }, "disabled": false, "key": "customfieldid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "77996f57-a046-4a5f-bd2b-4fa9fc3c654d", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"staff\",\n \"value\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "customfields", ":customfieldid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Custom Field ID", "type": "text/plain" }, "disabled": false, "key": "customfieldid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "eb1e8540-3949-4e24-ae1a-08651f3d4500", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"staff\",\n \"value\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "customfields", ":customfieldid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Custom Field ID", "type": "text/plain" }, "disabled": false, "key": "customfieldid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c462c5ea-33fc-4884-bc16-1a7702fe2daa", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"staff\",\n \"value\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "customfields", ":customfieldid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Custom Field ID", "type": "text/plain" }, "disabled": false, "key": "customfieldid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b51b2616-5650-481b-8d45-1f123c6903a4", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"customfieldoptionid\": \"\u003cinteger\u003e\",\n \"type\": \"staff\",\n \"value\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "customfields", ":customfieldid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Custom Field ID", "type": "text/plain" }, "disabled": false, "key": "customfieldid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] }, { "event": [], "id": "589ca5aa-bf2d-463b-8f3f-e288029fb162", "name": "/projects/:projectid/files", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Files for a Project based on the specified filters. The fields parameter allows you to choose which data fields to return for each File.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/projects/:projectid/files", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: date, description, folder, link, name, owner, size, item", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,item,date,size,link" }, { "description": { "content": "Search by file name. Use ! prefix for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by item activeworkstate (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Item ID or comma-separated list of Item IDs", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Folder ID or comma-separated list of Folder IDs", "type": "text/plain" }, "disabled": true, "key": "folderid", "value": "\u003cstring\u003e" }, { "description": { "content": "Files modified on or after this date (ISO8601 or relative: 12h, 5d)", "type": "text/plain" }, "disabled": true, "key": "datefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Files modified on or before this date (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "dateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Files with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Files with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of File IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,size,date,itemid,folderid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"contactids\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"folderid\": \"\u003cinteger\u003e\",\n \"foldername\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"itemname\": \"\u003cstring\u003e\",\n \"link\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"size\": \"\u003cinteger\u003e\"\n },\n {\n \"contactids\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"folderid\": \"\u003cinteger\u003e\",\n \"foldername\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"itemname\": \"\u003cstring\u003e\",\n \"link\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"size\": \"\u003cinteger\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a456bfd6-e854-4941-a285-1482d192f616", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: date, description, folder, link, name, owner, size, item", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,item,date,size,link" }, { "description": { "content": "Search by file name. Use ! prefix for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by item activeworkstate (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Item ID or comma-separated list of Item IDs", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Folder ID or comma-separated list of Folder IDs", "type": "text/plain" }, "disabled": true, "key": "folderid", "value": "\u003cstring\u003e" }, { "description": { "content": "Files modified on or after this date (ISO8601 or relative: 12h, 5d)", "type": "text/plain" }, "disabled": true, "key": "datefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Files modified on or before this date (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "dateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Files with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Files with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of File IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,size,date,itemid,folderid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "08241faa-880f-4cef-86a5-71dc7b69369e", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: date, description, folder, link, name, owner, size, item", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,item,date,size,link" }, { "description": { "content": "Search by file name. Use ! prefix for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by item activeworkstate (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Item ID or comma-separated list of Item IDs", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Folder ID or comma-separated list of Folder IDs", "type": "text/plain" }, "disabled": true, "key": "folderid", "value": "\u003cstring\u003e" }, { "description": { "content": "Files modified on or after this date (ISO8601 or relative: 12h, 5d)", "type": "text/plain" }, "disabled": true, "key": "datefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Files modified on or before this date (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "dateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Files with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Files with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of File IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,size,date,itemid,folderid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ce0d75b3-ab3b-4ca1-a8b8-670f64657e16", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: date, description, folder, link, name, owner, size, item", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,item,date,size,link" }, { "description": { "content": "Search by file name. Use ! prefix for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by item activeworkstate (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Item ID or comma-separated list of Item IDs", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Folder ID or comma-separated list of Folder IDs", "type": "text/plain" }, "disabled": true, "key": "folderid", "value": "\u003cstring\u003e" }, { "description": { "content": "Files modified on or after this date (ISO8601 or relative: 12h, 5d)", "type": "text/plain" }, "disabled": true, "key": "datefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Files modified on or before this date (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "dateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Files with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Files with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of File IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,size,date,itemid,folderid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ff7ee0d4-300b-4be4-90d7-c876e0aa69f6", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: date, description, folder, link, name, owner, size, item", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,item,date,size,link" }, { "description": { "content": "Search by file name. Use ! prefix for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by item activeworkstate (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Item ID or comma-separated list of Item IDs", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Folder ID or comma-separated list of Folder IDs", "type": "text/plain" }, "disabled": true, "key": "folderid", "value": "\u003cstring\u003e" }, { "description": { "content": "Files modified on or after this date (ISO8601 or relative: 12h, 5d)", "type": "text/plain" }, "disabled": true, "key": "datefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Files modified on or before this date (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "dateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Files with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Files with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of File IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,size,date,itemid,folderid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "901298a4-97d9-46a1-a8d1-13e26b15a476", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: date, description, folder, link, name, owner, size, item", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,item,date,size,link" }, { "description": { "content": "Search by file name. Use ! prefix for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by item activeworkstate (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Item ID or comma-separated list of Item IDs", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Folder ID or comma-separated list of Folder IDs", "type": "text/plain" }, "disabled": true, "key": "folderid", "value": "\u003cstring\u003e" }, { "description": { "content": "Files modified on or after this date (ISO8601 or relative: 12h, 5d)", "type": "text/plain" }, "disabled": true, "key": "datefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Files modified on or before this date (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "dateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Files with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Files with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of File IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,size,date,itemid,folderid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "3eeb2296-51c4-4ed1-ba69-cba05a75053d", "name": "/projects/:projectid/files", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" } ], "mode": "formdata" }, "description": { "content": "Upload a file to a Project's root folder. Send a multipart/form-data request with the file in the \"file\" field. To upload to a custom folder use POST /files/folders/{folderid}/files; to upload to a task folder use POST /projects/items/{itemid}/files. Blocked extensions: exe, msi, ini, bin, bat, cfm, cfc, asp, aspx, php, config, vb, java, pl.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/projects/:projectid/files", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "files" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"fileid\": \"\u003cinteger\u003e\",\n \"filesize\": \"\u003cinteger\u003e\",\n \"folderid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "44aff285-20c0-4e82-8e17-c64287eaab6a", "name": "Created", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" } ], "mode": "formdata" }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "files" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c0e4595b-acea-43cb-8e42-7d959112065c", "name": "Bad Request", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" } ], "mode": "formdata" }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "files" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b66669c2-9aa5-4410-8ebb-4c28224c6a8b", "name": "Unauthorized", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" } ], "mode": "formdata" }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "files" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "432cc317-0674-4ec0-ba67-889e8fef29ce", "name": "Forbidden", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" } ], "mode": "formdata" }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "files" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "cce47909-f2ba-41f7-b787-750360cc9abb", "name": "Not Found", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" } ], "mode": "formdata" }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "files" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "a87dfccb-6c94-42c9-89b9-92ad41cee423", "name": "/projects/:projectid/folders", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of custom Folders for a Project based on the specified filters.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/projects/:projectid/folders", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "folders" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: name, description, type, size, date, owner, contacts, item, public", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name" }, { "description": { "content": "Search by folder name. Use ! prefix for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Folders with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Folders with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Folder IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"contacts\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"contacts\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e16c8a58-b7a6-4c3f-bc99-b420f264cfca", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "folders" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: name, description, type, size, date, owner, contacts, item, public", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name" }, { "description": { "content": "Search by folder name. Use ! prefix for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Folders with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Folders with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Folder IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6d6d61f4-f236-4b06-a71a-db8d4b410e41", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "folders" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: name, description, type, size, date, owner, contacts, item, public", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name" }, { "description": { "content": "Search by folder name. Use ! prefix for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Folders with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Folders with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Folder IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "460b1258-b28f-45ec-85db-4620a91d8cdf", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "folders" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: name, description, type, size, date, owner, contacts, item, public", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name" }, { "description": { "content": "Search by folder name. Use ! prefix for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Folders with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Folders with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Folder IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5499b75b-c484-43b7-bb55-73ef5b95bfca", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "folders" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: name, description, type, size, date, owner, contacts, item, public", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name" }, { "description": { "content": "Search by folder name. Use ! prefix for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Folders with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Folders with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Folder IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "67fa00a4-f170-4a0a-b1c7-c3ef938f6491", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "folders" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: name, description, type, size, date, owner, contacts, item, public", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name" }, { "description": { "content": "Search by folder name. Use ! prefix for negation", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Folders with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Folders with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Folder IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "b7832fe4-4cbd-4b1c-a2e6-be18535e7d11", "name": "/projects/:projectid/invoices", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Invoices for a Project based on the specified filters.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/projects/:projectid/invoices", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "invoices" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "number,title,company,status,totals,projectid,invoiceddate,duedate" }, { "description": { "content": "Search by number or title. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by invoice number. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by invoice title. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchtitle", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoice status (This can only be one of draft,submitted,authorised,paid,voided,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "all" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project manager Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Project category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectcategoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date from (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "invoiceddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "invoiceddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Paid date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "paiddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Paid date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "paiddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total minimum", "type": "text/plain" }, "disabled": true, "key": "grandtotalfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total maximum", "type": "text/plain" }, "disabled": true, "key": "grandtotalto", "value": "\u003cstring\u003e" }, { "description": { "content": "Group results by. Returns subtotals per group. (This can only be one of company,project,status,day,week,month,year)", "type": "text/plain" }, "disabled": true, "key": "subtotals", "value": "status" }, { "description": { "content": "Date field for subtotals grouping (This can only be one of invoiced,due,paid)", "type": "text/plain" }, "disabled": true, "key": "subtotalsdateoption", "value": "paid" }, { "description": { "content": "Invoices modified on or after this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoices modified on or before this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoices with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoices with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Invoice IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,invoiceddate,duedate,companyname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"clientcontactname\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"customfieldname\": \"\u003cstring\u003e\",\n \"customfieldvalue\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"emaileddate\": \"\u003cstring\u003e\",\n \"emailedto\": \"\u003cstring\u003e\",\n \"emailedtoclient\": \"\u003cboolean\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoicedby\": \"\u003cstring\u003e\",\n \"invoiceddate\": \"\u003cstring\u003e\",\n \"invoicetermid\": \"\u003cinteger\u003e\",\n \"itemsDiscount\": \"\u003cnumber\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"pagetitle\": \"\u003cstring\u003e\",\n \"paid\": \"\u003cboolean\u003e\",\n \"paiddate\": \"\u003cstring\u003e\",\n \"paymentterms\": \"\u003cstring\u003e\",\n \"phases\": [\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n }\n ],\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n },\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n }\n ],\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n }\n ],\n \"projectid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"projectnumbers\": \"\u003cstring\u003e\",\n \"projecttitles\": \"\u003cstring\u003e\",\n \"purchaseordernumber\": \"\u003cstring\u003e\",\n \"showcostbreakdown\": \"\u003cboolean\u003e\",\n \"showitemdescription\": \"\u003cboolean\u003e\",\n \"showphases\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"taxable\": \"\u003cboolean\u003e\",\n \"taxrate\": \"\u003cnumber\u003e\",\n \"taxtotal\": \"\u003cnumber\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n },\n {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"clientcontactname\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"customfieldname\": \"\u003cstring\u003e\",\n \"customfieldvalue\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"emaileddate\": \"\u003cstring\u003e\",\n \"emailedto\": \"\u003cstring\u003e\",\n \"emailedtoclient\": \"\u003cboolean\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoicedby\": \"\u003cstring\u003e\",\n \"invoiceddate\": \"\u003cstring\u003e\",\n \"invoicetermid\": \"\u003cinteger\u003e\",\n \"itemsDiscount\": \"\u003cnumber\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"pagetitle\": \"\u003cstring\u003e\",\n \"paid\": \"\u003cboolean\u003e\",\n \"paiddate\": \"\u003cstring\u003e\",\n \"paymentterms\": \"\u003cstring\u003e\",\n \"phases\": [\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n }\n ],\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n },\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n }\n ],\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n }\n ],\n \"projectid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"projectnumbers\": \"\u003cstring\u003e\",\n \"projecttitles\": \"\u003cstring\u003e\",\n \"purchaseordernumber\": \"\u003cstring\u003e\",\n \"showcostbreakdown\": \"\u003cboolean\u003e\",\n \"showitemdescription\": \"\u003cboolean\u003e\",\n \"showphases\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"taxable\": \"\u003cboolean\u003e\",\n \"taxrate\": \"\u003cnumber\u003e\",\n \"taxtotal\": \"\u003cnumber\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6ba2b02b-7b8b-43a4-833c-6cd18f730652", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "invoices" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "number,title,company,status,totals,projectid,invoiceddate,duedate" }, { "description": { "content": "Search by number or title. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by invoice number. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by invoice title. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchtitle", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoice status (This can only be one of draft,submitted,authorised,paid,voided,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "all" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project manager Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Project category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectcategoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date from (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "invoiceddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "invoiceddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Paid date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "paiddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Paid date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "paiddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total minimum", "type": "text/plain" }, "disabled": true, "key": "grandtotalfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total maximum", "type": "text/plain" }, "disabled": true, "key": "grandtotalto", "value": "\u003cstring\u003e" }, { "description": { "content": "Group results by. Returns subtotals per group. (This can only be one of company,project,status,day,week,month,year)", "type": "text/plain" }, "disabled": true, "key": "subtotals", "value": "status" }, { "description": { "content": "Date field for subtotals grouping (This can only be one of invoiced,due,paid)", "type": "text/plain" }, "disabled": true, "key": "subtotalsdateoption", "value": "paid" }, { "description": { "content": "Invoices modified on or after this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoices modified on or before this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoices with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoices with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Invoice IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,invoiceddate,duedate,companyname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7fc157fb-9eef-4e21-b702-8ac35409bfe8", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "invoices" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "number,title,company,status,totals,projectid,invoiceddate,duedate" }, { "description": { "content": "Search by number or title. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by invoice number. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by invoice title. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchtitle", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoice status (This can only be one of draft,submitted,authorised,paid,voided,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "all" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project manager Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Project category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectcategoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date from (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "invoiceddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "invoiceddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Paid date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "paiddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Paid date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "paiddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total minimum", "type": "text/plain" }, "disabled": true, "key": "grandtotalfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total maximum", "type": "text/plain" }, "disabled": true, "key": "grandtotalto", "value": "\u003cstring\u003e" }, { "description": { "content": "Group results by. Returns subtotals per group. (This can only be one of company,project,status,day,week,month,year)", "type": "text/plain" }, "disabled": true, "key": "subtotals", "value": "status" }, { "description": { "content": "Date field for subtotals grouping (This can only be one of invoiced,due,paid)", "type": "text/plain" }, "disabled": true, "key": "subtotalsdateoption", "value": "paid" }, { "description": { "content": "Invoices modified on or after this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoices modified on or before this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoices with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoices with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Invoice IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,invoiceddate,duedate,companyname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9b479f6f-36d3-4187-9f40-026291f16f6f", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "invoices" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "number,title,company,status,totals,projectid,invoiceddate,duedate" }, { "description": { "content": "Search by number or title. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by invoice number. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by invoice title. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchtitle", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoice status (This can only be one of draft,submitted,authorised,paid,voided,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "all" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project manager Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Project category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectcategoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date from (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "invoiceddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "invoiceddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Paid date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "paiddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Paid date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "paiddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total minimum", "type": "text/plain" }, "disabled": true, "key": "grandtotalfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total maximum", "type": "text/plain" }, "disabled": true, "key": "grandtotalto", "value": "\u003cstring\u003e" }, { "description": { "content": "Group results by. Returns subtotals per group. (This can only be one of company,project,status,day,week,month,year)", "type": "text/plain" }, "disabled": true, "key": "subtotals", "value": "status" }, { "description": { "content": "Date field for subtotals grouping (This can only be one of invoiced,due,paid)", "type": "text/plain" }, "disabled": true, "key": "subtotalsdateoption", "value": "paid" }, { "description": { "content": "Invoices modified on or after this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoices modified on or before this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoices with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoices with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Invoice IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,invoiceddate,duedate,companyname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "62225ae0-47bb-43ed-aac2-fe20dccd9fc8", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "invoices" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "number,title,company,status,totals,projectid,invoiceddate,duedate" }, { "description": { "content": "Search by number or title. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by invoice number. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by invoice title. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchtitle", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoice status (This can only be one of draft,submitted,authorised,paid,voided,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "all" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project manager Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Project category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectcategoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date from (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "invoiceddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "invoiceddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Paid date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "paiddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Paid date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "paiddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total minimum", "type": "text/plain" }, "disabled": true, "key": "grandtotalfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total maximum", "type": "text/plain" }, "disabled": true, "key": "grandtotalto", "value": "\u003cstring\u003e" }, { "description": { "content": "Group results by. Returns subtotals per group. (This can only be one of company,project,status,day,week,month,year)", "type": "text/plain" }, "disabled": true, "key": "subtotals", "value": "status" }, { "description": { "content": "Date field for subtotals grouping (This can only be one of invoiced,due,paid)", "type": "text/plain" }, "disabled": true, "key": "subtotalsdateoption", "value": "paid" }, { "description": { "content": "Invoices modified on or after this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoices modified on or before this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoices with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoices with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Invoice IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,invoiceddate,duedate,companyname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "44f13222-e368-40ed-858b-d928374aa381", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "invoices" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "number,title,company,status,totals,projectid,invoiceddate,duedate" }, { "description": { "content": "Search by number or title. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by invoice number. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by invoice title. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchtitle", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoice status (This can only be one of draft,submitted,authorised,paid,voided,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "all" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project manager Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Project category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectcategoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date from (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "invoiceddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoiced date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "invoiceddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "duedatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Due date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "duedateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Paid date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "paiddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Paid date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "paiddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total minimum", "type": "text/plain" }, "disabled": true, "key": "grandtotalfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total maximum", "type": "text/plain" }, "disabled": true, "key": "grandtotalto", "value": "\u003cstring\u003e" }, { "description": { "content": "Group results by. Returns subtotals per group. (This can only be one of company,project,status,day,week,month,year)", "type": "text/plain" }, "disabled": true, "key": "subtotals", "value": "status" }, { "description": { "content": "Date field for subtotals grouping (This can only be one of invoiced,due,paid)", "type": "text/plain" }, "disabled": true, "key": "subtotalsdateoption", "value": "paid" }, { "description": { "content": "Invoices modified on or after this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoices modified on or before this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoices with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Invoices with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Invoice IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,invoiceddate,duedate,companyname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "ece50dc8-89d7-4dfe-8d56-d9fb2086a648", "name": "/projects/:projectid/items", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns items for a project. Supports the same field selection, filtering, sorting, and pagination as GET /projects/items.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/projects/:projectid/items", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "items" ], "query": [ { "description": { "content": "Fields to return (see GET /projects/items for full list)", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,status,priority" }, { "description": { "content": "Deprecated: use name, code, or q+qfields instead. Search by name or code. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by description. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchdescription", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use code or q+qfields instead. Search by code. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact code match", "type": "text/plain" }, "disabled": true, "key": "code", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,code,description)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "code" }, { "description": { "content": "Status filter (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "active" }, { "description": { "content": "Alias for status parameter. (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "deleted" }, { "description": { "content": "Priority filter (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Contact IDs or 'me' or 'unassigned'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts filter mode (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Work Stage ID", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,code,priority,startdate,duedate,completedate,status,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"actualInLabour\": \"\u003cnumber\u003e\",\n \"actualInTotal\": \"\u003cnumber\u003e\",\n \"actualInTotalTax\": \"\u003cnumber\u003e\",\n \"actualOutLabour\": \"\u003cnumber\u003e\",\n \"actualProfit\": \"\u003cnumber\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"contacts\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cstring\u003e\",\n \"createdatetime\": \"\u003cstring\u003e\",\n \"creatorid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"dependenttaskid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"discountRate\": \"\u003cnumber\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScoreId\": \"\u003cinteger\u003e\",\n \"estBillAmount\": \"\u003cnumber\u003e\",\n \"estBillAmountTax\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"impactScoreId\": \"\u003cinteger\u003e\",\n \"importanceScoreId\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inTaxRate\": \"\u003cnumber\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoicedAmount\": \"\u003cnumber\u003e\",\n \"invoicedAmountTax\": \"\u003cnumber\u003e\",\n \"invoiceitemid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"isDiscountPercent\": \"\u003cboolean\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"manualPercentageComplete\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"number\": \"\u003cinteger\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outTaxRate\": \"\u003cnumber\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"paidAmount\": \"\u003cnumber\u003e\",\n \"paidAmountTax\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"phasename\": \"\u003cstring\u003e\",\n \"prerequisiteid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedBillAmount\": \"\u003cnumber\u003e\",\n \"projectedBillAmountTax\": \"\u003cnumber\u003e\",\n \"projectedGrossMargin\": \"\u003cnumber\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"projectedOutLabour\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"projectedTimeManual\": \"\u003cnumber\u003e\",\n \"projectedTimeSpent\": \"\u003cnumber\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"quoteitemid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cinteger\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tags\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"uniquetoken\": \"\u003cstring\u003e\",\n \"urgencyScoreId\": \"\u003cinteger\u003e\"\n },\n {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"actualInLabour\": \"\u003cnumber\u003e\",\n \"actualInTotal\": \"\u003cnumber\u003e\",\n \"actualInTotalTax\": \"\u003cnumber\u003e\",\n \"actualOutLabour\": \"\u003cnumber\u003e\",\n \"actualProfit\": \"\u003cnumber\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"contacts\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cstring\u003e\",\n \"createdatetime\": \"\u003cstring\u003e\",\n \"creatorid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"dependenttaskid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"discountRate\": \"\u003cnumber\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScoreId\": \"\u003cinteger\u003e\",\n \"estBillAmount\": \"\u003cnumber\u003e\",\n \"estBillAmountTax\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"impactScoreId\": \"\u003cinteger\u003e\",\n \"importanceScoreId\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inTaxRate\": \"\u003cnumber\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoicedAmount\": \"\u003cnumber\u003e\",\n \"invoicedAmountTax\": \"\u003cnumber\u003e\",\n \"invoiceitemid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"isDiscountPercent\": \"\u003cboolean\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"manualPercentageComplete\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"number\": \"\u003cinteger\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outTaxRate\": \"\u003cnumber\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"paidAmount\": \"\u003cnumber\u003e\",\n \"paidAmountTax\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"phasename\": \"\u003cstring\u003e\",\n \"prerequisiteid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedBillAmount\": \"\u003cnumber\u003e\",\n \"projectedBillAmountTax\": \"\u003cnumber\u003e\",\n \"projectedGrossMargin\": \"\u003cnumber\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"projectedOutLabour\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"projectedTimeManual\": \"\u003cnumber\u003e\",\n \"projectedTimeSpent\": \"\u003cnumber\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"quoteitemid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cinteger\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tags\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"uniquetoken\": \"\u003cstring\u003e\",\n \"urgencyScoreId\": \"\u003cinteger\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "15d308c8-e8dc-499d-993d-c7f73bda48cf", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "items" ], "query": [ { "description": { "content": "Fields to return (see GET /projects/items for full list)", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,status,priority" }, { "description": { "content": "Deprecated: use name, code, or q+qfields instead. Search by name or code. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by description. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchdescription", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use code or q+qfields instead. Search by code. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact code match", "type": "text/plain" }, "disabled": true, "key": "code", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,code,description)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "code" }, { "description": { "content": "Status filter (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "active" }, { "description": { "content": "Alias for status parameter. (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "deleted" }, { "description": { "content": "Priority filter (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Contact IDs or 'me' or 'unassigned'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts filter mode (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Work Stage ID", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,code,priority,startdate,duedate,completedate,status,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8d75a3e1-9324-419e-b599-d43fbeb5701b", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "items" ], "query": [ { "description": { "content": "Fields to return (see GET /projects/items for full list)", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,status,priority" }, { "description": { "content": "Deprecated: use name, code, or q+qfields instead. Search by name or code. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by description. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchdescription", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use code or q+qfields instead. Search by code. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact code match", "type": "text/plain" }, "disabled": true, "key": "code", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,code,description)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "code" }, { "description": { "content": "Status filter (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "active" }, { "description": { "content": "Alias for status parameter. (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "deleted" }, { "description": { "content": "Priority filter (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Contact IDs or 'me' or 'unassigned'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts filter mode (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Work Stage ID", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,code,priority,startdate,duedate,completedate,status,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a9a8df32-a5c3-458d-9717-f68be0423b30", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "items" ], "query": [ { "description": { "content": "Fields to return (see GET /projects/items for full list)", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,status,priority" }, { "description": { "content": "Deprecated: use name, code, or q+qfields instead. Search by name or code. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by description. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchdescription", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use code or q+qfields instead. Search by code. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact code match", "type": "text/plain" }, "disabled": true, "key": "code", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,code,description)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "code" }, { "description": { "content": "Status filter (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "active" }, { "description": { "content": "Alias for status parameter. (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "deleted" }, { "description": { "content": "Priority filter (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Contact IDs or 'me' or 'unassigned'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts filter mode (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Work Stage ID", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,code,priority,startdate,duedate,completedate,status,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "95023f80-25da-40a7-864f-aab7e2a452a8", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "items" ], "query": [ { "description": { "content": "Fields to return (see GET /projects/items for full list)", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,status,priority" }, { "description": { "content": "Deprecated: use name, code, or q+qfields instead. Search by name or code. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by name. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use q+qfields instead. Search by description. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchdescription", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use code or q+qfields instead. Search by code. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact name match", "type": "text/plain" }, "disabled": true, "key": "name", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact code match", "type": "text/plain" }, "disabled": true, "key": "code", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of name,code,description)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "code" }, { "description": { "content": "Status filter (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "active" }, { "description": { "content": "Alias for status parameter. (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "deleted" }, { "description": { "content": "Priority filter (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "priority", "value": "\u003cstring\u003e" }, { "description": { "content": "Contact IDs or 'me' or 'unassigned'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Contacts filter mode (This can only be one of any,all)", "type": "text/plain" }, "disabled": true, "key": "contactsmode", "value": "any" }, { "description": { "content": "Tag IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "tagid", "value": "\u003cstring\u003e" }, { "description": { "content": "Work Stage ID", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,code,priority,startdate,duedate,completedate,status,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "name" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] }, { "event": [], "id": "c0caaa32-2854-4ef7-80e3-6152e22a726f", "name": "/projects/:projectid/items", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"priority\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"tagids\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Add an Item to a Project.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/projects/:projectid/items", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "items" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2087a12e-0479-4a44-a081-c510aa8f5878", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"priority\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"tagids\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "items" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "809b7a19-72fc-460d-9707-5e58d59b7011", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"priority\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"tagids\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "items" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8834ac91-cb79-40a7-8f08-eb6687c0c05e", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"priority\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"tagids\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "items" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "aae32f81-5588-492d-954d-fa7c1619b762", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"priority\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"tagids\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "items" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] }, { "event": [], "id": "269c4712-c048-4bbd-826f-46b7e5cb6758", "name": "/projects/:projectid/items/:itemid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns full details of a single project item by ID.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/projects/:projectid/items/:itemid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"actualInLabour\": \"\u003cnumber\u003e\",\n \"actualInTotal\": \"\u003cnumber\u003e\",\n \"actualInTotalTax\": \"\u003cnumber\u003e\",\n \"actualOutLabour\": \"\u003cnumber\u003e\",\n \"actualProfit\": \"\u003cnumber\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"contacts\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cstring\u003e\",\n \"createdatetime\": \"\u003cstring\u003e\",\n \"creatorid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"dependenttaskid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"discountRate\": \"\u003cnumber\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScoreId\": \"\u003cinteger\u003e\",\n \"estBillAmount\": \"\u003cnumber\u003e\",\n \"estBillAmountTax\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"impactScoreId\": \"\u003cinteger\u003e\",\n \"importanceScoreId\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inTaxRate\": \"\u003cnumber\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoicedAmount\": \"\u003cnumber\u003e\",\n \"invoicedAmountTax\": \"\u003cnumber\u003e\",\n \"invoiceitemid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"isDiscountPercent\": \"\u003cboolean\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"manualPercentageComplete\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"number\": \"\u003cinteger\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outTaxRate\": \"\u003cnumber\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"paidAmount\": \"\u003cnumber\u003e\",\n \"paidAmountTax\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"phasename\": \"\u003cstring\u003e\",\n \"prerequisiteid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedBillAmount\": \"\u003cnumber\u003e\",\n \"projectedBillAmountTax\": \"\u003cnumber\u003e\",\n \"projectedGrossMargin\": \"\u003cnumber\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"projectedOutLabour\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"projectedTimeManual\": \"\u003cnumber\u003e\",\n \"projectedTimeSpent\": \"\u003cnumber\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"quoteitemid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cinteger\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tags\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"uniquetoken\": \"\u003cstring\u003e\",\n \"urgencyScoreId\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "59b25965-1398-4287-bac9-20c06fbb7356", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "64f0e2f2-203b-4817-9746-a277d25f519f", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "1eb37c5c-4a90-4356-93f0-a7b179513ae8", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d004553e-54de-4f1e-8b1e-c56d8e7ef4c0", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6dc1fd4b-8912-48c4-bdb1-725de02b8158", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "dd677050-0022-4a2a-9df5-c76a085ee642", "name": "/projects/:projectid/items/:itemid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"priority\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"tagids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Updates an existing project item.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/projects/:projectid/items/:itemid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "688d5189-013d-4b4f-b601-42f927b5e626", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"priority\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"tagids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ac14d465-9736-441a-98ce-a71aa168907d", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"priority\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"tagids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9a8b9857-5362-4997-b3c7-d40ebda8ba4d", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"priority\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"tagids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "00d106f2-c03a-4ddb-9dbb-0b5017735734", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"priority\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"tagids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5fe07df1-2148-48e8-bcc4-ca861b55c7ff", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"priority\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"tagids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "32d4f2cf-351e-4293-8a46-ed070269e386", "name": "/projects/:projectid/items/:itemid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Soft-deletes a project item.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/projects/:projectid/items/:itemid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "fd37c20e-1656-4b69-afd6-cfc560a20069", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "18e5afed-1dc5-4200-ba16-3cd1795db537", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "50888ee7-06cb-42dd-8869-3b77c335cc3a", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7d6ff440-b9ae-4d46-90c4-5c4655d7e713", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6bac2205-dc7c-402a-91d8-b81bdaaeab35", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "fb855f70-00ef-4877-9bc1-b01aba7ec448", "name": "/projects/:projectid/items/:itemid/workstages", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns the workstage history for a project item. Access is contact-filtered based on the authenticated user's project membership.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/projects/:projectid/items/:itemid/workstages", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "items", ":itemid", "workstages" ], "query": [ { "description": { "content": "Sort field (This can only be one of setdatetime,id)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "setdatetime" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "desc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"active\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemcontactid\": \"\u003cstring\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"setdatetime\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\"\n },\n {\n \"active\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemcontactid\": \"\u003cstring\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"setdatetime\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3947dd82-6463-4973-a4c5-bea86a854b36", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "items", ":itemid", "workstages" ], "query": [ { "description": { "content": "Sort field (This can only be one of setdatetime,id)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "setdatetime" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "desc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d2b3e9d6-8ce8-4009-8bd0-28a44c95f3c6", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "items", ":itemid", "workstages" ], "query": [ { "description": { "content": "Sort field (This can only be one of setdatetime,id)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "setdatetime" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "desc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f9636ffe-89f1-4c7a-8f46-4a40de5fec70", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "items", ":itemid", "workstages" ], "query": [ { "description": { "content": "Sort field (This can only be one of setdatetime,id)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "setdatetime" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "desc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "883839e0-64ba-480e-bc8b-a3bc6806b0f8", "name": "/projects/:projectid/messages", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Messages for a Project based on the specified filters.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/projects/:projectid/messages", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "messages" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: subject, content, originalmessageid, project, item, date, author, contacts, public, files, replycount, all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "subject,content,originalmessageid,project,item,date,author,contacts,public,files" }, { "description": { "content": "Search by subject. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by contact. Comma-separated Contact IDs, 'me', or 'all'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by item activeworkstate (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Item ID or list of Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Original Message ID - returns messages in the discussion started by this message", "type": "text/plain" }, "disabled": true, "key": "originalmessageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages added on or after this date (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "datefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages added on or before this date (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "dateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Message IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,date,originalmessageid,itemid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "desc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"authoremail\": \"\u003cstring\u003e\",\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorimage\": \"\u003cstring\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"authortype\": \"\u003cstring\u003e\",\n \"contacts\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"files\": \"\u003cstring\u003e\",\n \"filesenabled\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"itemname\": \"\u003cstring\u003e\",\n \"originalmessageid\": \"\u003cinteger\u003e\",\n \"projectcontacts\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectmanagerid\": \"\u003cinteger\u003e\",\n \"projectmanagername\": \"\u003cstring\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"replies\": [\n {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorimage\": \"\u003cstring\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"authortype\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"files\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n },\n {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorimage\": \"\u003cstring\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"authortype\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"files\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n }\n ],\n \"replycount\": \"\u003cinteger\u003e\",\n \"subject\": \"\u003cstring\u003e\"\n },\n {\n \"authoremail\": \"\u003cstring\u003e\",\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorimage\": \"\u003cstring\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"authortype\": \"\u003cstring\u003e\",\n \"contacts\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"files\": \"\u003cstring\u003e\",\n \"filesenabled\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"itemname\": \"\u003cstring\u003e\",\n \"originalmessageid\": \"\u003cinteger\u003e\",\n \"projectcontacts\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectmanagerid\": \"\u003cinteger\u003e\",\n \"projectmanagername\": \"\u003cstring\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"replies\": [\n {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorimage\": \"\u003cstring\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"authortype\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"files\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n },\n {\n \"authorid\": \"\u003cinteger\u003e\",\n \"authorimage\": \"\u003cstring\u003e\",\n \"authorname\": \"\u003cstring\u003e\",\n \"authortype\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"files\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\"\n }\n ],\n \"replycount\": \"\u003cinteger\u003e\",\n \"subject\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6f2ae41a-9ffa-4488-8f50-5576c1ab4b7b", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "messages" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: subject, content, originalmessageid, project, item, date, author, contacts, public, files, replycount, all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "subject,content,originalmessageid,project,item,date,author,contacts,public,files" }, { "description": { "content": "Search by subject. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by contact. Comma-separated Contact IDs, 'me', or 'all'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by item activeworkstate (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Item ID or list of Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Original Message ID - returns messages in the discussion started by this message", "type": "text/plain" }, "disabled": true, "key": "originalmessageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages added on or after this date (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "datefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages added on or before this date (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "dateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Message IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,date,originalmessageid,itemid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "desc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "59734b21-c370-403e-b3c2-beef70f39f26", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "messages" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: subject, content, originalmessageid, project, item, date, author, contacts, public, files, replycount, all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "subject,content,originalmessageid,project,item,date,author,contacts,public,files" }, { "description": { "content": "Search by subject. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by contact. Comma-separated Contact IDs, 'me', or 'all'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by item activeworkstate (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Item ID or list of Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Original Message ID - returns messages in the discussion started by this message", "type": "text/plain" }, "disabled": true, "key": "originalmessageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages added on or after this date (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "datefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages added on or before this date (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "dateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Message IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,date,originalmessageid,itemid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "desc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b9940a52-022e-41ec-b036-425264b26aec", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "messages" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: subject, content, originalmessageid, project, item, date, author, contacts, public, files, replycount, all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "subject,content,originalmessageid,project,item,date,author,contacts,public,files" }, { "description": { "content": "Search by subject. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by contact. Comma-separated Contact IDs, 'me', or 'all'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by item activeworkstate (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Item ID or list of Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Original Message ID - returns messages in the discussion started by this message", "type": "text/plain" }, "disabled": true, "key": "originalmessageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages added on or after this date (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "datefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages added on or before this date (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "dateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Message IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,date,originalmessageid,itemid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "desc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e5109433-bafd-4015-992b-ca893eb395e4", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "messages" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: subject, content, originalmessageid, project, item, date, author, contacts, public, files, replycount, all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "subject,content,originalmessageid,project,item,date,author,contacts,public,files" }, { "description": { "content": "Search by subject. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by contact. Comma-separated Contact IDs, 'me', or 'all'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by item activeworkstate (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Item ID or list of Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Original Message ID - returns messages in the discussion started by this message", "type": "text/plain" }, "disabled": true, "key": "originalmessageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages added on or after this date (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "datefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages added on or before this date (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "dateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Message IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,date,originalmessageid,itemid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "desc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f7fa408a-c416-498d-80eb-875d83553d66", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "messages" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: subject, content, originalmessageid, project, item, date, author, contacts, public, files, replycount, all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "subject,content,originalmessageid,project,item,date,author,contacts,public,files" }, { "description": { "content": "Search by subject. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by contact. Comma-separated Contact IDs, 'me', or 'all'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by item activeworkstate (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Item ID or list of Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Original Message ID - returns messages in the discussion started by this message", "type": "text/plain" }, "disabled": true, "key": "originalmessageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages added on or after this date (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "datefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages added on or before this date (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "dateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Messages with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Message IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,date,originalmessageid,itemid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "desc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "b7736eb1-dc81-4ce8-9ab1-444c3f206b37", "name": "/projects/:projectid/messages", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"content\": \"\u003cstring\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"subject\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Creates a Message for a Project.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/projects/:projectid/messages", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "messages" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3680344d-bc52-42e8-b30e-b58955961970", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"content\": \"\u003cstring\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"subject\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "messages" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f3522004-814f-40cb-b047-19db45532680", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"content\": \"\u003cstring\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"subject\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "messages" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4196ea56-2220-4322-bf35-d6f73de76405", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"content\": \"\u003cstring\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"subject\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "messages" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6871f47a-0a9e-4f1f-a0cf-21139ca22fe0", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"content\": \"\u003cstring\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"subject\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "messages" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6521899f-40df-40b6-b097-7607870fdc2c", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"content\": \"\u003cstring\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"subject\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "messages" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "64bda40e-3575-4016-9bef-d61ecdc3e349", "name": "/projects/:projectid/order", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"placeafterid\": \"\u003cinteger\u003e\",\n \"placebeforeid\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Moves a project before or after another project using sortorder. Provide exactly one of placeafterid or placebeforeid.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/projects/:projectid/order", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "order" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5a5ee3d2-09de-4d80-a1e7-1c5280c2f5f0", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"placeafterid\": \"\u003cinteger\u003e\",\n \"placebeforeid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "order" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b1fa1c93-628a-4df3-8027-389662cfe6c5", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"placeafterid\": \"\u003cinteger\u003e\",\n \"placebeforeid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "order" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "69cc3e6d-5054-4d54-8a27-16c9253804a7", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"placeafterid\": \"\u003cinteger\u003e\",\n \"placebeforeid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "order" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "153dfd5a-b245-44cb-b9fb-990c69142bdd", "name": "/projects/:projectid/phases", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns phases (item collections) for a project with aggregated financial and progress metrics. Access is contact-filtered based on the authenticated user's project membership.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/projects/:projectid/phases", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "phases" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,projectid,parentid,timeallocated,timespent,estBillAmount,billAmount" }, { "description": { "content": "Search by phase name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to phases with a specific parent phase ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder,startdate,duedate)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" }, { "description": { "content": "Phases modified on or after this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Phases modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"actualInLabour\": \"\u003cnumber\u003e\",\n \"actualInTotal\": \"\u003cnumber\u003e\",\n \"actualInTotalTax\": \"\u003cnumber\u003e\",\n \"actualOutLabour\": \"\u003cnumber\u003e\",\n \"actualProfit\": \"\u003cnumber\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"datecreated\": \"\u003cstring\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"estBillAmount\": \"\u003cnumber\u003e\",\n \"estBillAmountTax\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoicedAmount\": \"\u003cnumber\u003e\",\n \"invoicedAmountTax\": \"\u003cnumber\u003e\",\n \"invoiceitemcollectionid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"itemsActive\": \"\u003cinteger\u003e\",\n \"itemsCompleted\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"paidAmount\": \"\u003cnumber\u003e\",\n \"paidAmountTax\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedBillAmount\": \"\u003cnumber\u003e\",\n \"projectedBillAmountTax\": \"\u003cnumber\u003e\",\n \"projectedGrossMargin\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"projectedTimeManual\": \"\u003cnumber\u003e\",\n \"projectedTimeSpent\": \"\u003cnumber\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"quoteitemcollectionid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n },\n {\n \"actualInLabour\": \"\u003cnumber\u003e\",\n \"actualInTotal\": \"\u003cnumber\u003e\",\n \"actualInTotalTax\": \"\u003cnumber\u003e\",\n \"actualOutLabour\": \"\u003cnumber\u003e\",\n \"actualProfit\": \"\u003cnumber\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"datecreated\": \"\u003cstring\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"estBillAmount\": \"\u003cnumber\u003e\",\n \"estBillAmountTax\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoicedAmount\": \"\u003cnumber\u003e\",\n \"invoicedAmountTax\": \"\u003cnumber\u003e\",\n \"invoiceitemcollectionid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"itemsActive\": \"\u003cinteger\u003e\",\n \"itemsCompleted\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"paidAmount\": \"\u003cnumber\u003e\",\n \"paidAmountTax\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedBillAmount\": \"\u003cnumber\u003e\",\n \"projectedBillAmountTax\": \"\u003cnumber\u003e\",\n \"projectedGrossMargin\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"projectedTimeManual\": \"\u003cnumber\u003e\",\n \"projectedTimeSpent\": \"\u003cnumber\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"quoteitemcollectionid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e9bb7093-f53f-44f7-9d4f-2d8998b794e5", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "phases" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,projectid,parentid,timeallocated,timespent,estBillAmount,billAmount" }, { "description": { "content": "Search by phase name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to phases with a specific parent phase ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder,startdate,duedate)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" }, { "description": { "content": "Phases modified on or after this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Phases modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "37af540e-88a9-4148-b223-b08be01f8235", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "phases" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,projectid,parentid,timeallocated,timespent,estBillAmount,billAmount" }, { "description": { "content": "Search by phase name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to phases with a specific parent phase ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder,startdate,duedate)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" }, { "description": { "content": "Phases modified on or after this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Phases modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b64d0fd2-4e9e-4a39-afca-727bceee2c1d", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "phases" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,projectid,parentid,timeallocated,timespent,estBillAmount,billAmount" }, { "description": { "content": "Search by phase name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to phases with a specific parent phase ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder,startdate,duedate)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" }, { "description": { "content": "Phases modified on or after this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Phases modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3738f5a4-e69a-4a3f-a577-d1c6528df3ec", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "phases" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,projectid,parentid,timeallocated,timespent,estBillAmount,billAmount" }, { "description": { "content": "Search by phase name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to phases with a specific parent phase ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder,startdate,duedate)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" }, { "description": { "content": "Phases modified on or after this date (UTC). ISO8601 or relative (12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Phases modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] }, { "event": [], "id": "962909b3-5802-40f3-a813-fcf4013e3e0b", "name": "/projects/:projectid/phases", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"duedate\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Add a Phase (Item Collection) to a Project.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/projects/:projectid/phases", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "phases" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e4b4fc25-9d0f-4b9e-b4ce-f1df8be93ed0", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"duedate\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "phases" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6eaef75b-714a-48fb-845d-6a906a67f20a", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"duedate\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "phases" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7671c7b0-06bf-47aa-9857-f81d971ab1b6", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"duedate\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "phases" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3d448b53-3120-439e-92f8-570dbec073e4", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"duedate\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "phases" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] }, { "event": [], "id": "3e311917-1cbe-443b-8c87-2470fc8df418", "name": "/projects/:projectid/phases/:phaseid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns full details of a single project phase (item collection) by ID. Includes all financial, time, billing, and progress fields.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/projects/:projectid/phases/:phaseid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"actualInLabour\": \"\u003cnumber\u003e\",\n \"actualInTotal\": \"\u003cnumber\u003e\",\n \"actualInTotalTax\": \"\u003cnumber\u003e\",\n \"actualOutLabour\": \"\u003cnumber\u003e\",\n \"actualProfit\": \"\u003cnumber\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"datecreated\": \"\u003cstring\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"estBillAmount\": \"\u003cnumber\u003e\",\n \"estBillAmountTax\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoicedAmount\": \"\u003cnumber\u003e\",\n \"invoicedAmountTax\": \"\u003cnumber\u003e\",\n \"invoiceitemcollectionid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"itemsActive\": \"\u003cinteger\u003e\",\n \"itemsCompleted\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"paidAmount\": \"\u003cnumber\u003e\",\n \"paidAmountTax\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedBillAmount\": \"\u003cnumber\u003e\",\n \"projectedBillAmountTax\": \"\u003cnumber\u003e\",\n \"projectedGrossMargin\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"projectedTimeManual\": \"\u003cnumber\u003e\",\n \"projectedTimeSpent\": \"\u003cnumber\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"quoteitemcollectionid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8d2f7588-fd92-427d-b68b-99ccbd656dbd", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a88b7aa7-4dd9-4817-b5ab-d97b45594c59", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "fa15fe95-82b8-4e00-85b8-2c2c09fcfa25", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5d92b1da-63ed-44d8-b4ad-b56dd06966bf", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "98ba2afb-36a8-44d2-bceb-0ad09941e12d", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "0b06b2f8-55a9-45ca-bb0f-ab197ffc6411", "name": "/projects/:projectid/phases/:phaseid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"duedate\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Updates an existing project phase.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/projects/:projectid/phases/:phaseid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f2fed4f1-171f-47c2-ba3e-2004fcc50119", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"duedate\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "08331c68-ca71-4809-89e2-488ad1d6f23d", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"duedate\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7f1b9865-a7a8-45db-ae69-6a7fa5291470", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"duedate\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "1f68f49d-ce52-4a7b-8136-ea521da393ad", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"duedate\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ddc04df9-473a-42b3-aa50-fec3d194b084", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"duedate\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "dbf788f7-e4c4-46f2-831a-29e79dbc7eb0", "name": "/projects/:projectid/phases/:phaseid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Soft-deletes a project phase and its associated items.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/projects/:projectid/phases/:phaseid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3d599b50-d469-4872-ab93-6604661b27b8", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b07f6d4b-6226-42a3-bffd-08552ff81502", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c1c6f420-9d2e-4278-ab97-913cea858528", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ea495f84-1a30-4ffa-ae30-ba7911d3f772", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "0ac0165b-2218-4f7c-a6f1-9121a2295dce", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "03bfa71c-4a26-4c0e-bd33-5550b1bc7323", "name": "/projects/:projectid/projectnotes", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Project Notes for a Project based on the specified filters.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/projects/:projectid/projectnotes", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "projectnotes" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: title, content, project, company, lastmodified, all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "title,content" }, { "description": { "content": "Search by title. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Notes with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Notes with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Note IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,title)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"title\": \"\u003cstring\u003e\"\n },\n {\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"title\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "bda40fb4-4093-4e9e-94ad-4a95fe690458", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "projectnotes" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: title, content, project, company, lastmodified, all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "title,content" }, { "description": { "content": "Search by title. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Notes with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Notes with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Note IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,title)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "bb91c298-0856-4d95-a851-a3fde264ef43", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "projectnotes" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: title, content, project, company, lastmodified, all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "title,content" }, { "description": { "content": "Search by title. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Notes with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Notes with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Note IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,title)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5266cd7c-4966-49e7-b915-64eb66b756a8", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "projectnotes" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: title, content, project, company, lastmodified, all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "title,content" }, { "description": { "content": "Search by title. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Notes with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Notes with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Note IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,title)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9b361b9d-878c-4ea5-a5d8-c25a28c5b53f", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "projectnotes" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: title, content, project, company, lastmodified, all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "title,content" }, { "description": { "content": "Search by title. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Notes with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Notes with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Note IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,title)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4b671785-11c6-41f1-8bf5-d8272838b8fd", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "projectnotes" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: title, content, project, company, lastmodified, all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "title,content" }, { "description": { "content": "Search by title. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Notes with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Notes with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Note IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,title)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "107f76c7-726a-4b8c-a7cc-3d9dff4a1b9d", "name": "/projects/:projectid/projectnotes", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"content\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Creates a Project Note for a Project.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/projects/:projectid/projectnotes", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "projectnotes" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3ab5dae0-8360-48f9-9613-26e30b8b7ff0", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"content\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "projectnotes" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9679e987-04ca-4847-994c-95eddecbf64e", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"content\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "projectnotes" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "eb5ae088-9042-4df7-bd43-284f01b6be28", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"content\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "projectnotes" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7f2d0a1d-d487-48e1-8f41-c8f76bb838fe", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"content\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "projectnotes" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5696c83f-6565-453e-95b0-86c3c72a0bea", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"content\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "projectnotes" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "6b05a586-3b81-4487-aa95-bf9b4ac227ae", "name": "/projects/:projectid/projectnotes/:noteid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns details of a single Project Note for a Project.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/projects/:projectid/projectnotes/:noteid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "projectnotes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"content\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"title\": \"\u003cstring\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "26d4700f-1b55-4513-98ef-c4a212c4d46b", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "projectnotes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6ff96933-66bd-43c0-a4ec-a49be9b2e0a8", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "projectnotes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b99370cf-cfa5-4b3e-ac9c-1c19792030ec", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "projectnotes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "bf1c47b7-cf33-4fbd-9f24-a19170eb35f8", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "projectnotes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8795c252-2aa6-4730-889a-331ef0df788b", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "projectnotes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "53ed69d9-ee52-4458-b35e-bdcc9d02f78c", "name": "/projects/:projectid/projectnotes/:noteid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"content\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Updates a Project Note for a Project.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/projects/:projectid/projectnotes/:noteid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "projectnotes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c2d02f9f-020d-4d94-9657-c9ab2a8291cb", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"content\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "projectnotes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4a879b89-a485-4e14-825b-c7b6612da7b7", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"content\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "projectnotes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f3cc8721-2d9b-4a19-92db-c4cfb079cc8a", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"content\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "projectnotes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2a904ef2-d3fd-4867-8643-e0490373b9d8", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"content\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "projectnotes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a2b719a6-a168-4ea0-a007-bf41ac27829b", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"content\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "projectnotes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "2343b882-4d0b-45d5-8f46-dafb59f44710", "name": "/projects/:projectid/projectnotes/:noteid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Deletes a Project Note from a Project.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/projects/:projectid/projectnotes/:noteid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "projectnotes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "25e84fba-f768-45dd-bc46-a377f6d0cfb5", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "projectnotes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b0956fe5-6bfd-4d7a-abde-d11e43e36504", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "projectnotes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4d376d48-d4a4-451f-b2e4-2403839b15aa", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "projectnotes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ec504fa7-33f4-476d-b97f-389803a0f3b2", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "projectnotes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4bac9bd3-8133-4f2d-bf5a-82bec85b1d28", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "projectnotes", ":noteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Note ID", "type": "text/plain" }, "disabled": false, "key": "noteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "96043492-52c8-48de-9c1c-699db5275335", "name": "/projects/:projectid/quotes", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Quotes for a Project based on the specified filters.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/projects/:projectid/quotes", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "quotes" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "number,title,company,status,totals,quoteddate" }, { "description": { "content": "Search by number or title. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by quote number. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by quote title. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchtitle", "value": "\u003cstring\u003e" }, { "description": { "content": "Quote status (This can only be one of pending,sent,accepted,addedtoproject,declined,expired,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "sent" }, { "description": { "content": "Quote type (This can only be one of estimate,quote,all)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "quote" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project manager Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectcategoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Quoted date from (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "quoteddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Quoted date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "quoteddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Approved date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "approveddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Approved date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "approveddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Valid to date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "validtodatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Valid to date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "validtodateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total minimum", "type": "text/plain" }, "disabled": true, "key": "grandtotalfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total maximum", "type": "text/plain" }, "disabled": true, "key": "grandtotalto", "value": "\u003cstring\u003e" }, { "description": { "content": "Group results by. Returns subtotals per group. (This can only be one of company,project,status,day,week,month,year)", "type": "text/plain" }, "disabled": true, "key": "subtotals", "value": "status" }, { "description": { "content": "Date field for subtotals grouping (This can only be one of quoted,approved)", "type": "text/plain" }, "disabled": true, "key": "subtotalsdateoption", "value": "approved" }, { "description": { "content": "Quotes modified on or after this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Quotes modified on or before this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Quotes with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Quotes with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Quote IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,quoteddate,validtodate,companyname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"approveddate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"clientcontactname\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"customfieldname\": \"\u003cstring\u003e\",\n \"customfieldvalue\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"emaileddate\": \"\u003cstring\u003e\",\n \"emailedto\": \"\u003cstring\u003e\",\n \"emailedtoclient\": \"\u003cboolean\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"pagetitle\": \"\u003cstring\u003e\",\n \"phases\": [\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\"\n }\n ],\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n },\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\"\n }\n ],\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n }\n ],\n \"projectid\": \"\u003cinteger\u003e\",\n \"quotedate\": \"\u003cstring\u003e\",\n \"quotedby\": \"\u003cstring\u003e\",\n \"showcostbreakdown\": \"\u003cboolean\u003e\",\n \"showitemdescription\": \"\u003cboolean\u003e\",\n \"showphases\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"taxable\": \"\u003cboolean\u003e\",\n \"taxrate\": \"\u003cnumber\u003e\",\n \"taxtotal\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"validdate\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n },\n {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"approveddate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"clientcontactname\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"customfieldname\": \"\u003cstring\u003e\",\n \"customfieldvalue\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"emaileddate\": \"\u003cstring\u003e\",\n \"emailedto\": \"\u003cstring\u003e\",\n \"emailedtoclient\": \"\u003cboolean\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"pagetitle\": \"\u003cstring\u003e\",\n \"phases\": [\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\"\n }\n ],\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n },\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\"\n }\n ],\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n }\n ],\n \"projectid\": \"\u003cinteger\u003e\",\n \"quotedate\": \"\u003cstring\u003e\",\n \"quotedby\": \"\u003cstring\u003e\",\n \"showcostbreakdown\": \"\u003cboolean\u003e\",\n \"showitemdescription\": \"\u003cboolean\u003e\",\n \"showphases\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"taxable\": \"\u003cboolean\u003e\",\n \"taxrate\": \"\u003cnumber\u003e\",\n \"taxtotal\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"validdate\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7964845b-b10f-4e25-878a-ed2db35383e9", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "quotes" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "number,title,company,status,totals,quoteddate" }, { "description": { "content": "Search by number or title. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by quote number. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by quote title. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchtitle", "value": "\u003cstring\u003e" }, { "description": { "content": "Quote status (This can only be one of pending,sent,accepted,addedtoproject,declined,expired,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "sent" }, { "description": { "content": "Quote type (This can only be one of estimate,quote,all)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "quote" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project manager Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectcategoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Quoted date from (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "quoteddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Quoted date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "quoteddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Approved date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "approveddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Approved date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "approveddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Valid to date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "validtodatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Valid to date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "validtodateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total minimum", "type": "text/plain" }, "disabled": true, "key": "grandtotalfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total maximum", "type": "text/plain" }, "disabled": true, "key": "grandtotalto", "value": "\u003cstring\u003e" }, { "description": { "content": "Group results by. Returns subtotals per group. (This can only be one of company,project,status,day,week,month,year)", "type": "text/plain" }, "disabled": true, "key": "subtotals", "value": "status" }, { "description": { "content": "Date field for subtotals grouping (This can only be one of quoted,approved)", "type": "text/plain" }, "disabled": true, "key": "subtotalsdateoption", "value": "approved" }, { "description": { "content": "Quotes modified on or after this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Quotes modified on or before this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Quotes with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Quotes with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Quote IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,quoteddate,validtodate,companyname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2b5bd4fe-9c00-4591-97d0-af5a4f2bbfbc", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "quotes" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "number,title,company,status,totals,quoteddate" }, { "description": { "content": "Search by number or title. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by quote number. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by quote title. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchtitle", "value": "\u003cstring\u003e" }, { "description": { "content": "Quote status (This can only be one of pending,sent,accepted,addedtoproject,declined,expired,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "sent" }, { "description": { "content": "Quote type (This can only be one of estimate,quote,all)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "quote" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project manager Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectcategoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Quoted date from (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "quoteddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Quoted date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "quoteddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Approved date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "approveddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Approved date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "approveddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Valid to date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "validtodatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Valid to date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "validtodateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total minimum", "type": "text/plain" }, "disabled": true, "key": "grandtotalfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total maximum", "type": "text/plain" }, "disabled": true, "key": "grandtotalto", "value": "\u003cstring\u003e" }, { "description": { "content": "Group results by. Returns subtotals per group. (This can only be one of company,project,status,day,week,month,year)", "type": "text/plain" }, "disabled": true, "key": "subtotals", "value": "status" }, { "description": { "content": "Date field for subtotals grouping (This can only be one of quoted,approved)", "type": "text/plain" }, "disabled": true, "key": "subtotalsdateoption", "value": "approved" }, { "description": { "content": "Quotes modified on or after this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Quotes modified on or before this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Quotes with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Quotes with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Quote IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,quoteddate,validtodate,companyname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "cb602cac-da3d-460b-9680-c18d74cd9f95", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "quotes" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "number,title,company,status,totals,quoteddate" }, { "description": { "content": "Search by number or title. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by quote number. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by quote title. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchtitle", "value": "\u003cstring\u003e" }, { "description": { "content": "Quote status (This can only be one of pending,sent,accepted,addedtoproject,declined,expired,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "sent" }, { "description": { "content": "Quote type (This can only be one of estimate,quote,all)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "quote" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project manager Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectcategoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Quoted date from (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "quoteddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Quoted date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "quoteddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Approved date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "approveddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Approved date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "approveddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Valid to date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "validtodatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Valid to date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "validtodateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total minimum", "type": "text/plain" }, "disabled": true, "key": "grandtotalfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total maximum", "type": "text/plain" }, "disabled": true, "key": "grandtotalto", "value": "\u003cstring\u003e" }, { "description": { "content": "Group results by. Returns subtotals per group. (This can only be one of company,project,status,day,week,month,year)", "type": "text/plain" }, "disabled": true, "key": "subtotals", "value": "status" }, { "description": { "content": "Date field for subtotals grouping (This can only be one of quoted,approved)", "type": "text/plain" }, "disabled": true, "key": "subtotalsdateoption", "value": "approved" }, { "description": { "content": "Quotes modified on or after this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Quotes modified on or before this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Quotes with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Quotes with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Quote IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,quoteddate,validtodate,companyname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e6d035fe-0a7c-4462-a98b-8c70a6e35277", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "quotes" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "number,title,company,status,totals,quoteddate" }, { "description": { "content": "Search by number or title. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by quote number. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by quote title. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchtitle", "value": "\u003cstring\u003e" }, { "description": { "content": "Quote status (This can only be one of pending,sent,accepted,addedtoproject,declined,expired,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "sent" }, { "description": { "content": "Quote type (This can only be one of estimate,quote,all)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "quote" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project manager Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectcategoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Quoted date from (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "quoteddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Quoted date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "quoteddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Approved date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "approveddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Approved date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "approveddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Valid to date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "validtodatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Valid to date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "validtodateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total minimum", "type": "text/plain" }, "disabled": true, "key": "grandtotalfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total maximum", "type": "text/plain" }, "disabled": true, "key": "grandtotalto", "value": "\u003cstring\u003e" }, { "description": { "content": "Group results by. Returns subtotals per group. (This can only be one of company,project,status,day,week,month,year)", "type": "text/plain" }, "disabled": true, "key": "subtotals", "value": "status" }, { "description": { "content": "Date field for subtotals grouping (This can only be one of quoted,approved)", "type": "text/plain" }, "disabled": true, "key": "subtotalsdateoption", "value": "approved" }, { "description": { "content": "Quotes modified on or after this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Quotes modified on or before this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Quotes with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Quotes with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Quote IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,quoteddate,validtodate,companyname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "94e613bd-5510-4fc5-af0d-b806d3a2c962", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "quotes" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "number,title,company,status,totals,quoteddate" }, { "description": { "content": "Search by number or title. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by quote number. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by quote title. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchtitle", "value": "\u003cstring\u003e" }, { "description": { "content": "Quote status (This can only be one of pending,sent,accepted,addedtoproject,declined,expired,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "sent" }, { "description": { "content": "Quote type (This can only be one of estimate,quote,all)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "quote" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project manager Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectcategoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Quoted date from (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "quoteddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Quoted date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "quoteddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Approved date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "approveddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Approved date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "approveddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Valid to date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "validtodatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Valid to date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "validtodateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total minimum", "type": "text/plain" }, "disabled": true, "key": "grandtotalfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total maximum", "type": "text/plain" }, "disabled": true, "key": "grandtotalto", "value": "\u003cstring\u003e" }, { "description": { "content": "Group results by. Returns subtotals per group. (This can only be one of company,project,status,day,week,month,year)", "type": "text/plain" }, "disabled": true, "key": "subtotals", "value": "status" }, { "description": { "content": "Date field for subtotals grouping (This can only be one of quoted,approved)", "type": "text/plain" }, "disabled": true, "key": "subtotalsdateoption", "value": "approved" }, { "description": { "content": "Quotes modified on or after this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Quotes modified on or before this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Quotes with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Quotes with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Quote IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,quoteddate,validtodate,companyname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "e906d77b-6179-4e55-bb44-e3d1cc05a9dd", "name": "/projects/:projectid/reactivate", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Reactivates a Project. Note: this does not reactivate Tasks within the Project.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/projects/:projectid/reactivate", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "reactivate" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "943c6497-eec3-42ce-bd65-eb557a8a68fc", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "reactivate" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e3be5e01-e502-457f-b0dd-106b958082d9", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "reactivate" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "038a9161-735a-457a-ba2c-488b287fea44", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "reactivate" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "1a6dd6de-5841-4d59-9e6d-85aa7ea805fb", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "reactivate" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8aee1abb-1e50-4360-bd66-e0bf1086ba07", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "reactivate" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "66eb4d3b-2767-48b7-bbe5-aa5a7ea3b124", "name": "/projects/:projectid/settings", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns the settings for a single Project, including client access, task visibility, and notification preferences.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/projects/:projectid/settings", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "settings" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientviewalltasks\": \"\u003cboolean\u003e\",\n \"clientviewtime\": \"\u003cboolean\u003e\",\n \"middlecontainerorder\": \"\u003cstring\u003e\",\n \"notification\": \"\u003cboolean\u003e\",\n \"rightcontainerorder\": \"\u003cstring\u003e\",\n \"staffviewalltasks\": \"\u003cboolean\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "0de3560d-c3a3-4761-9e2c-310a6cbf2707", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "settings" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3a2977a7-4aca-4d08-9218-837fa53f9ee8", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "settings" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c1b7272a-6d4c-45f0-bf6e-2c85e3f8a12f", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "settings" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "09c3dd36-8296-46a0-9671-37f70fc7d312", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "settings" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7b18286d-cca9-4dfe-9387-6f8477765f80", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "settings" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "042cab3e-d8e3-4e4e-b5ee-914ec3b3e7b3", "name": "/projects/:projectid/settings", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientviewalltasks\": \"\u003cboolean\u003e\",\n \"clientviewtime\": \"\u003cboolean\u003e\",\n \"middlecontainerorder\": \"\u003cstring\u003e\",\n \"notification\": \"\u003cboolean\u003e\",\n \"rightcontainerorder\": \"\u003cstring\u003e\",\n \"staffviewalltasks\": \"\u003cboolean\u003e\"\n}" }, "description": { "content": "Updates the settings for a Project, including client access, task visibility, and notification preferences.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/projects/:projectid/settings", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "settings" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "71ba1e09-9b9e-44f9-8a65-77605270f2e4", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientviewalltasks\": \"\u003cboolean\u003e\",\n \"clientviewtime\": \"\u003cboolean\u003e\",\n \"middlecontainerorder\": \"\u003cstring\u003e\",\n \"notification\": \"\u003cboolean\u003e\",\n \"rightcontainerorder\": \"\u003cstring\u003e\",\n \"staffviewalltasks\": \"\u003cboolean\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "settings" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "67b889af-9618-4f5e-9722-69303d5c1892", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientviewalltasks\": \"\u003cboolean\u003e\",\n \"clientviewtime\": \"\u003cboolean\u003e\",\n \"middlecontainerorder\": \"\u003cstring\u003e\",\n \"notification\": \"\u003cboolean\u003e\",\n \"rightcontainerorder\": \"\u003cstring\u003e\",\n \"staffviewalltasks\": \"\u003cboolean\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "settings" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c76e5036-ae9f-4d78-953d-ab5d17791914", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientviewalltasks\": \"\u003cboolean\u003e\",\n \"clientviewtime\": \"\u003cboolean\u003e\",\n \"middlecontainerorder\": \"\u003cstring\u003e\",\n \"notification\": \"\u003cboolean\u003e\",\n \"rightcontainerorder\": \"\u003cstring\u003e\",\n \"staffviewalltasks\": \"\u003cboolean\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "settings" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "595f2899-560b-47e8-9d42-bcc564b14706", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientviewalltasks\": \"\u003cboolean\u003e\",\n \"clientviewtime\": \"\u003cboolean\u003e\",\n \"middlecontainerorder\": \"\u003cstring\u003e\",\n \"notification\": \"\u003cboolean\u003e\",\n \"rightcontainerorder\": \"\u003cstring\u003e\",\n \"staffviewalltasks\": \"\u003cboolean\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "settings" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "07711414-383a-4682-8f74-46737fc82aff", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientviewalltasks\": \"\u003cboolean\u003e\",\n \"clientviewtime\": \"\u003cboolean\u003e\",\n \"middlecontainerorder\": \"\u003cstring\u003e\",\n \"notification\": \"\u003cboolean\u003e\",\n \"rightcontainerorder\": \"\u003cstring\u003e\",\n \"staffviewalltasks\": \"\u003cboolean\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "settings" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "e940ab63-0d4f-4868-9252-a3a2040e836d", "name": "/projects/:projectid/time", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Time Records for a Project based on the specified filters. Unlike GET /time, no default date range is applied — all time for the project is returned unless trackedfrom/trackedto are specified.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/projects/:projectid/time", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "time" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: contact, item, project, company, dates, timetracked, notes, billable, lastmodified, all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "contact,item,dates,timetracked" }, { "description": { "content": "Contact filter. Comma-separated Contact IDs, 'me', or 'all'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Item ID or list of Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company ID or list of Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project Category ID or list of Category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or after this date. Accepts yyyy-mm-dd or relative: -6d, -1w, -1m, -1y", "type": "text/plain" }, "disabled": true, "key": "trackedfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or before this date. Accepts yyyy-mm-dd or relative: +0d, +1w", "type": "text/plain" }, "disabled": true, "key": "trackedto", "value": "\u003cstring\u003e" }, { "description": { "content": "Billable filter (This can only be one of billable,nonbillable,all)", "type": "text/plain" }, "disabled": true, "key": "billable", "value": "all" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Filter by item activeworkstate (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Search by notes. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "searchnotes", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by item name. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "searchitem", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or after this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Time Record IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,date,itemid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"accountedfor\": \"\u003cboolean\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"contactname\": \"\u003cstring\u003e\",\n \"endtime\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"itemname\": \"\u003cstring\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"notes\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeallocationid\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n },\n {\n \"accountedfor\": \"\u003cboolean\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"contactname\": \"\u003cstring\u003e\",\n \"endtime\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"itemname\": \"\u003cstring\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"notes\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeallocationid\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "675630cb-cb13-4637-9240-b74ab01fa84c", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "time" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: contact, item, project, company, dates, timetracked, notes, billable, lastmodified, all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "contact,item,dates,timetracked" }, { "description": { "content": "Contact filter. Comma-separated Contact IDs, 'me', or 'all'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Item ID or list of Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company ID or list of Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project Category ID or list of Category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or after this date. Accepts yyyy-mm-dd or relative: -6d, -1w, -1m, -1y", "type": "text/plain" }, "disabled": true, "key": "trackedfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or before this date. Accepts yyyy-mm-dd or relative: +0d, +1w", "type": "text/plain" }, "disabled": true, "key": "trackedto", "value": "\u003cstring\u003e" }, { "description": { "content": "Billable filter (This can only be one of billable,nonbillable,all)", "type": "text/plain" }, "disabled": true, "key": "billable", "value": "all" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Filter by item activeworkstate (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Search by notes. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "searchnotes", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by item name. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "searchitem", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or after this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Time Record IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,date,itemid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "1f8c5443-ec34-4a06-9e8f-d706942ac1a6", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "time" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: contact, item, project, company, dates, timetracked, notes, billable, lastmodified, all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "contact,item,dates,timetracked" }, { "description": { "content": "Contact filter. Comma-separated Contact IDs, 'me', or 'all'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Item ID or list of Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company ID or list of Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project Category ID or list of Category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or after this date. Accepts yyyy-mm-dd or relative: -6d, -1w, -1m, -1y", "type": "text/plain" }, "disabled": true, "key": "trackedfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or before this date. Accepts yyyy-mm-dd or relative: +0d, +1w", "type": "text/plain" }, "disabled": true, "key": "trackedto", "value": "\u003cstring\u003e" }, { "description": { "content": "Billable filter (This can only be one of billable,nonbillable,all)", "type": "text/plain" }, "disabled": true, "key": "billable", "value": "all" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Filter by item activeworkstate (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Search by notes. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "searchnotes", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by item name. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "searchitem", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or after this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Time Record IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,date,itemid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2aa17e39-1f5f-44bb-9d32-28526d3c65b1", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "time" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: contact, item, project, company, dates, timetracked, notes, billable, lastmodified, all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "contact,item,dates,timetracked" }, { "description": { "content": "Contact filter. Comma-separated Contact IDs, 'me', or 'all'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Item ID or list of Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company ID or list of Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project Category ID or list of Category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or after this date. Accepts yyyy-mm-dd or relative: -6d, -1w, -1m, -1y", "type": "text/plain" }, "disabled": true, "key": "trackedfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or before this date. Accepts yyyy-mm-dd or relative: +0d, +1w", "type": "text/plain" }, "disabled": true, "key": "trackedto", "value": "\u003cstring\u003e" }, { "description": { "content": "Billable filter (This can only be one of billable,nonbillable,all)", "type": "text/plain" }, "disabled": true, "key": "billable", "value": "all" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Filter by item activeworkstate (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Search by notes. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "searchnotes", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by item name. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "searchitem", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or after this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Time Record IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,date,itemid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8aad2a59-301f-40a3-bdd1-a3aa3fb87b06", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "time" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: contact, item, project, company, dates, timetracked, notes, billable, lastmodified, all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "contact,item,dates,timetracked" }, { "description": { "content": "Contact filter. Comma-separated Contact IDs, 'me', or 'all'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Item ID or list of Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company ID or list of Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project Category ID or list of Category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or after this date. Accepts yyyy-mm-dd or relative: -6d, -1w, -1m, -1y", "type": "text/plain" }, "disabled": true, "key": "trackedfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or before this date. Accepts yyyy-mm-dd or relative: +0d, +1w", "type": "text/plain" }, "disabled": true, "key": "trackedto", "value": "\u003cstring\u003e" }, { "description": { "content": "Billable filter (This can only be one of billable,nonbillable,all)", "type": "text/plain" }, "disabled": true, "key": "billable", "value": "all" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Filter by item activeworkstate (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Search by notes. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "searchnotes", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by item name. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "searchitem", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or after this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Time Record IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,date,itemid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "08a72b7f-b163-431b-98a9-42cd1b46580c", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "time" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: contact, item, project, company, dates, timetracked, notes, billable, lastmodified, all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "contact,item,dates,timetracked" }, { "description": { "content": "Contact filter. Comma-separated Contact IDs, 'me', or 'all'", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Item ID or list of Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company ID or list of Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project Category ID or list of Category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or after this date. Accepts yyyy-mm-dd or relative: -6d, -1w, -1m, -1y", "type": "text/plain" }, "disabled": true, "key": "trackedfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or before this date. Accepts yyyy-mm-dd or relative: +0d, +1w", "type": "text/plain" }, "disabled": true, "key": "trackedto", "value": "\u003cstring\u003e" }, { "description": { "content": "Billable filter (This can only be one of billable,nonbillable,all)", "type": "text/plain" }, "disabled": true, "key": "billable", "value": "all" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Filter by item activeworkstate (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Search by notes. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "searchnotes", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by item name. Use ! prefix for negation.", "type": "text/plain" }, "disabled": true, "key": "searchitem", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or after this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date (UTC, ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Time Record IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,date,itemid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "38ad02aa-79bd-4be2-8df2-a0a5889c5ca6", "name": "/projects/:projectid/timeallocation", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Time Allocations for a Project based on the specified filters.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/projects/:projectid/timeallocation", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "timeallocation" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: contact, item, project, time, labour, all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "contact,item,project,time" }, { "description": { "content": "Contact ID or list of Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "contactid", "value": "\u003cstring\u003e" }, { "description": { "content": "Item ID or list of Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "active" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Allocations with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Allocations with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Time Allocation IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,contactid,itemid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"contactid\": \"\u003cinteger\u003e\",\n \"estinlabour\": \"\u003cnumber\u003e\",\n \"estoutlabour\": \"\u003cnumber\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inlabourprice\": \"\u003cnumber\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"outlabourprice\": \"\u003cnumber\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timebillable\": \"\u003cinteger\u003e\"\n },\n {\n \"contactid\": \"\u003cinteger\u003e\",\n \"estinlabour\": \"\u003cnumber\u003e\",\n \"estoutlabour\": \"\u003cnumber\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inlabourprice\": \"\u003cnumber\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"outlabourprice\": \"\u003cnumber\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timebillable\": \"\u003cinteger\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d627bccd-01d8-4846-af53-13c0c1d2c81a", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "timeallocation" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: contact, item, project, time, labour, all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "contact,item,project,time" }, { "description": { "content": "Contact ID or list of Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "contactid", "value": "\u003cstring\u003e" }, { "description": { "content": "Item ID or list of Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "active" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Allocations with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Allocations with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Time Allocation IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,contactid,itemid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5430500e-9ebb-4c52-a7e4-3f1283e7e7ae", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "timeallocation" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: contact, item, project, time, labour, all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "contact,item,project,time" }, { "description": { "content": "Contact ID or list of Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "contactid", "value": "\u003cstring\u003e" }, { "description": { "content": "Item ID or list of Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "active" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Allocations with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Allocations with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Time Allocation IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,contactid,itemid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d07beffb-1903-4c08-8b02-44d28e72daa7", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "timeallocation" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: contact, item, project, time, labour, all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "contact,item,project,time" }, { "description": { "content": "Contact ID or list of Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "contactid", "value": "\u003cstring\u003e" }, { "description": { "content": "Item ID or list of Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "active" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Allocations with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Allocations with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Time Allocation IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,contactid,itemid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "84d2b32e-5696-49da-9574-4c9e4261155f", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "timeallocation" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: contact, item, project, time, labour, all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "contact,item,project,time" }, { "description": { "content": "Contact ID or list of Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "contactid", "value": "\u003cstring\u003e" }, { "description": { "content": "Item ID or list of Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "active" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Allocations with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Allocations with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Time Allocation IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,contactid,itemid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "60d167b1-465a-4a79-b737-c0abbb07b72a", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "timeallocation" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: contact, item, project, time, labour, all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "contact,item,project,time" }, { "description": { "content": "Contact ID or list of Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "contactid", "value": "\u003cstring\u003e" }, { "description": { "content": "Item ID or list of Item IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "active" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Allocations with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Allocations with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Time Allocation IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,contactid,itemid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "b2e6d35b-f59d-4875-bc53-e1bcdb004df9", "name": "/projects/:projectid/workstage", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Sets the active work stage for a project.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/projects/:projectid/workstage", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "workstage" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3a86dff0-bdf7-454b-bc19-204d7e1db660", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "workstage" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3b22e3b8-ce92-4f87-9e90-c733a31b4098", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "workstage" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "13e14c51-981e-4198-a75f-2a9cbdccd7c9", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "workstage" ], "query": [], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "d6084f90-ad5a-4307-9fb6-475a6c55f7cc", "name": "/projects/:projectid/workstages", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns the workstage history for a project. Access is contact-filtered based on the authenticated user's project membership.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/projects/:projectid/workstages", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "workstages" ], "query": [ { "description": { "content": "Sort field (This can only be one of setdatetime,id)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "setdatetime" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "desc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"active\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"setdatetime\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\"\n },\n {\n \"active\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"setdatetime\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f98b95c2-a11b-4683-b7bf-a86156879a94", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "workstages" ], "query": [ { "description": { "content": "Sort field (This can only be one of setdatetime,id)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "setdatetime" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "desc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "646db268-c95f-4705-8bb8-c6645b7a9457", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "workstages" ], "query": [ { "description": { "content": "Sort field (This can only be one of setdatetime,id)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "setdatetime" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "desc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "804053cf-0bca-4a34-8f1f-433c4c7457eb", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "projects", ":projectid", "workstages" ], "query": [ { "description": { "content": "Sort field (This can only be one of setdatetime,id)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "setdatetime" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "desc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Project ID", "type": "text/plain" }, "disabled": false, "key": "projectid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "f52ed12b-d409-4a3e-ba87-d835fdb6d8c8", "name": "/settings/projects/customfieldoptions", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Creates a new option for a Project Custom Field.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/settings/projects/customfieldoptions", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "customfieldoptions" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c851678a-fb44-44cd-95f3-fa5aceabb7da", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "customfieldoptions" ], "query": [], "variable": [] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "601b3104-7e5f-4471-b478-0d0669350999", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "customfieldoptions" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "abfda5c6-f94b-41b5-b8a7-a78201d56ab3", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"customfieldid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "customfieldoptions" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "a42b7c4a-4b04-47da-b52b-1c99b5d13f1c", "name": "/settings/projects/customfieldoptions/:optionid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"displayorder\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Updates an option for a Project Custom Field.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/settings/projects/customfieldoptions/:optionid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "customfieldoptions", ":optionid" ], "query": [], "variable": [ { "description": { "content": "(Required) Custom Field Option ID", "type": "text/plain" }, "disabled": false, "key": "optionid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6bab2cca-b15e-42a8-aee2-efb69114ca49", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"displayorder\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "customfieldoptions", ":optionid" ], "query": [], "variable": [ { "description": { "content": "(Required) Custom Field Option ID", "type": "text/plain" }, "disabled": false, "key": "optionid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e2685b54-d975-47ac-9eb9-aae3344324f1", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"displayorder\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "customfieldoptions", ":optionid" ], "query": [], "variable": [ { "description": { "content": "(Required) Custom Field Option ID", "type": "text/plain" }, "disabled": false, "key": "optionid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b0d337b2-8c67-4294-a3ff-2ccbb305f5b9", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"displayorder\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "customfieldoptions", ":optionid" ], "query": [], "variable": [ { "description": { "content": "(Required) Custom Field Option ID", "type": "text/plain" }, "disabled": false, "key": "optionid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "1b4beabc-0067-409e-b7b3-a11947aa9067", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"displayorder\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "customfieldoptions", ":optionid" ], "query": [], "variable": [ { "description": { "content": "(Required) Custom Field Option ID", "type": "text/plain" }, "disabled": false, "key": "optionid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "96c65ec3-1991-4cc2-b43b-341ff6e2d29c", "name": "/settings/projects/customfieldoptions/:optionid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Deletes an option for a Project Custom Field.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/settings/projects/customfieldoptions/:optionid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "customfieldoptions", ":optionid" ], "query": [], "variable": [ { "description": { "content": "(Required) Custom Field Option ID", "type": "text/plain" }, "disabled": false, "key": "optionid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9dbfcdd7-2580-45b0-8c1e-4b4a23540bc9", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "customfieldoptions", ":optionid" ], "query": [], "variable": [ { "description": { "content": "(Required) Custom Field Option ID", "type": "text/plain" }, "disabled": false, "key": "optionid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7ebfd431-666a-4434-b55a-d7f602889290", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "customfieldoptions", ":optionid" ], "query": [], "variable": [ { "description": { "content": "(Required) Custom Field Option ID", "type": "text/plain" }, "disabled": false, "key": "optionid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "1b3bbdd0-d394-41e3-b7c3-ca4fbff6ffb7", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "customfieldoptions", ":optionid" ], "query": [], "variable": [ { "description": { "content": "(Required) Custom Field Option ID", "type": "text/plain" }, "disabled": false, "key": "optionid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8037a61f-0bf4-472f-b379-d6dc3e49d73f", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "customfieldoptions", ":optionid" ], "query": [], "variable": [ { "description": { "content": "(Required) Custom Field Option ID", "type": "text/plain" }, "disabled": false, "key": "optionid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "547f69eb-dc7b-4e7e-a4ac-44c010784ccd", "name": "/settings/projects/customfields", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Custom Fields including the Options for each Field. Advanced plan only.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/projects/customfields", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "customfields" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"isActive\": \"\u003cboolean\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"staffonly\": \"\u003cboolean\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"values\": [\n {\n \"displayorder\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"value\": \"\u003cstring\u003e\"\n },\n {\n \"displayorder\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"value\": \"\u003cstring\u003e\"\n }\n ]\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"isActive\": \"\u003cboolean\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"staffonly\": \"\u003cboolean\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"values\": [\n {\n \"displayorder\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"value\": \"\u003cstring\u003e\"\n },\n {\n \"displayorder\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"value\": \"\u003cstring\u003e\"\n }\n ]\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "296675bb-6470-49a8-a610-0d705f264674", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "customfields" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8e79002b-6a19-4174-aad8-ab57892c22ae", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "customfields" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "907eab58-d571-460a-9eac-2d868912a250", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "customfields" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b95572b3-580a-4456-a1b6-6d6e0a2b8e1d", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "customfields" ], "query": [], "variable": [] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8d43da39-34ad-4f17-81a2-930ca4ea3dfa", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "customfields" ], "query": [], "variable": [] } }, "status": "Not Found" } ] }, { "event": [], "id": "0d589146-8ec6-499e-90eb-269e258e8280", "name": "/settings/projects/customfields", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"active\": \"\u003cboolean\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"staffonly\": \"\u003cboolean\u003e\",\n \"type\": \"staff\"\n}" }, "description": { "content": "Creates a new Project Custom Field.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/settings/projects/customfields", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "customfields" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5312cc94-963f-461a-8916-eb19a9db3620", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"active\": \"\u003cboolean\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"staffonly\": \"\u003cboolean\u003e\",\n \"type\": \"staff\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "customfields" ], "query": [], "variable": [] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8e7017b2-91f8-4749-9a67-2d93c541633d", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"active\": \"\u003cboolean\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"staffonly\": \"\u003cboolean\u003e\",\n \"type\": \"staff\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "customfields" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "fa4939ce-fe68-4ff5-a9a5-44d84d53246d", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"active\": \"\u003cboolean\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"staffonly\": \"\u003cboolean\u003e\",\n \"type\": \"staff\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "customfields" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "6a5c4de3-2359-4f15-8945-a15b78d4fe3a", "name": "/settings/projects/customfields/:customfieldid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"displayorder\": \"\u003cinteger\u003e\",\n \"isActive\": \"\u003cboolean\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"staffonly\": \"\u003cboolean\u003e\"\n}" }, "description": { "content": "Updates a Project Custom Field.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/settings/projects/customfields/:customfieldid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "customfields", ":customfieldid" ], "query": [], "variable": [ { "description": { "content": "(Required) Custom Field ID", "type": "text/plain" }, "disabled": false, "key": "customfieldid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c0efc29e-e06b-4749-9d40-d4ef35fdb7ca", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"displayorder\": \"\u003cinteger\u003e\",\n \"isActive\": \"\u003cboolean\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"staffonly\": \"\u003cboolean\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "customfields", ":customfieldid" ], "query": [], "variable": [ { "description": { "content": "(Required) Custom Field ID", "type": "text/plain" }, "disabled": false, "key": "customfieldid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c4af487b-2ba4-4acc-b8b1-aa3863781236", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"displayorder\": \"\u003cinteger\u003e\",\n \"isActive\": \"\u003cboolean\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"staffonly\": \"\u003cboolean\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "customfields", ":customfieldid" ], "query": [], "variable": [ { "description": { "content": "(Required) Custom Field ID", "type": "text/plain" }, "disabled": false, "key": "customfieldid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "004a62ac-f7dc-41e6-948a-2f77618fd6fe", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"displayorder\": \"\u003cinteger\u003e\",\n \"isActive\": \"\u003cboolean\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"staffonly\": \"\u003cboolean\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "customfields", ":customfieldid" ], "query": [], "variable": [ { "description": { "content": "(Required) Custom Field ID", "type": "text/plain" }, "disabled": false, "key": "customfieldid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f5743629-7b9c-4082-90c1-c80e7ef1903a", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"displayorder\": \"\u003cinteger\u003e\",\n \"isActive\": \"\u003cboolean\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"staffonly\": \"\u003cboolean\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "customfields", ":customfieldid" ], "query": [], "variable": [ { "description": { "content": "(Required) Custom Field ID", "type": "text/plain" }, "disabled": false, "key": "customfieldid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "0377b5ab-3175-48eb-8553-00bd9b670682", "name": "/settings/projects/customfields/:customfieldid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Deletes a Project Custom Field.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/settings/projects/customfields/:customfieldid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "customfields", ":customfieldid" ], "query": [], "variable": [ { "description": { "content": "(Required) Custom Field ID", "type": "text/plain" }, "disabled": false, "key": "customfieldid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "0869144e-ae23-4a8f-b94e-d459fe405af9", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "customfields", ":customfieldid" ], "query": [], "variable": [ { "description": { "content": "(Required) Custom Field ID", "type": "text/plain" }, "disabled": false, "key": "customfieldid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a80b2fe3-c362-4f93-bd39-00d96ca3799c", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "customfields", ":customfieldid" ], "query": [], "variable": [ { "description": { "content": "(Required) Custom Field ID", "type": "text/plain" }, "disabled": false, "key": "customfieldid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "14b487b1-5791-4d2b-8599-aa7cf96aa76a", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "customfields", ":customfieldid" ], "query": [], "variable": [ { "description": { "content": "(Required) Custom Field ID", "type": "text/plain" }, "disabled": false, "key": "customfieldid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ff319d0a-068d-40cf-af4f-712b97236838", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "customfields", ":customfieldid" ], "query": [], "variable": [ { "description": { "content": "(Required) Custom Field ID", "type": "text/plain" }, "disabled": false, "key": "customfieldid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "a85897a0-de47-47e6-a774-32cd906b0257", "name": "/settings/projects/templates", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Project Templates. Advanced plan only.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/projects/templates", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "41134341-53ec-4d75-b29d-3ec84dbc569a", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5a282059-2120-4e1a-969d-db5156541c72", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e412041d-c2a6-462d-a451-60a0cb716efd", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8e54a52e-a182-4f14-96bf-0b7a09e21fd4", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates" ], "query": [], "variable": [] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b076419d-bb04-4b29-abb0-9d434fd8064a", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates" ], "query": [], "variable": [] } }, "status": "Not Found" } ] } ], "name": "projects" }, { "description": "", "item": [ { "event": [], "id": "65bbf2c1-8f07-49d5-bf58-3b37e123c439", "name": "/quotes", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Quotes based on the filters specified. Optionally returns subtotals grouped by company, project, status, or time period.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/quotes", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- number - Quote number\n- title - Quote title\n- status - Work state\n- activeworkstageid - Active work stage ID\n- type - Quote type (estimate or quote)\n- description - Quote description (HTML stripped)\n- company - Company ID and name\n- clientcontactname - Client contact name\n- project - Project ID\n- dates - Quote date, valid date, approved date\n- quotedate - Quote date only\n- validdate - Valid date only\n- approveddate - Approved date only\n- emaileddate - Date quote was emailed\n- emailedtoclient - Whether quote was emailed to client\n- emailedto - Email address quote was sent to\n- showcostbreakdown - Whether cost breakdown is shown\n- showitemdescription - Whether item description is shown\n- showphases - Whether phases are shown\n- quotedby - Contact ID who created the quote\n- totals - Subtotal, tax total, and grand total\n- budget - Budget amount, tax, and type\n- billamount - Bill amount, tax, and type\n- taxable - Whether quote is taxable\n- taxrate - Tax rate percentage\n- address - Address fields\n- pagetitle - Page title\n- customfield - Custom field name and value\n- lastmodified - Last modified date (UTC)\n- all - All fields listed above Sub-entity fields (NOT included by all — must be named explicitly, e.g. fields=all,phases):\n- phases - Phase line items with nested items", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "number,title,company,status,totals,quoteddate" }, { "description": { "content": "Deprecated: use number, title, or q+qfields instead. Search by number or title. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use number or q+qfields instead. Search by quote number. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use title or q+qfields instead. Search by quote title. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchtitle", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact number match", "type": "text/plain" }, "disabled": true, "key": "number", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact title match", "type": "text/plain" }, "disabled": true, "key": "title", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of number,title)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "number" }, { "description": { "content": "Status (activeworkstate). Alias: activeworkstate. (This can only be one of pending,sent,accepted,addedtoproject,declined,expired,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "sent" }, { "description": { "content": "Alias for status. (This can only be one of pending,sent,accepted,addedtoproject,declined,expired,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "sent" }, { "description": { "content": "Quote type (This can only be one of estimate,quote,all)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "quote" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project manager Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Project category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectcategoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter quotes by active work stage ID", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Quoted date from (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "quoteddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Quoted date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "quoteddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Approved date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "approveddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Approved date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "approveddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Valid to date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "validtodatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Valid to date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "validtodateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total minimum", "type": "text/plain" }, "disabled": true, "key": "grandtotalfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total maximum", "type": "text/plain" }, "disabled": true, "key": "grandtotalto", "value": "\u003cstring\u003e" }, { "description": { "content": "Group results by. Returns subtotals per group. (This can only be one of company,project,status,day,week,month,year)", "type": "text/plain" }, "disabled": true, "key": "subtotals", "value": "status" }, { "description": { "content": "Date field for subtotals grouping (This can only be one of quoted,approved)", "type": "text/plain" }, "disabled": true, "key": "subtotalsdateoption", "value": "approved" }, { "description": { "content": "Quotes modified on or after this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Quotes modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Quotes with ID greater than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Quotes with ID less than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Quote IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,quotedate,validdate,companyname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"approveddate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"clientcontactname\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"customfieldname\": \"\u003cstring\u003e\",\n \"customfieldvalue\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"emaileddate\": \"\u003cstring\u003e\",\n \"emailedto\": \"\u003cstring\u003e\",\n \"emailedtoclient\": \"\u003cboolean\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"pagetitle\": \"\u003cstring\u003e\",\n \"phases\": [\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\"\n }\n ],\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n },\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\"\n }\n ],\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n }\n ],\n \"projectid\": \"\u003cinteger\u003e\",\n \"quotedate\": \"\u003cstring\u003e\",\n \"quotedby\": \"\u003cstring\u003e\",\n \"showcostbreakdown\": \"\u003cboolean\u003e\",\n \"showitemdescription\": \"\u003cboolean\u003e\",\n \"showphases\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"taxable\": \"\u003cboolean\u003e\",\n \"taxrate\": \"\u003cnumber\u003e\",\n \"taxtotal\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"validdate\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n },\n {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"approveddate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"clientcontactname\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"customfieldname\": \"\u003cstring\u003e\",\n \"customfieldvalue\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"emaileddate\": \"\u003cstring\u003e\",\n \"emailedto\": \"\u003cstring\u003e\",\n \"emailedtoclient\": \"\u003cboolean\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"pagetitle\": \"\u003cstring\u003e\",\n \"phases\": [\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\"\n }\n ],\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n },\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\"\n }\n ],\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n }\n ],\n \"projectid\": \"\u003cinteger\u003e\",\n \"quotedate\": \"\u003cstring\u003e\",\n \"quotedby\": \"\u003cstring\u003e\",\n \"showcostbreakdown\": \"\u003cboolean\u003e\",\n \"showitemdescription\": \"\u003cboolean\u003e\",\n \"showphases\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"taxable\": \"\u003cboolean\u003e\",\n \"taxrate\": \"\u003cnumber\u003e\",\n \"taxtotal\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"validdate\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "abac85e6-6fdc-431b-a398-76da94b79004", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- number - Quote number\n- title - Quote title\n- status - Work state\n- activeworkstageid - Active work stage ID\n- type - Quote type (estimate or quote)\n- description - Quote description (HTML stripped)\n- company - Company ID and name\n- clientcontactname - Client contact name\n- project - Project ID\n- dates - Quote date, valid date, approved date\n- quotedate - Quote date only\n- validdate - Valid date only\n- approveddate - Approved date only\n- emaileddate - Date quote was emailed\n- emailedtoclient - Whether quote was emailed to client\n- emailedto - Email address quote was sent to\n- showcostbreakdown - Whether cost breakdown is shown\n- showitemdescription - Whether item description is shown\n- showphases - Whether phases are shown\n- quotedby - Contact ID who created the quote\n- totals - Subtotal, tax total, and grand total\n- budget - Budget amount, tax, and type\n- billamount - Bill amount, tax, and type\n- taxable - Whether quote is taxable\n- taxrate - Tax rate percentage\n- address - Address fields\n- pagetitle - Page title\n- customfield - Custom field name and value\n- lastmodified - Last modified date (UTC)\n- all - All fields listed above Sub-entity fields (NOT included by all — must be named explicitly, e.g. fields=all,phases):\n- phases - Phase line items with nested items", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "number,title,company,status,totals,quoteddate" }, { "description": { "content": "Deprecated: use number, title, or q+qfields instead. Search by number or title. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use number or q+qfields instead. Search by quote number. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use title or q+qfields instead. Search by quote title. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchtitle", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact number match", "type": "text/plain" }, "disabled": true, "key": "number", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact title match", "type": "text/plain" }, "disabled": true, "key": "title", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of number,title)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "number" }, { "description": { "content": "Status (activeworkstate). Alias: activeworkstate. (This can only be one of pending,sent,accepted,addedtoproject,declined,expired,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "sent" }, { "description": { "content": "Alias for status. (This can only be one of pending,sent,accepted,addedtoproject,declined,expired,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "sent" }, { "description": { "content": "Quote type (This can only be one of estimate,quote,all)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "quote" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project manager Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Project category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectcategoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter quotes by active work stage ID", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Quoted date from (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "quoteddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Quoted date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "quoteddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Approved date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "approveddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Approved date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "approveddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Valid to date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "validtodatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Valid to date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "validtodateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total minimum", "type": "text/plain" }, "disabled": true, "key": "grandtotalfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total maximum", "type": "text/plain" }, "disabled": true, "key": "grandtotalto", "value": "\u003cstring\u003e" }, { "description": { "content": "Group results by. Returns subtotals per group. (This can only be one of company,project,status,day,week,month,year)", "type": "text/plain" }, "disabled": true, "key": "subtotals", "value": "status" }, { "description": { "content": "Date field for subtotals grouping (This can only be one of quoted,approved)", "type": "text/plain" }, "disabled": true, "key": "subtotalsdateoption", "value": "approved" }, { "description": { "content": "Quotes modified on or after this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Quotes modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Quotes with ID greater than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Quotes with ID less than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Quote IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,quotedate,validdate,companyname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e269890f-341b-43c5-afe4-c311fa844bbe", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- number - Quote number\n- title - Quote title\n- status - Work state\n- activeworkstageid - Active work stage ID\n- type - Quote type (estimate or quote)\n- description - Quote description (HTML stripped)\n- company - Company ID and name\n- clientcontactname - Client contact name\n- project - Project ID\n- dates - Quote date, valid date, approved date\n- quotedate - Quote date only\n- validdate - Valid date only\n- approveddate - Approved date only\n- emaileddate - Date quote was emailed\n- emailedtoclient - Whether quote was emailed to client\n- emailedto - Email address quote was sent to\n- showcostbreakdown - Whether cost breakdown is shown\n- showitemdescription - Whether item description is shown\n- showphases - Whether phases are shown\n- quotedby - Contact ID who created the quote\n- totals - Subtotal, tax total, and grand total\n- budget - Budget amount, tax, and type\n- billamount - Bill amount, tax, and type\n- taxable - Whether quote is taxable\n- taxrate - Tax rate percentage\n- address - Address fields\n- pagetitle - Page title\n- customfield - Custom field name and value\n- lastmodified - Last modified date (UTC)\n- all - All fields listed above Sub-entity fields (NOT included by all — must be named explicitly, e.g. fields=all,phases):\n- phases - Phase line items with nested items", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "number,title,company,status,totals,quoteddate" }, { "description": { "content": "Deprecated: use number, title, or q+qfields instead. Search by number or title. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use number or q+qfields instead. Search by quote number. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use title or q+qfields instead. Search by quote title. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchtitle", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact number match", "type": "text/plain" }, "disabled": true, "key": "number", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact title match", "type": "text/plain" }, "disabled": true, "key": "title", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of number,title)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "number" }, { "description": { "content": "Status (activeworkstate). Alias: activeworkstate. (This can only be one of pending,sent,accepted,addedtoproject,declined,expired,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "sent" }, { "description": { "content": "Alias for status. (This can only be one of pending,sent,accepted,addedtoproject,declined,expired,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "sent" }, { "description": { "content": "Quote type (This can only be one of estimate,quote,all)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "quote" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project manager Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Project category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectcategoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter quotes by active work stage ID", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Quoted date from (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "quoteddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Quoted date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "quoteddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Approved date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "approveddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Approved date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "approveddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Valid to date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "validtodatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Valid to date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "validtodateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total minimum", "type": "text/plain" }, "disabled": true, "key": "grandtotalfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total maximum", "type": "text/plain" }, "disabled": true, "key": "grandtotalto", "value": "\u003cstring\u003e" }, { "description": { "content": "Group results by. Returns subtotals per group. (This can only be one of company,project,status,day,week,month,year)", "type": "text/plain" }, "disabled": true, "key": "subtotals", "value": "status" }, { "description": { "content": "Date field for subtotals grouping (This can only be one of quoted,approved)", "type": "text/plain" }, "disabled": true, "key": "subtotalsdateoption", "value": "approved" }, { "description": { "content": "Quotes modified on or after this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Quotes modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Quotes with ID greater than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Quotes with ID less than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Quote IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,quotedate,validdate,companyname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "dc7ba4c8-fdfe-43b2-b471-0efda4e2df04", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- number - Quote number\n- title - Quote title\n- status - Work state\n- activeworkstageid - Active work stage ID\n- type - Quote type (estimate or quote)\n- description - Quote description (HTML stripped)\n- company - Company ID and name\n- clientcontactname - Client contact name\n- project - Project ID\n- dates - Quote date, valid date, approved date\n- quotedate - Quote date only\n- validdate - Valid date only\n- approveddate - Approved date only\n- emaileddate - Date quote was emailed\n- emailedtoclient - Whether quote was emailed to client\n- emailedto - Email address quote was sent to\n- showcostbreakdown - Whether cost breakdown is shown\n- showitemdescription - Whether item description is shown\n- showphases - Whether phases are shown\n- quotedby - Contact ID who created the quote\n- totals - Subtotal, tax total, and grand total\n- budget - Budget amount, tax, and type\n- billamount - Bill amount, tax, and type\n- taxable - Whether quote is taxable\n- taxrate - Tax rate percentage\n- address - Address fields\n- pagetitle - Page title\n- customfield - Custom field name and value\n- lastmodified - Last modified date (UTC)\n- all - All fields listed above Sub-entity fields (NOT included by all — must be named explicitly, e.g. fields=all,phases):\n- phases - Phase line items with nested items", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "number,title,company,status,totals,quoteddate" }, { "description": { "content": "Deprecated: use number, title, or q+qfields instead. Search by number or title. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use number or q+qfields instead. Search by quote number. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use title or q+qfields instead. Search by quote title. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchtitle", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact number match", "type": "text/plain" }, "disabled": true, "key": "number", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact title match", "type": "text/plain" }, "disabled": true, "key": "title", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of number,title)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "number" }, { "description": { "content": "Status (activeworkstate). Alias: activeworkstate. (This can only be one of pending,sent,accepted,addedtoproject,declined,expired,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "sent" }, { "description": { "content": "Alias for status. (This can only be one of pending,sent,accepted,addedtoproject,declined,expired,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "sent" }, { "description": { "content": "Quote type (This can only be one of estimate,quote,all)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "quote" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project manager Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Project category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectcategoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter quotes by active work stage ID", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Quoted date from (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "quoteddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Quoted date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "quoteddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Approved date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "approveddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Approved date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "approveddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Valid to date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "validtodatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Valid to date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "validtodateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total minimum", "type": "text/plain" }, "disabled": true, "key": "grandtotalfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total maximum", "type": "text/plain" }, "disabled": true, "key": "grandtotalto", "value": "\u003cstring\u003e" }, { "description": { "content": "Group results by. Returns subtotals per group. (This can only be one of company,project,status,day,week,month,year)", "type": "text/plain" }, "disabled": true, "key": "subtotals", "value": "status" }, { "description": { "content": "Date field for subtotals grouping (This can only be one of quoted,approved)", "type": "text/plain" }, "disabled": true, "key": "subtotalsdateoption", "value": "approved" }, { "description": { "content": "Quotes modified on or after this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Quotes modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Quotes with ID greater than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Quotes with ID less than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Quote IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,quotedate,validdate,companyname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "31552e77-5fe8-4026-bdf3-3b72f91262b5", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- number - Quote number\n- title - Quote title\n- status - Work state\n- activeworkstageid - Active work stage ID\n- type - Quote type (estimate or quote)\n- description - Quote description (HTML stripped)\n- company - Company ID and name\n- clientcontactname - Client contact name\n- project - Project ID\n- dates - Quote date, valid date, approved date\n- quotedate - Quote date only\n- validdate - Valid date only\n- approveddate - Approved date only\n- emaileddate - Date quote was emailed\n- emailedtoclient - Whether quote was emailed to client\n- emailedto - Email address quote was sent to\n- showcostbreakdown - Whether cost breakdown is shown\n- showitemdescription - Whether item description is shown\n- showphases - Whether phases are shown\n- quotedby - Contact ID who created the quote\n- totals - Subtotal, tax total, and grand total\n- budget - Budget amount, tax, and type\n- billamount - Bill amount, tax, and type\n- taxable - Whether quote is taxable\n- taxrate - Tax rate percentage\n- address - Address fields\n- pagetitle - Page title\n- customfield - Custom field name and value\n- lastmodified - Last modified date (UTC)\n- all - All fields listed above Sub-entity fields (NOT included by all — must be named explicitly, e.g. fields=all,phases):\n- phases - Phase line items with nested items", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "number,title,company,status,totals,quoteddate" }, { "description": { "content": "Deprecated: use number, title, or q+qfields instead. Search by number or title. Use ! for negation.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use number or q+qfields instead. Search by quote number. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchnumber", "value": "\u003cstring\u003e" }, { "description": { "content": "Deprecated: use title or q+qfields instead. Search by quote title. Supports ! for negation.", "type": "text/plain" }, "disabled": true, "key": "searchtitle", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact number match", "type": "text/plain" }, "disabled": true, "key": "number", "value": "\u003cstring\u003e" }, { "description": { "content": "Exact title match", "type": "text/plain" }, "disabled": true, "key": "title", "value": "\u003cstring\u003e" }, { "description": { "content": "Fuzzy search term (use with qfields to restrict fields searched)", "type": "text/plain" }, "disabled": true, "key": "q", "value": "\u003cstring\u003e" }, { "description": { "content": "Comma-separated fields to fuzzy search (This can only be one of number,title)", "type": "text/plain" }, "disabled": true, "key": "qfields", "value": "number" }, { "description": { "content": "Status (activeworkstate). Alias: activeworkstate. (This can only be one of pending,sent,accepted,addedtoproject,declined,expired,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "sent" }, { "description": { "content": "Alias for status. (This can only be one of pending,sent,accepted,addedtoproject,declined,expired,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "sent" }, { "description": { "content": "Quote type (This can only be one of estimate,quote,all)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "quote" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "false" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project manager Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "managerid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Project category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectcategoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter quotes by active work stage ID", "type": "text/plain" }, "disabled": true, "key": "workstageid", "value": "\u003cstring\u003e" }, { "description": { "content": "Quoted date from (ISO8601 or relative: 12h, 5d, 2w, 1m)", "type": "text/plain" }, "disabled": true, "key": "quoteddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Quoted date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "quoteddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Approved date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "approveddatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Approved date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "approveddateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Valid to date from (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "validtodatefrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Valid to date to (ISO8601 or relative)", "type": "text/plain" }, "disabled": true, "key": "validtodateto", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total minimum", "type": "text/plain" }, "disabled": true, "key": "grandtotalfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Grand total maximum", "type": "text/plain" }, "disabled": true, "key": "grandtotalto", "value": "\u003cstring\u003e" }, { "description": { "content": "Group results by. Returns subtotals per group. (This can only be one of company,project,status,day,week,month,year)", "type": "text/plain" }, "disabled": true, "key": "subtotals", "value": "status" }, { "description": { "content": "Date field for subtotals grouping (This can only be one of quoted,approved)", "type": "text/plain" }, "disabled": true, "key": "subtotalsdateoption", "value": "approved" }, { "description": { "content": "Quotes modified on or after this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Quotes modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Quotes with ID greater than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Quotes with ID less than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Quote IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,number,title,quotedate,validdate,companyname)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "number" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "f75fc1f2-8aa7-4d36-941b-0365c7fd0055", "name": "/quotes", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"layoutid\": \"\u003cinteger\u003e\",\n \"validdate\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Updates one or more quotes by ID. All fields except ids are optional — only provided fields are updated.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/quotes", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "32998781-eb47-4ab9-b1b2-3f5083390bf1", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"layoutid\": \"\u003cinteger\u003e\",\n \"validdate\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "52ba0ca6-f8cb-4150-ad24-cfda677b23a6", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"layoutid\": \"\u003cinteger\u003e\",\n \"validdate\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "1c216ae3-4d39-4d16-b555-ffd6794f9cfe", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"layoutid\": \"\u003cinteger\u003e\",\n \"validdate\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes" ], "query": [], "variable": [] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "c296be46-8f85-4291-87fd-5512f669e0c8", "name": "/quotes", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"quotedate\": \"\u003cstring\u003e\",\n \"quoteperiod\": \"\u003cinteger\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"type\": \"quote\",\n \"validdate\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Creates a new (blank) quote.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/quotes", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "87797c06-5ed7-494f-b680-ae31b6208c8d", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"quotedate\": \"\u003cstring\u003e\",\n \"quoteperiod\": \"\u003cinteger\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"type\": \"quote\",\n \"validdate\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes" ], "query": [], "variable": [] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c5daaaaa-19c8-4407-9368-006b845dd39b", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"quotedate\": \"\u003cstring\u003e\",\n \"quoteperiod\": \"\u003cinteger\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"type\": \"quote\",\n \"validdate\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "db335114-a6e2-4de1-9029-f72c9e403102", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"quotedate\": \"\u003cstring\u003e\",\n \"quoteperiod\": \"\u003cinteger\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"type\": \"quote\",\n \"validdate\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "104bed16-20cb-4b9a-b0e4-8954471be313", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"quotedate\": \"\u003cstring\u003e\",\n \"quoteperiod\": \"\u003cinteger\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"type\": \"quote\",\n \"validdate\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "15837d7b-1636-413f-841f-50559ba59712", "name": "/quotes", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Soft deletes one or more quotes by ID.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/quotes", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "fb7f5aa0-fe36-44f8-ac95-8e969d3925b6", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "321f9f4c-2ffc-4e0c-8637-73d19055f057", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e96937e6-92a9-4eab-bee6-0e19400dd3d6", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes" ], "query": [], "variable": [] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "6339a939-9872-4aec-9e8d-6ab4bb812678", "name": "/quotes/items", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of all quote line items across all quotes, based on the filters specified.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/quotes/items", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,itemcollectionid,parentid,itemtypeid,activeworkstate,billAmount" }, { "description": { "content": "Search by item name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Quote ID or list of Quote IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "quoteid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to items within a specific phase (itemcollectionid)", "type": "text/plain" }, "disabled": true, "key": "phaseid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by parent item ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by item type ID", "type": "text/plain" }, "disabled": true, "key": "itemtypeid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cstring\u003e\",\n \"createdatetime\": \"\u003cstring\u003e\",\n \"creatorid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"discountRate\": \"\u003cnumber\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScoreId\": \"\u003cinteger\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"impactScoreId\": \"\u003cinteger\u003e\",\n \"importanceScoreId\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inTaxRate\": \"\u003cnumber\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"isDiscountPercent\": \"\u003cboolean\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outTaxRate\": \"\u003cnumber\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cnumber\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\",\n \"timespent\": \"\u003cnumber\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"uniquetoken\": \"\u003cstring\u003e\",\n \"updatedAt\": \"\u003cnumber\u003e\",\n \"urgencyScoreId\": \"\u003cinteger\u003e\"\n },\n {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cstring\u003e\",\n \"createdatetime\": \"\u003cstring\u003e\",\n \"creatorid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"discountRate\": \"\u003cnumber\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScoreId\": \"\u003cinteger\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"impactScoreId\": \"\u003cinteger\u003e\",\n \"importanceScoreId\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inTaxRate\": \"\u003cnumber\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"isDiscountPercent\": \"\u003cboolean\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outTaxRate\": \"\u003cnumber\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cnumber\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\",\n \"timespent\": \"\u003cnumber\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"uniquetoken\": \"\u003cstring\u003e\",\n \"updatedAt\": \"\u003cnumber\u003e\",\n \"urgencyScoreId\": \"\u003cinteger\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f2ff3d7d-4613-48b2-b412-35a2b1d259f7", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,itemcollectionid,parentid,itemtypeid,activeworkstate,billAmount" }, { "description": { "content": "Search by item name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Quote ID or list of Quote IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "quoteid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to items within a specific phase (itemcollectionid)", "type": "text/plain" }, "disabled": true, "key": "phaseid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by parent item ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by item type ID", "type": "text/plain" }, "disabled": true, "key": "itemtypeid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b9725f40-9842-49aa-9d87-ce4005e27e0d", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,itemcollectionid,parentid,itemtypeid,activeworkstate,billAmount" }, { "description": { "content": "Search by item name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Quote ID or list of Quote IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "quoteid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to items within a specific phase (itemcollectionid)", "type": "text/plain" }, "disabled": true, "key": "phaseid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by parent item ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by item type ID", "type": "text/plain" }, "disabled": true, "key": "itemtypeid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e20d0852-9b5a-4b3e-80e6-0eda23a043c0", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,itemcollectionid,parentid,itemtypeid,activeworkstate,billAmount" }, { "description": { "content": "Search by item name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Quote ID or list of Quote IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "quoteid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to items within a specific phase (itemcollectionid)", "type": "text/plain" }, "disabled": true, "key": "phaseid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by parent item ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by item type ID", "type": "text/plain" }, "disabled": true, "key": "itemtypeid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "0c6b2bd6-7640-4707-b023-9eb3bb7414c1", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,itemcollectionid,parentid,itemtypeid,activeworkstate,billAmount" }, { "description": { "content": "Search by item name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Quote ID or list of Quote IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "quoteid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to items within a specific phase (itemcollectionid)", "type": "text/plain" }, "disabled": true, "key": "phaseid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by parent item ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by item type ID", "type": "text/plain" }, "disabled": true, "key": "itemtypeid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "eb839422-7084-4f56-8e95-26c5c24d4882", "name": "/quotes/items", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billType\": \"\u003cinteger\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"discount\": {\n \"amount\": \"\u003cnumber\u003e\",\n \"percent\": \"\u003cnumber\u003e\"\n },\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScore\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"impactScore\": \"\u003cinteger\u003e\",\n \"importanceScore\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"manualPercentageComplete\": \"\u003cnumber\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedTimeManual\": \"\u003cinteger\u003e\",\n \"projectedTimeSpent\": \"\u003cinteger\u003e\",\n \"shiftDates\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cinteger\u003e\",\n \"urgencyScore\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Updates one or more quote items by ID. All fields except ids are optional — only provided fields are updated.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/quotes/items", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "items" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "755d7613-473f-4907-9797-4d4f2d9e077f", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billType\": \"\u003cinteger\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"discount\": {\n \"amount\": \"\u003cnumber\u003e\",\n \"percent\": \"\u003cnumber\u003e\"\n },\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScore\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"impactScore\": \"\u003cinteger\u003e\",\n \"importanceScore\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"manualPercentageComplete\": \"\u003cnumber\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedTimeManual\": \"\u003cinteger\u003e\",\n \"projectedTimeSpent\": \"\u003cinteger\u003e\",\n \"shiftDates\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cinteger\u003e\",\n \"urgencyScore\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "items" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f89af480-6df5-4255-b0b8-73f9bb865904", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billType\": \"\u003cinteger\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"discount\": {\n \"amount\": \"\u003cnumber\u003e\",\n \"percent\": \"\u003cnumber\u003e\"\n },\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScore\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"impactScore\": \"\u003cinteger\u003e\",\n \"importanceScore\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"manualPercentageComplete\": \"\u003cnumber\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedTimeManual\": \"\u003cinteger\u003e\",\n \"projectedTimeSpent\": \"\u003cinteger\u003e\",\n \"shiftDates\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cinteger\u003e\",\n \"urgencyScore\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "items" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d217bbc8-554a-4b6c-9da9-22f462a7ee07", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billType\": \"\u003cinteger\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"discount\": {\n \"amount\": \"\u003cnumber\u003e\",\n \"percent\": \"\u003cnumber\u003e\"\n },\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScore\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"impactScore\": \"\u003cinteger\u003e\",\n \"importanceScore\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"manualPercentageComplete\": \"\u003cnumber\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedTimeManual\": \"\u003cinteger\u003e\",\n \"projectedTimeSpent\": \"\u003cinteger\u003e\",\n \"shiftDates\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cinteger\u003e\",\n \"urgencyScore\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "items" ], "query": [], "variable": [] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "126c4b2b-7ccb-4683-a13d-f46fcbcfa8a3", "name": "/quotes/items", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\"\n}" }, "description": { "content": "Creates one or more quote line items. The quoteid must be provided in the request body.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/quotes/items", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "items" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "92fa3da8-94da-4410-a43c-ba1dfebeb9b9", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "items" ], "query": [], "variable": [] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "76faff2d-c616-47e6-92d9-5d1ba28c56cf", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "items" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b820e51c-a085-4d2f-8ec9-016923ebee9e", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "items" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "326e2711-50d3-47e7-ae7f-0881c1af2908", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "items" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "f5dc1115-6c0f-4d0b-b168-b0245e03e0fa", "name": "/quotes/items/:itemid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns full details of a single quote line item by ID, without requiring the quote ID.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/quotes/items/:itemid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cstring\u003e\",\n \"createdatetime\": \"\u003cstring\u003e\",\n \"creatorid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"discountRate\": \"\u003cnumber\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScoreId\": \"\u003cinteger\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"impactScoreId\": \"\u003cinteger\u003e\",\n \"importanceScoreId\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inTaxRate\": \"\u003cnumber\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"isDiscountPercent\": \"\u003cboolean\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outTaxRate\": \"\u003cnumber\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cnumber\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\",\n \"timespent\": \"\u003cnumber\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"uniquetoken\": \"\u003cstring\u003e\",\n \"updatedAt\": \"\u003cnumber\u003e\",\n \"urgencyScoreId\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a8d10beb-1791-493f-bd7d-1843ec3f7c0d", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f0e9784a-4064-4873-94d7-21d343fc0fe9", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "355a08e7-0cdf-4c04-8f0b-7d1f27c56c81", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f33c121b-71db-4161-ae31-a3bd87646c40", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e39746e1-d731-48bc-9346-da4ebd756abb", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "820f7309-1b8e-45d8-a7c4-86749cdc5a3c", "name": "/quotes/items/:itemid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\"\n}" }, "description": { "content": "Updates an existing quote line item by ID, without requiring the quote ID.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/quotes/items/:itemid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d1bbfc74-1c7b-47bf-8062-db8d6bae1b0c", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "51014cd8-5e2f-4839-aea7-5851e5e51658", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9dfc7d04-288e-4435-a090-ed1d94a53f9b", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f5674b13-40fc-4d96-b88e-50162c51fe53", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "86f824e2-fcd6-4e9b-a02b-4d246b5719fe", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "952db4d1-fe06-44de-b78f-20f25c77cb55", "name": "/quotes/items/:itemid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Soft-deletes a quote line item by ID, without requiring the quote ID.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/quotes/items/:itemid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d3b8e597-3449-4e6b-b615-e0bbdd4ab10b", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "41a47629-042e-4360-b1d2-c203b8f15d73", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d595ff43-bab9-42fc-bc48-2e4c4519b6bc", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "146963e4-45cf-4eb4-b67a-2a52aa03ee9c", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "555f8528-ec74-4509-9e24-5fce7a8ffc89", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "4946681c-0e78-4707-a816-e7f4def8d8e4", "name": "/quotes/items/:itemid/order", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"placeafterid\": \"\u003cinteger\u003e\",\n \"placebeforeid\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Moves a quote item before or after another item using sortorder. Provide exactly one of placeafterid or placebeforeid.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/quotes/items/:itemid/order", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "items", ":itemid", "order" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "39984cf3-15d4-40cc-a778-d8386b246620", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"placeafterid\": \"\u003cinteger\u003e\",\n \"placebeforeid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "items", ":itemid", "order" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "651fc72e-6ea7-4eab-a29f-81436f8e19e5", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"placeafterid\": \"\u003cinteger\u003e\",\n \"placebeforeid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "items", ":itemid", "order" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "07c3221c-4e9d-473e-806b-a252fc24b2da", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"placeafterid\": \"\u003cinteger\u003e\",\n \"placebeforeid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "items", ":itemid", "order" ], "query": [], "variable": [ { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "4669cdda-ad42-4c99-848c-3e8d4573fe01", "name": "/quotes/phases", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns phases (item collections) across all quotes. Optionally filter by one or more quote IDs.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/quotes/phases", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "phases" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,quoteid,parentid,billAmount" }, { "description": { "content": "Search by phase name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Quote ID or comma-separated list of Quote IDs to filter by", "type": "text/plain" }, "disabled": true, "key": "quoteid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to phases with a specific parent phase ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"datecreated\": \"\u003cstring\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemsActive\": \"\u003cinteger\u003e\",\n \"itemsCompleted\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\"\n },\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"datecreated\": \"\u003cstring\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemsActive\": \"\u003cinteger\u003e\",\n \"itemsCompleted\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8d45dcfa-e7a8-4649-90ae-ee6d2b2648d7", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "phases" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,quoteid,parentid,billAmount" }, { "description": { "content": "Search by phase name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Quote ID or comma-separated list of Quote IDs to filter by", "type": "text/plain" }, "disabled": true, "key": "quoteid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to phases with a specific parent phase ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6f8142dc-208b-44e9-b1d5-b3ba94de0c47", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "phases" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,quoteid,parentid,billAmount" }, { "description": { "content": "Search by phase name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Quote ID or comma-separated list of Quote IDs to filter by", "type": "text/plain" }, "disabled": true, "key": "quoteid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to phases with a specific parent phase ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d6eac4b7-b937-4e7d-8e01-248d1bfd051b", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "phases" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,quoteid,parentid,billAmount" }, { "description": { "content": "Search by phase name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Quote ID or comma-separated list of Quote IDs to filter by", "type": "text/plain" }, "disabled": true, "key": "quoteid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to phases with a specific parent phase ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9419a31d-3d40-452b-99c2-a3cb8bed55a0", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "phases" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,quoteid,parentid,billAmount" }, { "description": { "content": "Search by phase name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Quote ID or comma-separated list of Quote IDs to filter by", "type": "text/plain" }, "disabled": true, "key": "quoteid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to phases with a specific parent phase ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "57039b01-62a5-4052-9e1c-d4edb10fe5a5", "name": "/quotes/phases", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billType\": \"\u003cinteger\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Updates one or more quote phases by ID. All fields except ids are optional.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/quotes/phases", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "phases" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "03d792e6-271e-49e2-babb-11ff0f78e106", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billType\": \"\u003cinteger\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "phases" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ab96ba41-feab-4fba-8d6c-d4f43c72452a", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billType\": \"\u003cinteger\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "phases" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e5d2ce76-a45e-4950-8a5b-e21d72e2bae3", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billType\": \"\u003cinteger\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "phases" ], "query": [], "variable": [] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "08af3c53-bf41-4dbc-a364-f635a9386e09", "name": "/quotes/phases", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Creates one or more quote phases (item collections). The quoteid must be included in the request body.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/quotes/phases", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "phases" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a1a54f6b-81b7-4791-8db6-dc734025780b", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "phases" ], "query": [], "variable": [] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d5f6742c-cb57-469c-adc1-4d0bc22ee4b2", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "phases" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "448622de-4c59-415b-b2bb-f66a47706d46", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "phases" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f4b0fd19-f11a-4906-9d6d-dcde4ab4166e", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "phases" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "b0e90727-b0b6-400d-975b-7740609093cc", "name": "/quotes/phases/adjustdates", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"shiftchilddates\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Shifts item dates within one or more quote phases by a number of days. Negative values shift backwards.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/quotes/phases/adjustdates", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "phases", "adjustdates" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "0898b067-0b0f-4bae-9975-0e8633fa5e78", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"shiftchilddates\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "phases", "adjustdates" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "10311f6d-86f7-4c07-af80-0f9a80ebfd2f", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"shiftchilddates\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "phases", "adjustdates" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b67e0c30-d793-451a-8e11-c4137bcf2721", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"shiftchilddates\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "phases", "adjustdates" ], "query": [], "variable": [] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "c6d68459-c85c-4be7-8a3d-288fe2b48c9c", "name": "/quotes/phases/:phaseid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns full details of a single quote phase by ID. Looks up the phase by ID alone.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/quotes/phases/:phaseid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"datecreated\": \"\u003cstring\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemsActive\": \"\u003cinteger\u003e\",\n \"itemsCompleted\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "96ff86e0-070e-45ff-a93c-f0b9bc986e52", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9142f38d-b864-4eee-b626-3aa6ff336599", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a4a10dc5-dbbe-40c6-b9d3-c3806bce0d8c", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6c491186-d814-4e58-8012-dbd4e3290a88", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "33e98cda-a832-483f-b0b9-22859afc4cfc", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "f5534f8f-8dcf-4ead-8995-013446f7c460", "name": "/quotes/phases/:phaseid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Updates an existing quote phase by ID.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/quotes/phases/:phaseid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9e74bf63-713b-4138-bc87-99dba0f20302", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "919185b4-3a05-40b7-9e88-065b0d2c31af", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a9a8de0e-473c-4bb0-8c73-b0c45f6b1519", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "532cca47-e1e7-4344-bd93-87c4002f7868", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "0a495129-4f21-4da6-ac6b-f85683730f0f", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "97cdc6de-3601-4a59-a4ac-478038a890f5", "name": "/quotes/phases/:phaseid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Soft-deletes a quote phase by ID.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/quotes/phases/:phaseid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "85dff6c1-7d87-4fdb-8351-d028b769fdec", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c56da94c-1992-4977-a759-245571ac7235", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "1e0bedf0-5f01-4068-84d5-918a2052a97f", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "dbbc8017-1860-4a4d-bfeb-9275c5c34861", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9f4c4805-a800-48d5-a0fa-45873be0c7b7", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "8fd91b10-1a2b-4d79-8d0b-dfdceafcd5e1", "name": "/quotes/:quoteid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "View a single Quote. Returns detailed information including phases and line items. IMPORTANT: For Task/Staff Rate Lines, the 'rate' value is cost/hour, the 'time' value is the time in minutes.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/quotes/:quoteid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"approveddate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"clientcontactname\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"customfieldname\": \"\u003cstring\u003e\",\n \"customfieldvalue\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"emaileddate\": \"\u003cstring\u003e\",\n \"emailedto\": \"\u003cstring\u003e\",\n \"emailedtoclient\": \"\u003cboolean\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"pagetitle\": \"\u003cstring\u003e\",\n \"phases\": [\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\"\n }\n ],\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n },\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\"\n }\n ],\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n }\n ],\n \"projectid\": \"\u003cinteger\u003e\",\n \"quotedate\": \"\u003cstring\u003e\",\n \"quotedby\": \"\u003cstring\u003e\",\n \"showcostbreakdown\": \"\u003cboolean\u003e\",\n \"showitemdescription\": \"\u003cboolean\u003e\",\n \"showphases\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"taxable\": \"\u003cboolean\u003e\",\n \"taxrate\": \"\u003cnumber\u003e\",\n \"taxtotal\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"validdate\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "eabeb82e-8606-467f-83cb-2d0c8e935419", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f0272a99-9e37-4d47-b900-deada3cb4875", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b97fb009-26fc-41ed-9d95-a741c4ede41d", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8b2369ac-80d3-4ce9-a1e1-e3088c2bf644", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3e4b2c4b-61ea-4f1b-9492-0eeeef253123", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "756bbba1-5df0-4561-9562-d00631fe2ff0", "name": "/quotes/:quoteid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"approveddate\": \"\u003cstring\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientcompany\": \"\u003cstring\u003e\",\n \"clientcontactname\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactfooter\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"customfieldvalue\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"footerdetails\": \"\u003cstring\u003e\",\n \"layoutid\": \"\u003cinteger\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"pagetitle\": \"\u003cstring\u003e\",\n \"quotedate\": \"\u003cstring\u003e\",\n \"quotedby\": \"\u003cstring\u003e\",\n \"quoteperiod\": \"\u003cinteger\u003e\",\n \"showItemDescription\": \"\u003cboolean\u003e\",\n \"showPhases\": \"\u003cboolean\u003e\",\n \"showcostbreakdown\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"status\": \"sent\",\n \"taxable\": \"\u003cboolean\u003e\",\n \"taxrate\": \"\u003cnumber\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"terms\": \"\u003cstring\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"validdate\": \"\u003cstring\u003e\",\n \"zerotaxtext\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Updates an existing quote. Only provide the fields you want to update.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/quotes/:quoteid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f0f19895-262a-4ef3-900c-f098175e0fb7", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"approveddate\": \"\u003cstring\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientcompany\": \"\u003cstring\u003e\",\n \"clientcontactname\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactfooter\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"customfieldvalue\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"footerdetails\": \"\u003cstring\u003e\",\n \"layoutid\": \"\u003cinteger\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"pagetitle\": \"\u003cstring\u003e\",\n \"quotedate\": \"\u003cstring\u003e\",\n \"quotedby\": \"\u003cstring\u003e\",\n \"quoteperiod\": \"\u003cinteger\u003e\",\n \"showItemDescription\": \"\u003cboolean\u003e\",\n \"showPhases\": \"\u003cboolean\u003e\",\n \"showcostbreakdown\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"status\": \"sent\",\n \"taxable\": \"\u003cboolean\u003e\",\n \"taxrate\": \"\u003cnumber\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"terms\": \"\u003cstring\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"validdate\": \"\u003cstring\u003e\",\n \"zerotaxtext\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7594ab76-180e-4448-902b-535496cb0227", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"approveddate\": \"\u003cstring\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientcompany\": \"\u003cstring\u003e\",\n \"clientcontactname\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactfooter\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"customfieldvalue\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"footerdetails\": \"\u003cstring\u003e\",\n \"layoutid\": \"\u003cinteger\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"pagetitle\": \"\u003cstring\u003e\",\n \"quotedate\": \"\u003cstring\u003e\",\n \"quotedby\": \"\u003cstring\u003e\",\n \"quoteperiod\": \"\u003cinteger\u003e\",\n \"showItemDescription\": \"\u003cboolean\u003e\",\n \"showPhases\": \"\u003cboolean\u003e\",\n \"showcostbreakdown\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"status\": \"sent\",\n \"taxable\": \"\u003cboolean\u003e\",\n \"taxrate\": \"\u003cnumber\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"terms\": \"\u003cstring\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"validdate\": \"\u003cstring\u003e\",\n \"zerotaxtext\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5e8f21d4-bb5f-4c63-b3bc-8824d0a98eb3", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"approveddate\": \"\u003cstring\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientcompany\": \"\u003cstring\u003e\",\n \"clientcontactname\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactfooter\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"customfieldvalue\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"footerdetails\": \"\u003cstring\u003e\",\n \"layoutid\": \"\u003cinteger\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"pagetitle\": \"\u003cstring\u003e\",\n \"quotedate\": \"\u003cstring\u003e\",\n \"quotedby\": \"\u003cstring\u003e\",\n \"quoteperiod\": \"\u003cinteger\u003e\",\n \"showItemDescription\": \"\u003cboolean\u003e\",\n \"showPhases\": \"\u003cboolean\u003e\",\n \"showcostbreakdown\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"status\": \"sent\",\n \"taxable\": \"\u003cboolean\u003e\",\n \"taxrate\": \"\u003cnumber\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"terms\": \"\u003cstring\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"validdate\": \"\u003cstring\u003e\",\n \"zerotaxtext\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7a0c21af-aa87-4c94-aefd-b2f920fb431d", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"approveddate\": \"\u003cstring\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientcompany\": \"\u003cstring\u003e\",\n \"clientcontactname\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactfooter\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"customfieldvalue\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"footerdetails\": \"\u003cstring\u003e\",\n \"layoutid\": \"\u003cinteger\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"pagetitle\": \"\u003cstring\u003e\",\n \"quotedate\": \"\u003cstring\u003e\",\n \"quotedby\": \"\u003cstring\u003e\",\n \"quoteperiod\": \"\u003cinteger\u003e\",\n \"showItemDescription\": \"\u003cboolean\u003e\",\n \"showPhases\": \"\u003cboolean\u003e\",\n \"showcostbreakdown\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"status\": \"sent\",\n \"taxable\": \"\u003cboolean\u003e\",\n \"taxrate\": \"\u003cnumber\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"terms\": \"\u003cstring\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"validdate\": \"\u003cstring\u003e\",\n \"zerotaxtext\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b03f31c0-857d-4cdc-b8ca-4fc69bf20f18", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"approveddate\": \"\u003cstring\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientcompany\": \"\u003cstring\u003e\",\n \"clientcontactname\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactfooter\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"customfieldvalue\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"footerdetails\": \"\u003cstring\u003e\",\n \"layoutid\": \"\u003cinteger\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"pagetitle\": \"\u003cstring\u003e\",\n \"quotedate\": \"\u003cstring\u003e\",\n \"quotedby\": \"\u003cstring\u003e\",\n \"quoteperiod\": \"\u003cinteger\u003e\",\n \"showItemDescription\": \"\u003cboolean\u003e\",\n \"showPhases\": \"\u003cboolean\u003e\",\n \"showcostbreakdown\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"status\": \"sent\",\n \"taxable\": \"\u003cboolean\u003e\",\n \"taxrate\": \"\u003cnumber\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"terms\": \"\u003cstring\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"validdate\": \"\u003cstring\u003e\",\n \"zerotaxtext\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "b833e9f1-cfb2-4f0b-9dc9-d2dc4065e42e", "name": "/quotes/:quoteid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Soft deletes a quote by setting activeworkstate to 'deleted'.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/quotes/:quoteid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "61e1e07d-0468-456c-8f90-73e938e1c9a3", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b4e9c953-b85a-47ba-89a3-461af7eb4db5", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "81da1b02-7291-4f85-b66d-475a0b2d89e8", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3d42c01c-0573-47ab-a01a-c70daa5a7e3a", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f417dfbe-68af-47d0-a5b3-c6313f101c9c", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "7be60c81-8f4a-4b04-b80c-a85aabd2047f", "name": "/quotes/:quoteid/clone", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"makeTemplate\": \"\u003cboolean\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Clones an existing quote.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/quotes/:quoteid/clone", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "clone" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID to clone", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "aca8401f-4a0f-4bb1-a287-feed596f5070", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"makeTemplate\": \"\u003cboolean\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "clone" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID to clone", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "21b3c37d-710d-4f5e-b07f-3c175266fa4b", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"makeTemplate\": \"\u003cboolean\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "clone" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID to clone", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "69abe808-ed30-4ea8-87a9-77200e4358e4", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"makeTemplate\": \"\u003cboolean\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "clone" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID to clone", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "696c9d2e-8d1a-439a-9951-487168dbc4dc", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"makeTemplate\": \"\u003cboolean\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "clone" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID to clone", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b90d20d4-31b2-424c-9311-31c8c89b8d4f", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"makeTemplate\": \"\u003cboolean\u003e\",\n \"title\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "clone" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID to clone", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "a8037899-5fdb-476d-9e7b-4165208c5d80", "name": "/quotes/:quoteid/items", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of line items for a quote. Supports field selection, filtering, sorting and pagination.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/quotes/:quoteid/items", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,itemcollectionid,parentid,itemtypeid,activeworkstate,billAmount" }, { "description": { "content": "Search by item name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to items within a specific phase (itemcollectionid)", "type": "text/plain" }, "disabled": true, "key": "phaseid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by parent item ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by item type ID", "type": "text/plain" }, "disabled": true, "key": "itemtypeid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cstring\u003e\",\n \"createdatetime\": \"\u003cstring\u003e\",\n \"creatorid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"discountRate\": \"\u003cnumber\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScoreId\": \"\u003cinteger\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"impactScoreId\": \"\u003cinteger\u003e\",\n \"importanceScoreId\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inTaxRate\": \"\u003cnumber\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"isDiscountPercent\": \"\u003cboolean\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outTaxRate\": \"\u003cnumber\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cnumber\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\",\n \"timespent\": \"\u003cnumber\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"uniquetoken\": \"\u003cstring\u003e\",\n \"updatedAt\": \"\u003cnumber\u003e\",\n \"urgencyScoreId\": \"\u003cinteger\u003e\"\n },\n {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cstring\u003e\",\n \"createdatetime\": \"\u003cstring\u003e\",\n \"creatorid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"discountRate\": \"\u003cnumber\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScoreId\": \"\u003cinteger\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"impactScoreId\": \"\u003cinteger\u003e\",\n \"importanceScoreId\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inTaxRate\": \"\u003cnumber\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"isDiscountPercent\": \"\u003cboolean\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outTaxRate\": \"\u003cnumber\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cnumber\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\",\n \"timespent\": \"\u003cnumber\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"uniquetoken\": \"\u003cstring\u003e\",\n \"updatedAt\": \"\u003cnumber\u003e\",\n \"urgencyScoreId\": \"\u003cinteger\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "282718dc-7c60-4e68-96a1-a24c77a199e4", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,itemcollectionid,parentid,itemtypeid,activeworkstate,billAmount" }, { "description": { "content": "Search by item name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to items within a specific phase (itemcollectionid)", "type": "text/plain" }, "disabled": true, "key": "phaseid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by parent item ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by item type ID", "type": "text/plain" }, "disabled": true, "key": "itemtypeid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "67e308c2-8468-4d97-bde1-1f1032d59b19", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,itemcollectionid,parentid,itemtypeid,activeworkstate,billAmount" }, { "description": { "content": "Search by item name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to items within a specific phase (itemcollectionid)", "type": "text/plain" }, "disabled": true, "key": "phaseid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by parent item ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by item type ID", "type": "text/plain" }, "disabled": true, "key": "itemtypeid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "aeaaeff2-3b78-42d6-9c15-b686db13cbc4", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,itemcollectionid,parentid,itemtypeid,activeworkstate,billAmount" }, { "description": { "content": "Search by item name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to items within a specific phase (itemcollectionid)", "type": "text/plain" }, "disabled": true, "key": "phaseid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by parent item ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by item type ID", "type": "text/plain" }, "disabled": true, "key": "itemtypeid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "05c50f93-f1cc-4fed-8294-a39d21e5251d", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,itemcollectionid,parentid,itemtypeid,activeworkstate,billAmount" }, { "description": { "content": "Search by item name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to items within a specific phase (itemcollectionid)", "type": "text/plain" }, "disabled": true, "key": "phaseid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by parent item ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by item type ID", "type": "text/plain" }, "disabled": true, "key": "itemtypeid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] }, { "event": [], "id": "0dd689ae-f2eb-4ec5-9759-8a0e17ddfd2c", "name": "/quotes/:quoteid/items", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\"\n}" }, "description": { "content": "Creates one or more line items within a quote phase.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/quotes/:quoteid/items", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "items" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ae1a1f59-f93d-4541-b8f7-c3db876cc374", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "items" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c6922286-ed7e-41e4-9313-e50f2d0603e6", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "items" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c6a45b9f-aa84-44cb-8c4e-5cf655bd20d7", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "items" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a33b0fc6-9a81-4435-8c62-1687004925fe", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "items" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] }, { "event": [], "id": "5b147bdc-9a60-4b20-bf3c-c246782ad931", "name": "/quotes/:quoteid/items/:itemid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns full details of a single quote line item by ID.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/quotes/:quoteid/items/:itemid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cstring\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cstring\u003e\",\n \"createdatetime\": \"\u003cstring\u003e\",\n \"creatorid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"discountRate\": \"\u003cnumber\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScoreId\": \"\u003cinteger\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"impactScoreId\": \"\u003cinteger\u003e\",\n \"importanceScoreId\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inTaxRate\": \"\u003cnumber\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"isDiscountPercent\": \"\u003cboolean\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outTaxRate\": \"\u003cnumber\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cnumber\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\",\n \"timespent\": \"\u003cnumber\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"uniquetoken\": \"\u003cstring\u003e\",\n \"updatedAt\": \"\u003cnumber\u003e\",\n \"urgencyScoreId\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "52b0aa1b-0482-44c9-8563-28d1d68bc00f", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b53aa81d-eb0e-4d91-b258-fc42e8f4da34", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9114bf5c-8197-4f57-a55a-12af3ee63389", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "848bc0cc-a7ea-4217-bb0b-90187d278b27", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7835710b-059a-45cf-a873-1310882aa5f0", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "a1a45e3f-2b19-435e-a5de-4ccceaf96b3a", "name": "/quotes/:quoteid/items/:itemid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\"\n}" }, "description": { "content": "Updates an existing quote line item.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/quotes/:quoteid/items/:itemid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c37dc9e7-bcfd-4fc4-acb9-db059676cb47", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8ccc922c-1daf-486b-958b-70590bf422e6", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "27f1b9c1-a20c-4663-9c63-fce8784455a9", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b239738d-d16e-4460-9bef-2bd8a95095ee", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7b0b60b3-ee10-482f-aff8-0818df542019", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "c9ab57e1-3971-4ce9-ba30-db7e7459202d", "name": "/quotes/:quoteid/items/:itemid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Soft-deletes a quote line item.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/quotes/:quoteid/items/:itemid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "294991b0-2e38-4912-bbb9-5df67894e207", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f5cc383c-5621-483e-8759-a019c262a9ed", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5d976002-fcd6-41c2-8969-a8d3ea4b036f", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d8f2f89c-67a9-4a45-aa48-b0d2761282df", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "75e21123-24dd-48bb-9e4a-86bc03556d43", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "items", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "4f4d8f06-000d-4a21-ac8c-7791d82ebd35", "name": "/quotes/:quoteid/items/:itemid/workstages", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns the workstage history for a quote line item.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/quotes/:quoteid/items/:itemid/workstages", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "items", ":itemid", "workstages" ], "query": [ { "description": { "content": "Sort field (This can only be one of setdatetime,id)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "setdatetime" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "desc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"active\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemcontactid\": \"\u003cstring\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"setdatetime\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\"\n },\n {\n \"active\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemcontactid\": \"\u003cstring\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"setdatetime\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e434ddd9-f1f6-466a-9ace-50e787a7a3b4", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "items", ":itemid", "workstages" ], "query": [ { "description": { "content": "Sort field (This can only be one of setdatetime,id)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "setdatetime" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "desc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f18edb5b-978a-4656-8172-339e962b82fa", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "items", ":itemid", "workstages" ], "query": [ { "description": { "content": "Sort field (This can only be one of setdatetime,id)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "setdatetime" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "desc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "30c567f0-362d-4583-89bc-84d7bd45cb45", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "items", ":itemid", "workstages" ], "query": [ { "description": { "content": "Sort field (This can only be one of setdatetime,id)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "setdatetime" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "desc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "ec8bfef0-c7e7-4085-83d7-36bb7f031cd0", "name": "/quotes/:quoteid/order", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"placeafterid\": \"\u003cinteger\u003e\",\n \"placebeforeid\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Moves a quote before or after another quote using sortorder. Provide exactly one of placeafterid or placebeforeid.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/quotes/:quoteid/order", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "order" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "845b66a8-aaaf-4a8a-8987-19e3718b1418", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"placeafterid\": \"\u003cinteger\u003e\",\n \"placebeforeid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "order" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "50dc155c-a384-44a5-87af-9d0b3becfd9d", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"placeafterid\": \"\u003cinteger\u003e\",\n \"placebeforeid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "order" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "06dd1d20-7883-4d3a-9656-9fb9d1f2f1e8", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"placeafterid\": \"\u003cinteger\u003e\",\n \"placebeforeid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "order" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "c96c0e1f-ebb2-4a90-9c62-e9bb20b5f844", "name": "/quotes/:quoteid/phases", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of phases (item collections) for a quote.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/quotes/:quoteid/phases", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "phases" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,quoteid,parentid,billAmount" }, { "description": { "content": "Search by phase name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to phases with a specific parent phase ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"datecreated\": \"\u003cstring\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemsActive\": \"\u003cinteger\u003e\",\n \"itemsCompleted\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\"\n },\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"datecreated\": \"\u003cstring\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemsActive\": \"\u003cinteger\u003e\",\n \"itemsCompleted\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "1511be16-84a1-409d-bf97-5e5ef57dc41f", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "phases" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,quoteid,parentid,billAmount" }, { "description": { "content": "Search by phase name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to phases with a specific parent phase ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "109112a9-23ce-468e-8f3b-5880c1d3e9e0", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "phases" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,quoteid,parentid,billAmount" }, { "description": { "content": "Search by phase name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to phases with a specific parent phase ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "081c3174-7e77-485c-bf78-0cdb9047b7d9", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "phases" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,quoteid,parentid,billAmount" }, { "description": { "content": "Search by phase name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to phases with a specific parent phase ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f1f3f048-a9f6-4558-9150-99e56d440d47", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "phases" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,quoteid,parentid,billAmount" }, { "description": { "content": "Search by phase name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to phases with a specific parent phase ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] }, { "event": [], "id": "d1a64da1-27e3-47b5-8599-28ba7109dfe4", "name": "/quotes/:quoteid/phases", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Creates one or more phases (item collections) within a quote.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/quotes/:quoteid/phases", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "phases" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ac825f44-67c8-4fd9-bc88-c67b9f8eb317", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "phases" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "80622697-ee43-44ab-933a-261f4912f4a8", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "phases" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3bb683aa-dde7-48b8-a2c1-a0eb36759da1", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "phases" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d9798802-5dc7-4ba8-9ce6-dd194b915e17", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "phases" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] }, { "event": [], "id": "3a54262f-bd41-4b53-a77e-148427a001d1", "name": "/quotes/:quoteid/phases/:phaseid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns full details of a single quote phase (item collection) by ID.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/quotes/:quoteid/phases/:phaseid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"datecreated\": \"\u003cstring\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemsActive\": \"\u003cinteger\u003e\",\n \"itemsCompleted\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7dceb79e-b252-4198-87d1-90f58fd4469e", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3c6ccf86-2837-4ded-b4ff-c0d9cce83219", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a816cba4-ae7d-483f-8143-0552e54e7497", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "13900045-d08e-41e6-b093-061d589f48f2", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a8017b9f-8e9e-4e94-a881-135f3053f35c", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "bf950a59-6796-4883-ab6c-f5b91876fef1", "name": "/quotes/:quoteid/phases/:phaseid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Updates an existing quote phase.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/quotes/:quoteid/phases/:phaseid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f8b72f10-7863-4579-ad05-44c62582aa98", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "02c9a2f8-e12d-4365-8b18-516379a31767", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5bbc21ab-4097-4996-9fbf-f70791f97faf", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "023fdb9a-e1ec-4fe2-b2dc-ac884b15d9eb", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "dc50d2cd-e0cc-4b94-9d3a-c7da7c24f3f2", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"billamount\": \"\u003cnumber\u003e\",\n \"billtype\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgettype\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "38b73f16-d8e3-49f6-8c7b-18f9763103d0", "name": "/quotes/:quoteid/phases/:phaseid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Soft-deletes a quote phase and its associated items.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/quotes/:quoteid/phases/:phaseid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ae370e22-4cc0-41e5-9747-7d7ef609712b", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9e5716ad-531b-49d1-96d7-a234478149f9", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5d92efdd-4819-4c8e-9d16-4acb59fdb143", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "0d61cb3e-314c-4d55-830a-84d2bd6ee0eb", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "cf35c8cf-052a-4838-92be-be1e62fb20ec", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "6fce88cd-77fc-46dc-9dd8-26080e593477", "name": "/quotes/:quoteid/workstage", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Sets the active work stage for a quote.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/quotes/:quoteid/workstage", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "workstage" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6290f4ee-8bfb-4f96-b73c-7da18d9ddf8a", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "workstage" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9960355a-2773-4bbc-b1bb-6d7c01bf7a3b", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "workstage" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "dd42ac81-8a99-4ee7-a8af-3ef736750e8c", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"activeworkstageid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "workstage" ], "query": [], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "e86e1735-48e9-4816-9873-7d8e03a5d295", "name": "/quotes/:quoteid/workstages", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns the workstage history for a quote.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/quotes/:quoteid/workstages", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "workstages" ], "query": [ { "description": { "content": "Sort field (This can only be one of setdatetime,id)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "setdatetime" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "desc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"contactid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"setdatetime\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\"\n },\n {\n \"contactid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"setdatetime\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6c27487a-369f-4da7-8083-570d77943636", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "workstages" ], "query": [ { "description": { "content": "Sort field (This can only be one of setdatetime,id)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "setdatetime" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "desc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3f2db787-480c-4878-8ab1-876fdd39e304", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "workstages" ], "query": [ { "description": { "content": "Sort field (This can only be one of setdatetime,id)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "setdatetime" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "desc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "25c90b85-db8f-4390-9a21-6bd76be84ed3", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "quotes", ":quoteid", "workstages" ], "query": [ { "description": { "content": "Sort field (This can only be one of setdatetime,id)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "setdatetime" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "desc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Quote ID", "type": "text/plain" }, "disabled": false, "key": "quoteid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" } ] } ], "name": "quotes" }, { "description": "", "item": [ { "event": [], "id": "9a7442d1-ca95-4570-90e6-1e56c2da261a", "name": "/settings/account", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns Account settings, including plan details, plugin status, currency, project variable, time and look \u0026 feel.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/account", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "account" ], "query": [ { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"accounttype\": \"\u003cstring\u003e\",\n \"accounturl\": \"\u003cstring\u003e\",\n \"currency\": \"\u003cstring\u003e\",\n \"dateformat\": \"\u003cstring\u003e\",\n \"looknfeel\": {\n \"colors\": {\n \"headerprimary\": \"\u003cstring\u003e\",\n \"headersecondary\": \"\u003cstring\u003e\",\n \"headertext\": \"\u003cstring\u003e\",\n \"linktext\": \"\u003cstring\u003e\",\n \"tab\": \"\u003cstring\u003e\",\n \"tabhover\": \"\u003cstring\u003e\"\n },\n \"colorscheme\": \"\u003cstring\u003e\",\n \"logo\": \"\u003cstring\u003e\"\n },\n \"plan\": {\n \"invoices\": \"\u003cboolean\u003e\",\n \"plan\": \"\u003cinteger\u003e\",\n \"quotes\": \"\u003cboolean\u003e\"\n },\n \"projectvariable\": \"\u003cstring\u003e\",\n \"taskordering\": \"\u003cstring\u003e\",\n \"time\": \"\u003cstring\u003e\",\n \"timetrackinginactivetasks\": \"\u003cstring\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "90bc7711-9d0c-4d78-bcc8-8dd883547ec1", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "account" ], "query": [ { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c7449330-8e7c-4526-9797-e41db4409d03", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "account" ], "query": [ { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "dc92247a-6eb3-4b49-8e23-2366f7b2e519", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "account" ], "query": [ { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a878f424-17d1-4e7f-97c9-734daa36331b", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "account" ], "query": [ { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cinteger\u003e" } ], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "6f9ffa5b-9833-4039-8c0e-7c8079a818ed", "name": "/settings/account/license", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns details of the available, used and total licenses.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/account/license", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "account", "license" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"available\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\",\n \"used\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "381c2034-8b47-4856-b75c-9e3d0f0a0d3b", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "account", "license" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a58dc1aa-b766-45ce-86a7-7be5d5cc33c7", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "account", "license" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6573731f-fc1c-4ee2-99ac-74031ccf6b35", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "account", "license" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5f1f097f-3fc4-46a1-a817-8cd8bde259ad", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "account", "license" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "87edabaf-55ee-4451-80f6-93bb1c1c05d2", "name": "/settings/account/looknfeel", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns Look \u0026 Feel Settings including logo and color scheme.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/account/looknfeel", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "account", "looknfeel" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"colorscheme\": \"\u003cstring\u003e\",\n \"headerprimary\": \"\u003cstring\u003e\",\n \"headersecondary\": \"\u003cstring\u003e\",\n \"headertext\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"linktext\": \"\u003cstring\u003e\",\n \"logo\": \"\u003cstring\u003e\",\n \"tab\": \"\u003cstring\u003e\",\n \"tabhover\": \"\u003cstring\u003e\"\n },\n {\n \"colorscheme\": \"\u003cstring\u003e\",\n \"headerprimary\": \"\u003cstring\u003e\",\n \"headersecondary\": \"\u003cstring\u003e\",\n \"headertext\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"linktext\": \"\u003cstring\u003e\",\n \"logo\": \"\u003cstring\u003e\",\n \"tab\": \"\u003cstring\u003e\",\n \"tabhover\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "99150202-8d62-48cd-bbec-46f9e227829e", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "account", "looknfeel" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ad05be88-0ae3-4cc4-84ba-a320cc746f9e", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "account", "looknfeel" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b780678b-eda7-4e84-8250-6b441917a208", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "account", "looknfeel" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f8bfc3dc-3f18-45c0-a752-de5a6c9c68a1", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "account", "looknfeel" ], "query": [], "variable": [] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3229bf7f-c6cc-4109-9693-4aca5e54d364", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "account", "looknfeel" ], "query": [], "variable": [] } }, "status": "Not Found" } ] }, { "event": [], "id": "a7b9beaf-0314-483b-a5d9-c5c64afbaf74", "name": "/settings/account/plan", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns details of the Plan (Professional/Advanced) and plugin status (invoicesplugin/quotesplugin) for the account.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/account/plan", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "account", "plan" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"invoices\": \"\u003cboolean\u003e\",\n \"plan\": \"\u003cstring\u003e\",\n \"quotes\": \"\u003cboolean\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6e84ad25-1011-4d49-aefb-3d3f870f8ae1", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "account", "plan" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3a0de158-eb44-43f6-a50c-9ad1d9489e64", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "account", "plan" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c461634e-85bc-4690-a5bc-d0dadaf221ec", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "account", "plan" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2a7125de-a348-4602-ba46-49d42f4f9842", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "account", "plan" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "11298b32-0261-4b27-b44b-3a09b62007c4", "name": "/settings/contacts/divisions", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Divisions. Advanced plan only.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/contacts/divisions", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "divisions" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"chargeRateType\": \"\u003cstring\u003e\",\n \"costRateType\": \"\u003cstring\u003e\",\n \"currencyid\": \"\u003cinteger\u003e\",\n \"defaultpayrate\": \"\u003cnumber\u003e\",\n \"ianatimezone\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"payratemultiplier\": \"\u003cnumber\u003e\"\n },\n {\n \"chargeRateType\": \"\u003cstring\u003e\",\n \"costRateType\": \"\u003cstring\u003e\",\n \"currencyid\": \"\u003cinteger\u003e\",\n \"defaultpayrate\": \"\u003cnumber\u003e\",\n \"ianatimezone\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"payratemultiplier\": \"\u003cnumber\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "eb9cd1c9-a901-45cb-b048-c85e19d13009", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "divisions" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "81ef36e9-2a36-4209-bbe3-e22a1051e1da", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "divisions" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "46ec6513-b24a-4376-a073-b4bcdb005910", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "divisions" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "43ff79c8-07cf-4b8b-811a-58f43ce08be5", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "divisions" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "f466ab04-ad0d-41bf-b277-f5c693efb888", "name": "/settings/contacts/divisions/:divisionid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns details of a single Division. Advanced plan only.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/contacts/divisions/:divisionid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "divisions", ":divisionid" ], "query": [], "variable": [ { "description": { "content": "(Required) Division ID", "type": "text/plain" }, "disabled": false, "key": "divisionid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"chargeRateType\": \"\u003cstring\u003e\",\n \"costRateType\": \"\u003cstring\u003e\",\n \"currencyid\": \"\u003cinteger\u003e\",\n \"defaultpayrate\": \"\u003cnumber\u003e\",\n \"ianatimezone\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"payratemultiplier\": \"\u003cnumber\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "701ec8be-7214-4fa2-94ae-b9036e908ae2", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "divisions", ":divisionid" ], "query": [], "variable": [ { "description": { "content": "(Required) Division ID", "type": "text/plain" }, "disabled": false, "key": "divisionid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "973ae45a-30a1-48c6-9cc5-ef47015a13d0", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "divisions", ":divisionid" ], "query": [], "variable": [ { "description": { "content": "(Required) Division ID", "type": "text/plain" }, "disabled": false, "key": "divisionid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2d5627b4-57a5-4404-a7c8-3b015f7d9f0f", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "divisions", ":divisionid" ], "query": [], "variable": [ { "description": { "content": "(Required) Division ID", "type": "text/plain" }, "disabled": false, "key": "divisionid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "37f65423-774a-4a0e-8ccc-b133cd531c36", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "divisions", ":divisionid" ], "query": [], "variable": [ { "description": { "content": "(Required) Division ID", "type": "text/plain" }, "disabled": false, "key": "divisionid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "51b2176b-fc2b-4161-ab56-850a7aa24363", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "divisions", ":divisionid" ], "query": [], "variable": [ { "description": { "content": "(Required) Division ID", "type": "text/plain" }, "disabled": false, "key": "divisionid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "f47bb48d-6301-4559-abb4-8b3b476b731c", "name": "/settings/contacts/divisions/:divisionid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"chargeRateType\": \"\u003cstring\u003e\",\n \"costRateType\": \"\u003cstring\u003e\",\n \"currencyid\": \"\u003cinteger\u003e\",\n \"defaultpayrate\": \"\u003cnumber\u003e\",\n \"ianatimezone\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"payratemultiplier\": \"\u003cnumber\u003e\"\n}" }, "description": { "content": "Updates a division. Advanced plan only.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/settings/contacts/divisions/:divisionid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "divisions", ":divisionid" ], "query": [], "variable": [ { "description": { "content": "(Required) Division ID", "type": "text/plain" }, "disabled": false, "key": "divisionid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3ecd47e6-9037-4dea-86f0-e60287c4232e", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"chargeRateType\": \"\u003cstring\u003e\",\n \"costRateType\": \"\u003cstring\u003e\",\n \"currencyid\": \"\u003cinteger\u003e\",\n \"defaultpayrate\": \"\u003cnumber\u003e\",\n \"ianatimezone\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"payratemultiplier\": \"\u003cnumber\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "divisions", ":divisionid" ], "query": [], "variable": [ { "description": { "content": "(Required) Division ID", "type": "text/plain" }, "disabled": false, "key": "divisionid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d06bc8f6-26d8-4552-a6b6-4700285f5798", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"chargeRateType\": \"\u003cstring\u003e\",\n \"costRateType\": \"\u003cstring\u003e\",\n \"currencyid\": \"\u003cinteger\u003e\",\n \"defaultpayrate\": \"\u003cnumber\u003e\",\n \"ianatimezone\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"payratemultiplier\": \"\u003cnumber\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "divisions", ":divisionid" ], "query": [], "variable": [ { "description": { "content": "(Required) Division ID", "type": "text/plain" }, "disabled": false, "key": "divisionid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b0bc5467-de46-495c-af4f-7030ff51d7d1", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"chargeRateType\": \"\u003cstring\u003e\",\n \"costRateType\": \"\u003cstring\u003e\",\n \"currencyid\": \"\u003cinteger\u003e\",\n \"defaultpayrate\": \"\u003cnumber\u003e\",\n \"ianatimezone\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"payratemultiplier\": \"\u003cnumber\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "divisions", ":divisionid" ], "query": [], "variable": [ { "description": { "content": "(Required) Division ID", "type": "text/plain" }, "disabled": false, "key": "divisionid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "923c4051-a73f-488e-a3ec-5014db8b19d9", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"chargeRateType\": \"\u003cstring\u003e\",\n \"costRateType\": \"\u003cstring\u003e\",\n \"currencyid\": \"\u003cinteger\u003e\",\n \"defaultpayrate\": \"\u003cnumber\u003e\",\n \"ianatimezone\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"payratemultiplier\": \"\u003cnumber\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "divisions", ":divisionid" ], "query": [], "variable": [ { "description": { "content": "(Required) Division ID", "type": "text/plain" }, "disabled": false, "key": "divisionid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8f49580e-97e9-40f8-845d-42865d7dfde7", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"chargeRateType\": \"\u003cstring\u003e\",\n \"costRateType\": \"\u003cstring\u003e\",\n \"currencyid\": \"\u003cinteger\u003e\",\n \"defaultpayrate\": \"\u003cnumber\u003e\",\n \"ianatimezone\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"payratemultiplier\": \"\u003cnumber\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "divisions", ":divisionid" ], "query": [], "variable": [ { "description": { "content": "(Required) Division ID", "type": "text/plain" }, "disabled": false, "key": "divisionid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "7e4a290a-710f-4915-a623-ec1918272165", "name": "/settings/contacts/groups", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Groups including Contacts in each Group.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/contacts/groups", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "groups" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"teamid\": \"\u003cinteger\u003e\"\n },\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"teamid\": \"\u003cinteger\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "cac288e9-7197-4fbf-a456-f6a222696119", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "groups" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "524b68c5-0d38-4346-a53d-2d0b0100700a", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "groups" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2de757be-57e5-40d5-80a7-b68de47905df", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "groups" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3490db79-0ea5-4a3a-b737-7cd3397ef34f", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "groups" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "8dfcbcaf-4967-405e-8b23-9f2d50a10a5e", "name": "/settings/contacts/groups", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactids\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"teamid\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Creates a new contact group.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/settings/contacts/groups", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "groups" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2b582695-fceb-435e-8e46-39d26dc8e83c", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactids\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"teamid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "groups" ], "query": [], "variable": [] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "1074aed1-5ed1-4087-8a93-6f18ca3ad300", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactids\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"teamid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "groups" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "24042980-4d9b-48d3-8d9c-ed5fdeb171d0", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactids\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"teamid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "groups" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "9a2f7189-8fd8-46d6-a6de-a3b1aaadfbe0", "name": "/settings/contacts/groups/:groupid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns details of a single Group including the Contacts in the Group.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/contacts/groups/:groupid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "groups", ":groupid" ], "query": [], "variable": [ { "description": { "content": "(Required) Group ID", "type": "text/plain" }, "disabled": false, "key": "groupid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"teamid\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d23647e8-ee7d-4aaf-be80-e70b189be308", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "groups", ":groupid" ], "query": [], "variable": [ { "description": { "content": "(Required) Group ID", "type": "text/plain" }, "disabled": false, "key": "groupid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "441c95ef-ec81-464b-a3d7-4e65309aaea0", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "groups", ":groupid" ], "query": [], "variable": [ { "description": { "content": "(Required) Group ID", "type": "text/plain" }, "disabled": false, "key": "groupid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d071fefe-6d2e-4e42-8844-2145b986c5d1", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "groups", ":groupid" ], "query": [], "variable": [ { "description": { "content": "(Required) Group ID", "type": "text/plain" }, "disabled": false, "key": "groupid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e1275741-919b-4ecb-9834-3d468b69d3dc", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "groups", ":groupid" ], "query": [], "variable": [ { "description": { "content": "(Required) Group ID", "type": "text/plain" }, "disabled": false, "key": "groupid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3affc724-1406-4b93-9b67-3b95a6e8dd72", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "groups", ":groupid" ], "query": [], "variable": [ { "description": { "content": "(Required) Group ID", "type": "text/plain" }, "disabled": false, "key": "groupid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "76b4478a-1bd5-49aa-a9d6-8c635c912564", "name": "/settings/contacts/groups/:groupid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactids\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Updates a group.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/settings/contacts/groups/:groupid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "groups", ":groupid" ], "query": [], "variable": [ { "description": { "content": "(Required) Group ID", "type": "text/plain" }, "disabled": false, "key": "groupid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7279e9a6-d927-4b64-8353-29915d3fa266", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactids\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "groups", ":groupid" ], "query": [], "variable": [ { "description": { "content": "(Required) Group ID", "type": "text/plain" }, "disabled": false, "key": "groupid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "91dbb5ed-dd97-452f-88b0-e9482e7193ef", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactids\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "groups", ":groupid" ], "query": [], "variable": [ { "description": { "content": "(Required) Group ID", "type": "text/plain" }, "disabled": false, "key": "groupid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3b190f5a-7794-467a-a30f-57187901d348", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactids\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "groups", ":groupid" ], "query": [], "variable": [ { "description": { "content": "(Required) Group ID", "type": "text/plain" }, "disabled": false, "key": "groupid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "79574f85-d90f-4c22-8b9a-50e2cc9feca5", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactids\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "groups", ":groupid" ], "query": [], "variable": [ { "description": { "content": "(Required) Group ID", "type": "text/plain" }, "disabled": false, "key": "groupid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "114a0ff0-c51c-418f-afc6-5b61a3ea6882", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactids\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "groups", ":groupid" ], "query": [], "variable": [ { "description": { "content": "(Required) Group ID", "type": "text/plain" }, "disabled": false, "key": "groupid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "2bdc2847-4a5e-4171-919e-7b7241c8bd6f", "name": "/settings/contacts/groups/:groupid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Deletes a group.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/settings/contacts/groups/:groupid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "groups", ":groupid" ], "query": [], "variable": [ { "description": { "content": "(Required) Group ID", "type": "text/plain" }, "disabled": false, "key": "groupid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "370aa15c-4531-4c6d-b478-f06a0289858b", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "groups", ":groupid" ], "query": [], "variable": [ { "description": { "content": "(Required) Group ID", "type": "text/plain" }, "disabled": false, "key": "groupid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6e4063ed-1e8f-43be-b775-e40ed32a8cdc", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "groups", ":groupid" ], "query": [], "variable": [ { "description": { "content": "(Required) Group ID", "type": "text/plain" }, "disabled": false, "key": "groupid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6cdb0f08-d44c-4cf9-8ffc-4ec50885dc38", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "groups", ":groupid" ], "query": [], "variable": [ { "description": { "content": "(Required) Group ID", "type": "text/plain" }, "disabled": false, "key": "groupid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "95b0fd3b-4a51-49cc-9f95-92c8bdbfd3be", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "groups", ":groupid" ], "query": [], "variable": [ { "description": { "content": "(Required) Group ID", "type": "text/plain" }, "disabled": false, "key": "groupid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6973d14a-0f80-4b7a-990b-4c6159ff0f64", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "groups", ":groupid" ], "query": [], "variable": [ { "description": { "content": "(Required) Group ID", "type": "text/plain" }, "disabled": false, "key": "groupid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "1504f4c4-9fcd-46e6-acd8-65487962f86d", "name": "/settings/contacts/permissions", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of available Permissions in ProWorkflow.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/contacts/permissions", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "permissions" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"viewonly\": \"\u003cboolean\u003e\"\n },\n {\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"viewonly\": \"\u003cboolean\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4d780720-9a2c-4e75-961b-2cc965829d20", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "permissions" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2165fd4c-2fe3-4d63-9bb5-79f53ed49787", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "permissions" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d25ddcc1-8997-49e6-a5a5-38c4600695c6", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "permissions" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "89f6fa23-ba9e-40f4-a738-163ce54bb4ef", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "permissions" ], "query": [], "variable": [] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "597e323d-3a0a-4e51-b84c-8d4b8b5b5ad8", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "permissions" ], "query": [], "variable": [] } }, "status": "Not Found" } ] }, { "event": [], "id": "8af68ac3-bf40-4863-bf3a-72b52e8b1a45", "name": "/settings/contacts/roles", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Roles including assigned Contacts.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/contacts/roles", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "roles" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "560fe29d-1f4c-4c31-8bc8-7e4b83affa51", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "roles" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9ac37b28-8324-4bf1-b41b-296a78ed7a65", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "roles" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8125a334-276e-4fa8-9e94-2f2c56d4bd6e", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "roles" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f20a1c57-9808-4004-b7d3-ec83f54f8ee1", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "roles" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "21e77ed7-c8ed-4ef0-83cf-e11e7c9c8b53", "name": "/settings/contacts/roles", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"permissions\": [\n {\n \"add\": \"\u003cboolean\u003e\",\n \"delete\": \"\u003cboolean\u003e\",\n \"edit\": \"\u003cboolean\u003e\",\n \"permissionid\": \"\u003cinteger\u003e\",\n \"view\": \"\u003cboolean\u003e\"\n },\n {\n \"add\": \"\u003cboolean\u003e\",\n \"delete\": \"\u003cboolean\u003e\",\n \"edit\": \"\u003cboolean\u003e\",\n \"permissionid\": \"\u003cinteger\u003e\",\n \"view\": \"\u003cboolean\u003e\"\n }\n ],\n \"type\": \"client\"\n}" }, "description": { "content": "Creates a new role.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/settings/contacts/roles", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "roles" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3cf71a28-51dd-44ed-84fd-917659567b4f", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"permissions\": [\n {\n \"add\": \"\u003cboolean\u003e\",\n \"delete\": \"\u003cboolean\u003e\",\n \"edit\": \"\u003cboolean\u003e\",\n \"permissionid\": \"\u003cinteger\u003e\",\n \"view\": \"\u003cboolean\u003e\"\n },\n {\n \"add\": \"\u003cboolean\u003e\",\n \"delete\": \"\u003cboolean\u003e\",\n \"edit\": \"\u003cboolean\u003e\",\n \"permissionid\": \"\u003cinteger\u003e\",\n \"view\": \"\u003cboolean\u003e\"\n }\n ],\n \"type\": \"client\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "roles" ], "query": [], "variable": [] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f2f84de3-75e9-4749-95cb-d9d39d045c97", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"permissions\": [\n {\n \"add\": \"\u003cboolean\u003e\",\n \"delete\": \"\u003cboolean\u003e\",\n \"edit\": \"\u003cboolean\u003e\",\n \"permissionid\": \"\u003cinteger\u003e\",\n \"view\": \"\u003cboolean\u003e\"\n },\n {\n \"add\": \"\u003cboolean\u003e\",\n \"delete\": \"\u003cboolean\u003e\",\n \"edit\": \"\u003cboolean\u003e\",\n \"permissionid\": \"\u003cinteger\u003e\",\n \"view\": \"\u003cboolean\u003e\"\n }\n ],\n \"type\": \"client\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "roles" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f84229bc-bc48-447d-bce5-0703157bd42f", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"permissions\": [\n {\n \"add\": \"\u003cboolean\u003e\",\n \"delete\": \"\u003cboolean\u003e\",\n \"edit\": \"\u003cboolean\u003e\",\n \"permissionid\": \"\u003cinteger\u003e\",\n \"view\": \"\u003cboolean\u003e\"\n },\n {\n \"add\": \"\u003cboolean\u003e\",\n \"delete\": \"\u003cboolean\u003e\",\n \"edit\": \"\u003cboolean\u003e\",\n \"permissionid\": \"\u003cinteger\u003e\",\n \"view\": \"\u003cboolean\u003e\"\n }\n ],\n \"type\": \"client\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "roles" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "a863cb75-9f63-473e-9485-6f3b028f7fb1", "name": "/settings/contacts/roles/:roleid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns details of a single Role including assigned Contacts.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/contacts/roles/:roleid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "roles", ":roleid" ], "query": [], "variable": [ { "description": { "content": "(Required) Role ID", "type": "text/plain" }, "disabled": false, "key": "roleid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"color\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c21d1962-08f3-4c15-a83a-61f9144766c9", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "roles", ":roleid" ], "query": [], "variable": [ { "description": { "content": "(Required) Role ID", "type": "text/plain" }, "disabled": false, "key": "roleid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "fea519f1-9336-433b-87ad-9bc1fdf28133", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "roles", ":roleid" ], "query": [], "variable": [ { "description": { "content": "(Required) Role ID", "type": "text/plain" }, "disabled": false, "key": "roleid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "130a00e0-ebeb-4896-a5cd-be30e485e3f1", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "roles", ":roleid" ], "query": [], "variable": [ { "description": { "content": "(Required) Role ID", "type": "text/plain" }, "disabled": false, "key": "roleid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d81b35f8-e02e-451a-91d1-32f807f9ee77", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "roles", ":roleid" ], "query": [], "variable": [ { "description": { "content": "(Required) Role ID", "type": "text/plain" }, "disabled": false, "key": "roleid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5f5a9db4-f2b8-417e-84fc-5cdc74cca828", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "roles", ":roleid" ], "query": [], "variable": [ { "description": { "content": "(Required) Role ID", "type": "text/plain" }, "disabled": false, "key": "roleid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "3cb02bdd-63ca-4647-ab1d-391ed3701606", "name": "/settings/contacts/roles/:roleid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"displayorder\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"permissions\": [\n {\n \"add\": \"\u003cboolean\u003e\",\n \"delete\": \"\u003cboolean\u003e\",\n \"edit\": \"\u003cboolean\u003e\",\n \"permissionid\": \"\u003cinteger\u003e\",\n \"view\": \"\u003cboolean\u003e\"\n },\n {\n \"add\": \"\u003cboolean\u003e\",\n \"delete\": \"\u003cboolean\u003e\",\n \"edit\": \"\u003cboolean\u003e\",\n \"permissionid\": \"\u003cinteger\u003e\",\n \"view\": \"\u003cboolean\u003e\"\n }\n ]\n}" }, "description": { "content": "Updates a role's name, color, display order, permissions, and/or assigned contacts.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/settings/contacts/roles/:roleid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "roles", ":roleid" ], "query": [], "variable": [ { "description": { "content": "(Required) Role ID", "type": "text/plain" }, "disabled": false, "key": "roleid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "0f23ccfa-98dd-469a-b806-d7906899f98f", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"displayorder\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"permissions\": [\n {\n \"add\": \"\u003cboolean\u003e\",\n \"delete\": \"\u003cboolean\u003e\",\n \"edit\": \"\u003cboolean\u003e\",\n \"permissionid\": \"\u003cinteger\u003e\",\n \"view\": \"\u003cboolean\u003e\"\n },\n {\n \"add\": \"\u003cboolean\u003e\",\n \"delete\": \"\u003cboolean\u003e\",\n \"edit\": \"\u003cboolean\u003e\",\n \"permissionid\": \"\u003cinteger\u003e\",\n \"view\": \"\u003cboolean\u003e\"\n }\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "roles", ":roleid" ], "query": [], "variable": [ { "description": { "content": "(Required) Role ID", "type": "text/plain" }, "disabled": false, "key": "roleid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "099f4247-cb4f-4115-bcb0-482aad7cd684", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"displayorder\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"permissions\": [\n {\n \"add\": \"\u003cboolean\u003e\",\n \"delete\": \"\u003cboolean\u003e\",\n \"edit\": \"\u003cboolean\u003e\",\n \"permissionid\": \"\u003cinteger\u003e\",\n \"view\": \"\u003cboolean\u003e\"\n },\n {\n \"add\": \"\u003cboolean\u003e\",\n \"delete\": \"\u003cboolean\u003e\",\n \"edit\": \"\u003cboolean\u003e\",\n \"permissionid\": \"\u003cinteger\u003e\",\n \"view\": \"\u003cboolean\u003e\"\n }\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "roles", ":roleid" ], "query": [], "variable": [ { "description": { "content": "(Required) Role ID", "type": "text/plain" }, "disabled": false, "key": "roleid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2061e8ff-1257-4338-9eb2-cf4503464ed1", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"displayorder\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"permissions\": [\n {\n \"add\": \"\u003cboolean\u003e\",\n \"delete\": \"\u003cboolean\u003e\",\n \"edit\": \"\u003cboolean\u003e\",\n \"permissionid\": \"\u003cinteger\u003e\",\n \"view\": \"\u003cboolean\u003e\"\n },\n {\n \"add\": \"\u003cboolean\u003e\",\n \"delete\": \"\u003cboolean\u003e\",\n \"edit\": \"\u003cboolean\u003e\",\n \"permissionid\": \"\u003cinteger\u003e\",\n \"view\": \"\u003cboolean\u003e\"\n }\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "roles", ":roleid" ], "query": [], "variable": [ { "description": { "content": "(Required) Role ID", "type": "text/plain" }, "disabled": false, "key": "roleid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "60b0f80b-425a-4185-8f6b-2b295ee570ea", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"displayorder\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"permissions\": [\n {\n \"add\": \"\u003cboolean\u003e\",\n \"delete\": \"\u003cboolean\u003e\",\n \"edit\": \"\u003cboolean\u003e\",\n \"permissionid\": \"\u003cinteger\u003e\",\n \"view\": \"\u003cboolean\u003e\"\n },\n {\n \"add\": \"\u003cboolean\u003e\",\n \"delete\": \"\u003cboolean\u003e\",\n \"edit\": \"\u003cboolean\u003e\",\n \"permissionid\": \"\u003cinteger\u003e\",\n \"view\": \"\u003cboolean\u003e\"\n }\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "roles", ":roleid" ], "query": [], "variable": [ { "description": { "content": "(Required) Role ID", "type": "text/plain" }, "disabled": false, "key": "roleid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6e03de06-3f00-4c3e-811e-4e1576d28f09", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"displayorder\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"permissions\": [\n {\n \"add\": \"\u003cboolean\u003e\",\n \"delete\": \"\u003cboolean\u003e\",\n \"edit\": \"\u003cboolean\u003e\",\n \"permissionid\": \"\u003cinteger\u003e\",\n \"view\": \"\u003cboolean\u003e\"\n },\n {\n \"add\": \"\u003cboolean\u003e\",\n \"delete\": \"\u003cboolean\u003e\",\n \"edit\": \"\u003cboolean\u003e\",\n \"permissionid\": \"\u003cinteger\u003e\",\n \"view\": \"\u003cboolean\u003e\"\n }\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "roles", ":roleid" ], "query": [], "variable": [ { "description": { "content": "(Required) Role ID", "type": "text/plain" }, "disabled": false, "key": "roleid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "be679c5a-52d8-42ec-845b-7df5d47d8f1e", "name": "/settings/contacts/roles/:roleid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Deletes a role.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/settings/contacts/roles/:roleid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "roles", ":roleid" ], "query": [], "variable": [ { "description": { "content": "(Required) Role ID", "type": "text/plain" }, "disabled": false, "key": "roleid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8cac5f0e-05da-4aa3-a019-ab9359615a1d", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "roles", ":roleid" ], "query": [], "variable": [ { "description": { "content": "(Required) Role ID", "type": "text/plain" }, "disabled": false, "key": "roleid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "fd45f6fb-8850-4b76-8522-cfa27f2803ae", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "roles", ":roleid" ], "query": [], "variable": [ { "description": { "content": "(Required) Role ID", "type": "text/plain" }, "disabled": false, "key": "roleid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "472410a4-6fe2-48f4-936a-a95644fc5ab8", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "roles", ":roleid" ], "query": [], "variable": [ { "description": { "content": "(Required) Role ID", "type": "text/plain" }, "disabled": false, "key": "roleid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "65f96a69-b774-4b37-bff0-c26a0f68e32c", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "roles", ":roleid" ], "query": [], "variable": [ { "description": { "content": "(Required) Role ID", "type": "text/plain" }, "disabled": false, "key": "roleid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "fa7ad209-e364-4bc2-b137-76f4e0034029", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "roles", ":roleid" ], "query": [], "variable": [ { "description": { "content": "(Required) Role ID", "type": "text/plain" }, "disabled": false, "key": "roleid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "a1cb8abe-30c7-4c6b-9348-0d62f1cb1138", "name": "/settings/contacts/tags", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Contact/Company Tags.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/contacts/tags", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "tags" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "13989265-22e1-4076-8610-abc76f15eacb", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "tags" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5acc506f-1890-417e-a1bf-7a9a0b0445d9", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "tags" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "65c071f1-fade-48ec-9243-e0421cb0435d", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "tags" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "94690666-6a8e-49dd-be1e-31c9e4e73df0", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "tags" ], "query": [], "variable": [] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "bfff534d-a867-4c34-b95c-bd0657e716d0", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "tags" ], "query": [], "variable": [] } }, "status": "Not Found" } ] }, { "event": [], "id": "c8060b9c-2751-4bd1-a35b-53fa04b4eecc", "name": "/settings/contacts/tags", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Creates a new Contact/Company Tag.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/settings/contacts/tags", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "tags" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4b7cdda3-de34-4197-b9a8-84571a4047e6", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "tags" ], "query": [], "variable": [] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f61ab237-e2fb-4b80-a27b-1018848d744a", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "tags" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a241828e-e47d-4bed-a8b6-2d856390c23b", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "tags" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "15ab6a09-6564-46b4-b356-f0d93f1413f3", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "tags" ], "query": [], "variable": [] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "494fe19d-22c4-4e44-af19-db293c519d70", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "tags" ], "query": [], "variable": [] } }, "status": "Not Found" } ] }, { "event": [], "id": "5f576126-aaac-4e3f-80da-9acebffd52c1", "name": "/settings/contacts/tags/:tagid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns details of a single Contact Tag.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/contacts/tags/:tagid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "639006a6-67e4-45b4-976b-86e7f2b9c07f", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "de702981-966e-4818-b8e6-a7d08b3908e8", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "dd2b3a59-c76a-45bf-bcf4-7618d85cd8e5", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "76fb0eed-e06b-42a8-9ce3-94752e13a8c2", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d538e129-4b32-4acc-b35c-e92711634c0b", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "46b31cfd-a0ae-445a-b38b-cefac936c1f7", "name": "/settings/contacts/tags/:tagid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Updates a Contact Tag.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/settings/contacts/tags/:tagid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8651e6b3-0df9-48ef-a74a-f5159b7a8844", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "49b5fa71-d5d7-4531-9236-5162eaa829c9", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "bd64ae89-e8a5-49d1-8a0f-2c73b0d13cb0", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6f370b34-36d2-4ed4-a0f7-6694d4536df8", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "825397fa-c540-41e1-93d3-caf2bab3988c", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "7284af30-4f04-4e7e-95ac-5071694ae898", "name": "/settings/contacts/tags/:tagid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Soft deletes a Contact Tag.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/settings/contacts/tags/:tagid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "bcac3a84-b8c0-4539-9afa-9b5ffe6120a7", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b72f0cdc-fe54-4224-a53b-fc873f237791", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e6876aaf-91a3-49ea-84d4-89f7973c732b", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c2fd3512-5580-43f9-9f2b-c1e8dd2f826b", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "85ef9a7a-7918-4eac-8008-0e744ceaefbe", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "6ab0ce72-52ee-4489-85ad-42e5a240ec36", "name": "/settings/contacts/teams", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Teams including the Groups in each Team.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/contacts/teams", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "teams" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,code,groupid" }, { "description": { "content": "Search by team name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"code\": \"\u003cstring\u003e\",\n \"groupid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"code\": \"\u003cstring\u003e\",\n \"groupid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "246b6e5d-16a2-4136-894d-a0e65e2412b8", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "teams" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,code,groupid" }, { "description": { "content": "Search by team name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "57094898-4c4e-48c2-9c68-2a95ae519ca8", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "teams" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,code,groupid" }, { "description": { "content": "Search by team name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "19616aa5-a421-46b0-9f2c-edfaf3c82994", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "teams" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,code,groupid" }, { "description": { "content": "Search by team name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d696595e-cc76-42c4-a429-796410c734b2", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "teams" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,code,groupid" }, { "description": { "content": "Search by team name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "3ea560a8-6d6a-4ad2-9ef6-06c7d2074bef", "name": "/settings/contacts/teams", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"code\": \"\u003cstring\u003e\",\n \"groupids\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Creates a new team.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/settings/contacts/teams", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "teams" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9d99f189-1514-4339-a04e-dfbfd68783fe", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"code\": \"\u003cstring\u003e\",\n \"groupids\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "teams" ], "query": [], "variable": [] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a0c5febd-911b-4ea2-9dc5-1ffec8b21360", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"code\": \"\u003cstring\u003e\",\n \"groupids\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "teams" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "0456c967-cd27-407d-9cfe-9b964ef759de", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"code\": \"\u003cstring\u003e\",\n \"groupids\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "teams" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a614bfcd-7d79-4735-a70a-e7c8e95ff9b8", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"code\": \"\u003cstring\u003e\",\n \"groupids\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "teams" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "a9bab8ca-2e49-4a29-a27f-812d27cac59e", "name": "/settings/contacts/teams/:teamid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns details of a single Team including the Groups in the Team.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/contacts/teams/:teamid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "teams", ":teamid" ], "query": [], "variable": [ { "description": { "content": "(Required) Team ID", "type": "text/plain" }, "disabled": false, "key": "teamid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"code\": \"\u003cstring\u003e\",\n \"groupid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "81d7e558-4c0a-43d2-8c79-7da06396b44d", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "teams", ":teamid" ], "query": [], "variable": [ { "description": { "content": "(Required) Team ID", "type": "text/plain" }, "disabled": false, "key": "teamid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7e992406-910c-46a3-8cda-174cc2386b59", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "teams", ":teamid" ], "query": [], "variable": [ { "description": { "content": "(Required) Team ID", "type": "text/plain" }, "disabled": false, "key": "teamid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "fbc694ac-8b88-4334-a556-8f2e3a0f3b25", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "teams", ":teamid" ], "query": [], "variable": [ { "description": { "content": "(Required) Team ID", "type": "text/plain" }, "disabled": false, "key": "teamid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "27ba24d2-3b7e-4bca-b8cf-f7d42ba90d3a", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "teams", ":teamid" ], "query": [], "variable": [ { "description": { "content": "(Required) Team ID", "type": "text/plain" }, "disabled": false, "key": "teamid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "aa5104aa-aa68-4e7b-827c-6f4fc239ea9a", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "teams", ":teamid" ], "query": [], "variable": [ { "description": { "content": "(Required) Team ID", "type": "text/plain" }, "disabled": false, "key": "teamid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "b3f3f7b8-b3b6-4c2e-9200-1c3e9cc518b0", "name": "/settings/contacts/teams/:teamid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"code\": \"\u003cstring\u003e\",\n \"groupids\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Updates a team.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/settings/contacts/teams/:teamid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "teams", ":teamid" ], "query": [], "variable": [ { "description": { "content": "(Required) Team ID", "type": "text/plain" }, "disabled": false, "key": "teamid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3aca4e45-d014-4c47-a13e-7a1b91c8f31e", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"code\": \"\u003cstring\u003e\",\n \"groupids\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "teams", ":teamid" ], "query": [], "variable": [ { "description": { "content": "(Required) Team ID", "type": "text/plain" }, "disabled": false, "key": "teamid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2699291c-170e-4fb5-8eda-b48c5d1cc4c9", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"code\": \"\u003cstring\u003e\",\n \"groupids\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "teams", ":teamid" ], "query": [], "variable": [ { "description": { "content": "(Required) Team ID", "type": "text/plain" }, "disabled": false, "key": "teamid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b8938027-7287-40ef-bfaa-01f5c05e6d4d", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"code\": \"\u003cstring\u003e\",\n \"groupids\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "teams", ":teamid" ], "query": [], "variable": [ { "description": { "content": "(Required) Team ID", "type": "text/plain" }, "disabled": false, "key": "teamid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e37a425d-2944-4b39-8488-9b1ef913f30e", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"code\": \"\u003cstring\u003e\",\n \"groupids\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "teams", ":teamid" ], "query": [], "variable": [ { "description": { "content": "(Required) Team ID", "type": "text/plain" }, "disabled": false, "key": "teamid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a7f0dee5-e7ed-44a4-812b-cae3bc245824", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"code\": \"\u003cstring\u003e\",\n \"groupids\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "teams", ":teamid" ], "query": [], "variable": [ { "description": { "content": "(Required) Team ID", "type": "text/plain" }, "disabled": false, "key": "teamid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "80d43371-9dba-4076-bfe3-c87babbdf457", "name": "/settings/contacts/teams/:teamid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Deletes a team.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/settings/contacts/teams/:teamid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "teams", ":teamid" ], "query": [], "variable": [ { "description": { "content": "(Required) Team ID", "type": "text/plain" }, "disabled": false, "key": "teamid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "db9fe19b-aea4-43f2-93de-b8254d4f32ea", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "teams", ":teamid" ], "query": [], "variable": [ { "description": { "content": "(Required) Team ID", "type": "text/plain" }, "disabled": false, "key": "teamid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "63858ccf-e8f7-4e9d-9c94-d3b02dbc223d", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "teams", ":teamid" ], "query": [], "variable": [ { "description": { "content": "(Required) Team ID", "type": "text/plain" }, "disabled": false, "key": "teamid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "baca7e75-83e9-4cc4-8dbd-2020a004e326", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "teams", ":teamid" ], "query": [], "variable": [ { "description": { "content": "(Required) Team ID", "type": "text/plain" }, "disabled": false, "key": "teamid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f30debf0-5abd-4615-b75d-a94edacc6ba4", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "teams", ":teamid" ], "query": [], "variable": [ { "description": { "content": "(Required) Team ID", "type": "text/plain" }, "disabled": false, "key": "teamid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "df216c8e-6b21-4272-a308-8a417ed65069", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "contacts", "teams", ":teamid" ], "query": [], "variable": [ { "description": { "content": "(Required) Team ID", "type": "text/plain" }, "disabled": false, "key": "teamid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "7df44b85-111e-44ba-a3a0-da40a3e7b114", "name": "/settings/invoices/autonumbering", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns the Invoices Autonumbering settings including mask, count, and placeholder.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/invoices/autonumbering", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "invoices", "autonumbering" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"autoinvoicenumber\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoicenumbercount\": \"\u003cinteger\u003e\",\n \"invoicenumbermask\": \"\u003cstring\u003e\",\n \"invoicenumberplaceholder\": \"\u003cstring\u003e\"\n },\n {\n \"autoinvoicenumber\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoicenumbercount\": \"\u003cinteger\u003e\",\n \"invoicenumbermask\": \"\u003cstring\u003e\",\n \"invoicenumberplaceholder\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "adbe0104-d674-4330-bd5e-0911f65a6cb7", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "invoices", "autonumbering" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3f2741df-02f4-401b-af0f-8b9a380eeca8", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "invoices", "autonumbering" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "473ed449-f27d-43e9-9d5a-cd313f07dad6", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "invoices", "autonumbering" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d3d93f82-e18d-4c63-8891-55a6960b9c20", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "invoices", "autonumbering" ], "query": [], "variable": [] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ed7c03fd-5b9a-412a-a4c6-02482ca04df7", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "invoices", "autonumbering" ], "query": [], "variable": [] } }, "status": "Not Found" } ] }, { "event": [], "id": "7d0cc8af-ffa4-4252-b3b3-253bb8bc4628", "name": "/settings/invoices/templates/:templateid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns detailed information about a single Invoice Template, including phases and line items.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/invoices/templates/:templateid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "invoices", "templates", ":templateid" ], "query": [], "variable": [ { "description": { "content": "(Required) Template ID", "type": "text/plain" }, "disabled": false, "key": "templateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"clientcontactname\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"customfieldname\": \"\u003cstring\u003e\",\n \"customfieldvalue\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"emaileddate\": \"\u003cstring\u003e\",\n \"emailedto\": \"\u003cstring\u003e\",\n \"emailedtoclient\": \"\u003cboolean\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoicedby\": \"\u003cstring\u003e\",\n \"invoiceddate\": \"\u003cstring\u003e\",\n \"invoicetermid\": \"\u003cinteger\u003e\",\n \"itemsDiscount\": \"\u003cnumber\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"pagetitle\": \"\u003cstring\u003e\",\n \"paid\": \"\u003cboolean\u003e\",\n \"paiddate\": \"\u003cstring\u003e\",\n \"paymentterms\": \"\u003cstring\u003e\",\n \"phases\": [\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n }\n ],\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n },\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n }\n ],\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n }\n ],\n \"projectid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"projectnumbers\": \"\u003cstring\u003e\",\n \"projecttitles\": \"\u003cstring\u003e\",\n \"purchaseordernumber\": \"\u003cstring\u003e\",\n \"showcostbreakdown\": \"\u003cboolean\u003e\",\n \"showitemdescription\": \"\u003cboolean\u003e\",\n \"showphases\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"taxable\": \"\u003cboolean\u003e\",\n \"taxrate\": \"\u003cnumber\u003e\",\n \"taxtotal\": \"\u003cnumber\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6dee0c37-27c7-4e0f-998d-0afeb967bc4c", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "invoices", "templates", ":templateid" ], "query": [], "variable": [ { "description": { "content": "(Required) Template ID", "type": "text/plain" }, "disabled": false, "key": "templateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4135b1ff-e745-4a3f-a4a1-b3d95a7fa8b3", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "invoices", "templates", ":templateid" ], "query": [], "variable": [ { "description": { "content": "(Required) Template ID", "type": "text/plain" }, "disabled": false, "key": "templateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "893daff6-0207-40bb-aebe-cd5cf659bee5", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "invoices", "templates", ":templateid" ], "query": [], "variable": [ { "description": { "content": "(Required) Template ID", "type": "text/plain" }, "disabled": false, "key": "templateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "99fb59e3-a728-4464-8402-00552571b3bc", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "invoices", "templates", ":templateid" ], "query": [], "variable": [ { "description": { "content": "(Required) Template ID", "type": "text/plain" }, "disabled": false, "key": "templateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ed425395-0135-4401-9385-e11bf1dbc2d9", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "invoices", "templates", ":templateid" ], "query": [], "variable": [ { "description": { "content": "(Required) Template ID", "type": "text/plain" }, "disabled": false, "key": "templateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "e879a00d-2f76-4442-9e43-3976e6fbde9b", "name": "/settings/items/categories", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Item Categories.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/items/categories", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "categories" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,color,sortorder,lastmodifiedutc" }, { "description": { "content": "Search by category name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "66e71266-3077-45f5-81f1-6ac8e36f45cf", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "categories" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,color,sortorder,lastmodifiedutc" }, { "description": { "content": "Search by category name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6282b773-eced-4a31-af1e-7ff36bd647f8", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "categories" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,color,sortorder,lastmodifiedutc" }, { "description": { "content": "Search by category name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "77b736c6-f0bd-4ba0-8f6c-68f5f12d6401", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "categories" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,color,sortorder,lastmodifiedutc" }, { "description": { "content": "Search by category name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "eb0b30f9-9b82-4ec0-a554-248c2e7dadbf", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "categories" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,color,sortorder,lastmodifiedutc" }, { "description": { "content": "Search by category name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "f538cc30-d552-4244-973f-6619666a9a5c", "name": "/settings/items/categories", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Creates a new Item Category.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/settings/items/categories", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "categories" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a1d69fde-4740-4525-9d39-05b5b628f777", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "categories" ], "query": [], "variable": [] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b310d931-9283-4039-bbe3-7a61de377421", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "categories" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c08b0f0b-d64f-4adc-9dfb-a42b18b73e56", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "categories" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "89bbcfff-6d9a-4853-841e-32d8ddfa5b93", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "categories" ], "query": [], "variable": [] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4618a84a-4481-4b1e-bf26-c28916b8dbf5", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "categories" ], "query": [], "variable": [] } }, "status": "Not Found" } ] }, { "event": [], "id": "8825c66f-1673-4b7c-b56e-a1da08ae0e89", "name": "/settings/items/categories/:categoryid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns details of a single Item Category.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/items/categories/:categoryid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "categories", ":categoryid" ], "query": [], "variable": [ { "description": { "content": "(Required) Category ID", "type": "text/plain" }, "disabled": false, "key": "categoryid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8bc60a4f-05e4-4cc6-a00b-f4f83f7af137", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "categories", ":categoryid" ], "query": [], "variable": [ { "description": { "content": "(Required) Category ID", "type": "text/plain" }, "disabled": false, "key": "categoryid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d698a720-9fe2-43b8-ae31-59e36669cbf9", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "categories", ":categoryid" ], "query": [], "variable": [ { "description": { "content": "(Required) Category ID", "type": "text/plain" }, "disabled": false, "key": "categoryid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c043f9b3-6808-4ec6-bb4a-36f7e69e4b5a", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "categories", ":categoryid" ], "query": [], "variable": [ { "description": { "content": "(Required) Category ID", "type": "text/plain" }, "disabled": false, "key": "categoryid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5df61572-63f1-4048-b514-69584a20a2e2", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "categories", ":categoryid" ], "query": [], "variable": [ { "description": { "content": "(Required) Category ID", "type": "text/plain" }, "disabled": false, "key": "categoryid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f1583847-028a-4375-8da8-c74cdf5ae5d3", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "categories", ":categoryid" ], "query": [], "variable": [ { "description": { "content": "(Required) Category ID", "type": "text/plain" }, "disabled": false, "key": "categoryid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "007147b0-91c6-4668-9dfc-f9ca9b41c484", "name": "/settings/items/categories/:categoryid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Updates an Item Category.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/settings/items/categories/:categoryid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "categories", ":categoryid" ], "query": [], "variable": [ { "description": { "content": "(Required) Category ID", "type": "text/plain" }, "disabled": false, "key": "categoryid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5e0b1548-31c1-4a06-b4a5-497ae2f59514", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "categories", ":categoryid" ], "query": [], "variable": [ { "description": { "content": "(Required) Category ID", "type": "text/plain" }, "disabled": false, "key": "categoryid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "78921ed7-99ce-43b2-82a2-62c174366d29", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "categories", ":categoryid" ], "query": [], "variable": [ { "description": { "content": "(Required) Category ID", "type": "text/plain" }, "disabled": false, "key": "categoryid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "027bb970-431f-424a-a8d2-56823ea665db", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "categories", ":categoryid" ], "query": [], "variable": [ { "description": { "content": "(Required) Category ID", "type": "text/plain" }, "disabled": false, "key": "categoryid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a85a5123-b375-4f88-a7c3-b1654ac8aa8c", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "categories", ":categoryid" ], "query": [], "variable": [ { "description": { "content": "(Required) Category ID", "type": "text/plain" }, "disabled": false, "key": "categoryid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9b873266-a587-455b-83cf-0a784a3313af", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "categories", ":categoryid" ], "query": [], "variable": [ { "description": { "content": "(Required) Category ID", "type": "text/plain" }, "disabled": false, "key": "categoryid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "fc64a0be-68da-48ee-8b0b-631e85a97b51", "name": "/settings/items/categories/:categoryid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Soft deletes an Item Category.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/settings/items/categories/:categoryid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "categories", ":categoryid" ], "query": [], "variable": [ { "description": { "content": "(Required) Category ID", "type": "text/plain" }, "disabled": false, "key": "categoryid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "cbb18593-9fd7-4ebf-aa5d-74c1ab82f7e8", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "categories", ":categoryid" ], "query": [], "variable": [ { "description": { "content": "(Required) Category ID", "type": "text/plain" }, "disabled": false, "key": "categoryid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ecf2c802-97a3-4b7c-9cae-c6af32134d0f", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "categories", ":categoryid" ], "query": [], "variable": [ { "description": { "content": "(Required) Category ID", "type": "text/plain" }, "disabled": false, "key": "categoryid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "831daa6d-7ee3-4a3f-91b2-1abfbaca6926", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "categories", ":categoryid" ], "query": [], "variable": [ { "description": { "content": "(Required) Category ID", "type": "text/plain" }, "disabled": false, "key": "categoryid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "60b4a22e-8598-4a5f-a72a-9ab78863f214", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "categories", ":categoryid" ], "query": [], "variable": [ { "description": { "content": "(Required) Category ID", "type": "text/plain" }, "disabled": false, "key": "categoryid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "1ce20caf-893a-4640-9949-2e8c4df92907", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "categories", ":categoryid" ], "query": [], "variable": [ { "description": { "content": "(Required) Category ID", "type": "text/plain" }, "disabled": false, "key": "categoryid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "5ea30938-2984-4538-bcd7-692fe3c80da2", "name": "/settings/items/tags", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Item Tags.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/items/tags", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "tags" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "78a7b1e2-f515-40c7-8aa7-6b522533aa63", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "tags" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7a012c5b-ecf2-4c69-8079-eb831b9dc5e7", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "tags" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4dd24d6f-675f-440f-858a-b1bb99370a17", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "tags" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "db82fab8-1110-49c6-a47c-1ef96662869f", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "tags" ], "query": [], "variable": [] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "de41f125-2781-410c-884c-7484bc012088", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "tags" ], "query": [], "variable": [] } }, "status": "Not Found" } ] }, { "event": [], "id": "c2920bca-801d-449c-88c8-2420b00667b4", "name": "/settings/items/tags", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Creates a new Item Tag.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/settings/items/tags", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "tags" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "01e42cc2-4f07-4a14-ab47-61d8c96f5c88", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "tags" ], "query": [], "variable": [] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "39af2e4f-9672-48f1-afbf-ab296aaa08a6", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "tags" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "20962ed0-6fc1-4428-96ec-52cb1dddbbc1", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "tags" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5c3cba46-7d8b-4d9b-92c4-23cde1d9843f", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "tags" ], "query": [], "variable": [] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a664dfb2-dbf2-4648-8e66-46e558e96e37", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "tags" ], "query": [], "variable": [] } }, "status": "Not Found" } ] }, { "event": [], "id": "7445e86f-b890-4f0f-927a-215ed9f56a35", "name": "/settings/items/tags/items", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"itemid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Adds one or more Items (Tasks) to one or more Task Tags.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/settings/items/tags/items", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "tags", "items" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c61de31f-54ab-4b3f-a66d-1137cad07fe0", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"itemid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "tags", "items" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "af11f43e-1808-4b07-b96f-a28c022d2441", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"itemid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "tags", "items" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c7e4f6c6-8fce-45a5-9f5c-fa916459f297", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"itemid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "tags", "items" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "45b543dc-8bf2-44d0-9789-58ea5b43c6a1", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"itemid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "tags", "items" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "e3d559df-4a67-4ee9-98e3-c19dc213e523", "name": "/settings/items/tags/items", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"itemid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Removes one or more Items (Tasks) from one or more Task Tags.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/settings/items/tags/items", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "tags", "items" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d36411a5-a671-4f7a-be98-4c20d2801fdb", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"itemid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "tags", "items" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "16600c0f-58aa-426c-821c-699b367c1b06", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"itemid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "tags", "items" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d449ea96-4ca8-427c-9c63-8c2ed896d9cf", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"itemid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "tags", "items" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6676c13d-2341-4dc2-8027-95b31e6b72cd", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"id\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"itemid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "tags", "items" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "736998ba-0bb6-4a42-84da-8ee0f11b0c35", "name": "/settings/items/tags/:tagid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns details of a single Item Tag.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/items/tags/:tagid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "eb9b33aa-5d32-4d93-9b88-d1522f42546b", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ecfb81d1-48d1-48e3-922d-82121e64febd", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7d13e80b-11c4-481e-acdf-22e29c56874e", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9d8f5be4-7dce-47ca-a4d7-2f72b0d92ad6", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2145eddc-1b0d-4836-9069-ed0dc4ada4e5", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "08efc8da-2319-434b-bc15-0d4b395bb347", "name": "/settings/items/tags/:tagid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Updates an Item Tag.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/settings/items/tags/:tagid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7842c2a3-2b34-4f45-96ea-3d61b4f40d01", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6ccb0ff6-a389-4ae9-8b80-9e3245b39a9d", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "573fca9c-3645-4401-845c-cca1823e1ce6", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "103ede56-43a4-4e60-acff-22482d3520ef", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c7143afc-2aab-42a1-89a1-6b68951ff01a", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "92572d96-4d4d-4ffd-bcb2-2778055b2622", "name": "/settings/items/tags/:tagid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Soft deletes an Item Tag.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/settings/items/tags/:tagid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "009cf44c-6a53-4bdc-a246-2c417f0b0279", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "605101e7-fc62-4e9f-9b36-f258a1f790b4", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "0e6a3b56-769c-4ffb-87fa-7ebb584f2bc0", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "15f0b122-6ec6-4b4e-a278-f360765a9067", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ce3bcca5-f981-4185-939b-4bec74599c9a", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "items", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "850c1d3e-bb6a-4704-b1e9-cb1c0b0dca0b", "name": "/settings/product/fixedprice", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of products from the Fixed Price Library. These are products charged at a set price per unit (ItemType hasLabour=0, hasQuantity=1). Price fields (inUnitPrice, outUnitPrice) are excluded for security.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/product/fixedprice", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "product", "fixedprice" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"color\": \"\u003cstring\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"purchasedescription\": \"\u003cstring\u003e\",\n \"saledescription\": \"\u003cstring\u003e\"\n },\n {\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"color\": \"\u003cstring\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"purchasedescription\": \"\u003cstring\u003e\",\n \"saledescription\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "cd104ae6-342c-40a3-b08a-4ab3a5bfc0c5", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "product", "fixedprice" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c767fa61-800f-4053-9ecd-f90a48f7df6b", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "product", "fixedprice" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5b990b4c-bb2b-46b0-82c1-578ad2cc1024", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "product", "fixedprice" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c7e546c2-ad46-4403-8833-2ceaa690159d", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "product", "fixedprice" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "2efcf4dd-ec23-4368-8e5a-486a221ee6a5", "name": "/settings/product/goodservice", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of products from the Goods and Services Library. These are products charged with both a set price and an hourly rate (ItemType hasLabour=1, hasQuantity=1). Price fields (inUnitPrice, outUnitPrice) are excluded for security.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/product/goodservice", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "product", "goodservice" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"color\": \"\u003cstring\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"hourlyrateservicename\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"purchasedescription\": \"\u003cstring\u003e\",\n \"saledescription\": \"\u003cstring\u003e\"\n },\n {\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"color\": \"\u003cstring\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"hourlyrateservicename\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"purchasedescription\": \"\u003cstring\u003e\",\n \"saledescription\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ff9ec71c-7c3b-406d-ac65-55198074af23", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "product", "goodservice" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c4c9e34d-edee-4c25-abcf-a7733989388f", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "product", "goodservice" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "988bd765-ba08-4059-803d-c8a608d0c20f", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "product", "goodservice" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "dea835ab-706e-4789-b496-80eb802dd4dc", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "product", "goodservice" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "5d1ccf43-8eae-4fa1-968b-80f7aa1e498c", "name": "/settings/product/hourlyservice", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of products from the Hourly Services Library. These are products charged at an hourly rate (ItemType hasLabour=1, hasQuantity=0). Price fields (inUnitPrice, outUnitPrice) are excluded for security.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/product/hourlyservice", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "product", "hourlyservice" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"color\": \"\u003cstring\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"hourlyrateservicename\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"purchasedescription\": \"\u003cstring\u003e\",\n \"saledescription\": \"\u003cstring\u003e\"\n },\n {\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"color\": \"\u003cstring\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"hourlyrateservicename\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"purchasedescription\": \"\u003cstring\u003e\",\n \"saledescription\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5e7fd084-fa58-457b-9e23-bbfeea65b073", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "product", "hourlyservice" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "42d64369-54ad-4126-b877-c513b7ebbe69", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "product", "hourlyservice" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d6d3d6cf-6669-4fd6-8ccf-a71dd2d6530b", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "product", "hourlyservice" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "86852133-40fe-4e16-b91b-58e3351138cb", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "product", "hourlyservice" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "749971de-0010-4d12-9503-45b5cf96bbb1", "name": "/settings/projects", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns default Project settings. These can be changed from the main ProWorkflow application.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/projects", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"autoprojectnumber\": \"\u003cstring\u003e\",\n \"emptyprojectcategory\": \"\u003cstring\u003e\",\n \"emptytaskcategory\": \"\u003cstring\u003e\",\n \"enableSubPhases\": \"\u003cboolean\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"projectnumbercount\": \"\u003cinteger\u003e\",\n \"projectnumbermask\": \"\u003cstring\u003e\",\n \"projectnumberplaceholder\": \"\u003cstring\u003e\",\n \"projectnumbertype\": \"\u003cstring\u003e\",\n \"projectvariable\": \"\u003cstring\u003e\",\n \"taskordering\": \"\u003cstring\u003e\"\n },\n {\n \"autoprojectnumber\": \"\u003cstring\u003e\",\n \"emptyprojectcategory\": \"\u003cstring\u003e\",\n \"emptytaskcategory\": \"\u003cstring\u003e\",\n \"enableSubPhases\": \"\u003cboolean\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"projectnumbercount\": \"\u003cinteger\u003e\",\n \"projectnumbermask\": \"\u003cstring\u003e\",\n \"projectnumberplaceholder\": \"\u003cstring\u003e\",\n \"projectnumbertype\": \"\u003cstring\u003e\",\n \"projectvariable\": \"\u003cstring\u003e\",\n \"taskordering\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "1f53626b-075b-4dbe-9256-c80f7e9f1f80", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ca3be2e1-7bf6-4671-a644-587c8c57ed25", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9a9be9a1-3a4d-4ad5-b52d-31044a3e3ff0", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "cd2a3af1-8072-45b9-b0e6-2da717e61b18", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects" ], "query": [], "variable": [] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "45a84ce1-cbe8-49e1-9cb8-d2bf8543c3dc", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects" ], "query": [], "variable": [] } }, "status": "Not Found" } ] }, { "event": [], "id": "d17bf14d-db1d-4cab-8df6-3928a99473f3", "name": "/settings/projects/autonumbering", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns the Projects Autonumbering settings including mask, count, and placeholder.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/projects/autonumbering", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "autonumbering" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"autoprojectnumber\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"projectnumbercount\": \"\u003cinteger\u003e\",\n \"projectnumbermask\": \"\u003cstring\u003e\",\n \"projectnumberplaceholder\": \"\u003cstring\u003e\",\n \"projectnumbertype\": \"\u003cstring\u003e\"\n },\n {\n \"autoprojectnumber\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"projectnumbercount\": \"\u003cinteger\u003e\",\n \"projectnumbermask\": \"\u003cstring\u003e\",\n \"projectnumberplaceholder\": \"\u003cstring\u003e\",\n \"projectnumbertype\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "bf821535-e0dc-4de8-8e75-cc37e43a3628", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "autonumbering" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6aed42c0-e137-4ec0-9851-e6b5e9f32629", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "autonumbering" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b0ef63c1-1590-408a-b232-d8b34facc6ca", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "autonumbering" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e8c5c177-ae60-48d2-a00c-1c66fe6aaa14", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "autonumbering" ], "query": [], "variable": [] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "76853c4e-9afb-4961-b3e4-688093bc90f0", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "autonumbering" ], "query": [], "variable": [] } }, "status": "Not Found" } ] }, { "event": [], "id": "e05b9d5e-d547-4b86-92e6-2af9715b694f", "name": "/settings/projects/categories", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Project Categories.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/projects/categories", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "categories" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,color,sortorder,lastmodifiedutc,projectcount" }, { "description": { "content": "Search by category name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"projectcount\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"projectcount\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ba6e5527-5665-4564-87c4-7a7fb0bb5084", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "categories" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,color,sortorder,lastmodifiedutc,projectcount" }, { "description": { "content": "Search by category name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7b7bfdb8-db09-4ca6-a6a0-867cf567b182", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "categories" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,color,sortorder,lastmodifiedutc,projectcount" }, { "description": { "content": "Search by category name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7fb8100e-7e7e-45ee-95c4-35caef002a34", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "categories" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,color,sortorder,lastmodifiedutc,projectcount" }, { "description": { "content": "Search by category name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "81b6a32d-c920-4ead-92a4-8820fe6522bf", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "categories" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,color,sortorder,lastmodifiedutc,projectcount" }, { "description": { "content": "Search by category name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "ecd8c4b3-c717-43d8-aab9-771e831bc45f", "name": "/settings/projects/categories", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Creates a new Project Category.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/settings/projects/categories", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "categories" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d2073c04-a8f4-4ffe-8727-e7a18a78f4db", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "categories" ], "query": [], "variable": [] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "61cd7066-444b-460e-b764-54c9a85e6d84", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "categories" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "de7a602f-7e98-45dd-926a-1a9cd40dc1cf", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "categories" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ba25baf3-b4c4-449f-b01b-fcedde054333", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "categories" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "aa059c67-408a-44c5-8fae-5516e62f8015", "name": "/settings/projects/categories/:categoryid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns details of a single Project Category.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/projects/categories/:categoryid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "categories", ":categoryid" ], "query": [], "variable": [ { "description": { "content": "(Required) Category ID", "type": "text/plain" }, "disabled": false, "key": "categoryid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"projectcount\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "abe10431-7c47-468c-8efa-fc367bc16a41", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "categories", ":categoryid" ], "query": [], "variable": [ { "description": { "content": "(Required) Category ID", "type": "text/plain" }, "disabled": false, "key": "categoryid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9f3032e8-301e-4b02-ad23-5b1e0a9363f2", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "categories", ":categoryid" ], "query": [], "variable": [ { "description": { "content": "(Required) Category ID", "type": "text/plain" }, "disabled": false, "key": "categoryid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c5b229d3-d6f2-41ba-b37e-6cec07ddf7e4", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "categories", ":categoryid" ], "query": [], "variable": [ { "description": { "content": "(Required) Category ID", "type": "text/plain" }, "disabled": false, "key": "categoryid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "907fdc6f-5e22-46e7-ad1e-a1861977e859", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "categories", ":categoryid" ], "query": [], "variable": [ { "description": { "content": "(Required) Category ID", "type": "text/plain" }, "disabled": false, "key": "categoryid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "762eb7ee-3332-4aa4-9c19-a208e4c22205", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "categories", ":categoryid" ], "query": [], "variable": [ { "description": { "content": "(Required) Category ID", "type": "text/plain" }, "disabled": false, "key": "categoryid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "fbc23813-e72d-45b3-9f63-fc1fbed28732", "name": "/settings/projects/categories/:categoryid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Updates a Project Category.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/settings/projects/categories/:categoryid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "categories", ":categoryid" ], "query": [], "variable": [ { "description": { "content": "(Required) Category ID", "type": "text/plain" }, "disabled": false, "key": "categoryid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "165cfa84-656e-4800-9e5d-f0ffe77bd986", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "categories", ":categoryid" ], "query": [], "variable": [ { "description": { "content": "(Required) Category ID", "type": "text/plain" }, "disabled": false, "key": "categoryid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b039ef59-9859-4156-9e84-b0132b850427", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "categories", ":categoryid" ], "query": [], "variable": [ { "description": { "content": "(Required) Category ID", "type": "text/plain" }, "disabled": false, "key": "categoryid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "67cba7bd-5228-4363-9f2d-d3ff9d3491f0", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "categories", ":categoryid" ], "query": [], "variable": [ { "description": { "content": "(Required) Category ID", "type": "text/plain" }, "disabled": false, "key": "categoryid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b37bc827-c05f-43da-9773-65f549b48517", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "categories", ":categoryid" ], "query": [], "variable": [ { "description": { "content": "(Required) Category ID", "type": "text/plain" }, "disabled": false, "key": "categoryid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "1882e790-0b16-4924-941e-4bdd1e501f03", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"sortorder\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "categories", ":categoryid" ], "query": [], "variable": [ { "description": { "content": "(Required) Category ID", "type": "text/plain" }, "disabled": false, "key": "categoryid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "0fdd4a81-9932-43d1-9afb-8bb631303d82", "name": "/settings/projects/categories/:categoryid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Soft deletes a Project Category.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/settings/projects/categories/:categoryid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "categories", ":categoryid" ], "query": [], "variable": [ { "description": { "content": "(Required) Category ID", "type": "text/plain" }, "disabled": false, "key": "categoryid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "05701d29-1a7a-4be3-bb1b-ed4d40a2aa7c", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "categories", ":categoryid" ], "query": [], "variable": [ { "description": { "content": "(Required) Category ID", "type": "text/plain" }, "disabled": false, "key": "categoryid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "50538be0-5fe0-40f8-8bfa-17c077a2a22d", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "categories", ":categoryid" ], "query": [], "variable": [ { "description": { "content": "(Required) Category ID", "type": "text/plain" }, "disabled": false, "key": "categoryid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7faca98c-84a9-4725-93e2-dc911b9e1806", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "categories", ":categoryid" ], "query": [], "variable": [ { "description": { "content": "(Required) Category ID", "type": "text/plain" }, "disabled": false, "key": "categoryid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6655f0ab-ee79-4ad9-8809-6d19640d954e", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "categories", ":categoryid" ], "query": [], "variable": [ { "description": { "content": "(Required) Category ID", "type": "text/plain" }, "disabled": false, "key": "categoryid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "38fad0b9-d20b-4182-a0a6-555649a33343", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "categories", ":categoryid" ], "query": [], "variable": [ { "description": { "content": "(Required) Category ID", "type": "text/plain" }, "disabled": false, "key": "categoryid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "0ccabc6e-a96e-439f-b9b9-3302a0f2b1ab", "name": "/settings/projects/tags", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Project Tags.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/projects/tags", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "tags" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,color,lastmodifiedutc" }, { "description": { "content": "Search by tag name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f0171a73-6d39-4141-8c49-186a06fa6be3", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "tags" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,color,lastmodifiedutc" }, { "description": { "content": "Search by tag name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b6bf7d08-d5fd-4184-856f-53280e9eb91d", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "tags" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,color,lastmodifiedutc" }, { "description": { "content": "Search by tag name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "16f8b615-4a31-4bbc-b130-36164046c11d", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "tags" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,color,lastmodifiedutc" }, { "description": { "content": "Search by tag name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6c47acef-d252-4564-b574-e7e926f41f21", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "tags" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,color,lastmodifiedutc" }, { "description": { "content": "Search by tag name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "6c93f41d-2f8c-414f-ba71-e2235f54ff2a", "name": "/settings/projects/tags", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Creates a new Project Tag.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/settings/projects/tags", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "tags" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3e2f49c4-b16f-4437-8ec8-5046955f4a01", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "tags" ], "query": [], "variable": [] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c4f28a7a-8bad-4ed4-bf69-ce8fd33b92f5", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "tags" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e17ea441-cea6-4e8b-bfbf-f6483e1e5dd3", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "tags" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a4a3d8ab-f1da-4d62-b774-88091cb05618", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "tags" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "191b32a3-6b07-42b6-8c6b-4723a49757a9", "name": "/settings/projects/tags/:tagid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns details of a single Project Tag.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/projects/tags/:tagid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "82a74ec6-87f6-4b4f-9abd-7e4f92a71257", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7c83da0e-be6d-4829-9082-13fef049833e", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "19d76907-6558-49fc-b99e-6bc88e81b9cf", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "37c41bb2-9b80-44d7-abb9-74db0069e003", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "90a9ee09-04dd-47d3-97d0-f5a4587b5c21", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "8e6b6936-8354-44c6-8d1e-675b39216925", "name": "/settings/projects/tags/:tagid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Updates a Project Tag.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/settings/projects/tags/:tagid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "997c3f71-74d4-4d56-95b4-7664a7ee0a6b", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "757373be-4500-426e-8d11-c97aefd47cce", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "22845eff-01c9-4190-b296-17250d867d40", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "bb502691-280d-49fa-9eb6-a25e54693e20", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4093067d-2031-45e2-bfb1-1c8f6873a623", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"color\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "a8f3ed06-30d5-470b-bf62-b71cfcd17724", "name": "/settings/projects/tags/:tagid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Soft deletes a Project Tag.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/settings/projects/tags/:tagid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9d0d50da-3414-49c9-97d3-05bdb17df6de", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "07bbe7cd-cde1-40fc-8328-6a07982ecd6f", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "210fc7bb-d26b-4c26-9038-0e4a49e05ed0", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "055ef42d-40ac-4f49-902e-16d7b4c2cb09", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "1bfc21e8-442b-4493-a743-58bdf4c058ce", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "tags", ":tagid" ], "query": [], "variable": [ { "description": { "content": "(Required) Tag ID", "type": "text/plain" }, "disabled": false, "key": "tagid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "261867d8-f72c-42a6-93be-af5aed842a22", "name": "/settings/projects/templates/:projecttemplateid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns detailed information about a single Project Template, including tasks.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/projects/templates/:projecttemplateid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates", ":projecttemplateid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project Template ID", "type": "text/plain" }, "disabled": false, "key": "projecttemplateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"actualInLabour\": \"\u003cnumber\u003e\",\n \"actualInTotal\": \"\u003cnumber\u003e\",\n \"actualInTotalTax\": \"\u003cnumber\u003e\",\n \"actualOutLabour\": \"\u003cnumber\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billtotal\": \"\u003cnumber\u003e\",\n \"bookmarks\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"url\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"url\": \"\u003cstring\u003e\"\n }\n ],\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"burn\": \"\u003cnumber\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"categoryname\": \"\u003cstring\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"clientaccess\": \"\u003cboolean\u003e\",\n \"clientid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"clients\": [\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"clienttype\": \"\u003cstring\u003e\",\n \"clientviewalltasks\": \"\u003cboolean\u003e\",\n \"clientviewtime\": \"\u003cboolean\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"contractorid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"contractors\": [\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"createdate\": \"\u003cstring\u003e\",\n \"customfieldoptionid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"customfields\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"value\": \"\u003cstring\u003e\",\n \"valuename\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"value\": \"\u003cstring\u003e\",\n \"valuename\": \"\u003cstring\u003e\"\n }\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"estBillAmount\": \"\u003cnumber\u003e\",\n \"estBillAmountTax\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"files\": [\n {\n \"description\": \"\u003cstring\u003e\",\n \"folderid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"modified\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"uniquetoken\": \"\u003cstring\u003e\"\n },\n {\n \"description\": \"\u003cstring\u003e\",\n \"folderid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"modified\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"uniquetoken\": \"\u003cstring\u003e\"\n }\n ],\n \"folders\": [\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"modified\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"modified\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"taskid\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"groupid\": \"\u003cinteger\u003e\",\n \"groupname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"internalclientcontactid\": \"\u003cinteger\u003e\",\n \"internalclientgroupid\": \"\u003cinteger\u003e\",\n \"internalclientgroupname\": \"\u003cstring\u003e\",\n \"internalclientteamid\": \"\u003cinteger\u003e\",\n \"internalclientteamname\": \"\u003cstring\u003e\",\n \"invoiced\": \"\u003cboolean\u003e\",\n \"invoicedAmount\": \"\u003cnumber\u003e\",\n \"invoicedAmountTax\": \"\u003cnumber\u003e\",\n \"invoices\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoicedate\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"paid\": \"\u003cboolean\u003e\",\n \"paiddate\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoicedate\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"paid\": \"\u003cboolean\u003e\",\n \"paiddate\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\"\n }\n ],\n \"invoicetotal\": \"\u003cnumber\u003e\",\n \"itemDueDate\": \"\u003cstring\u003e\",\n \"itemStartDate\": \"\u003cstring\u003e\",\n \"itemsActive\": \"\u003cinteger\u003e\",\n \"itemsCompleted\": \"\u003cinteger\u003e\",\n \"itemsDiscount\": \"\u003cnumber\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"managerfirstname\": \"\u003cstring\u003e\",\n \"managerid\": \"\u003cinteger\u003e\",\n \"managerlastname\": \"\u003cstring\u003e\",\n \"messages\": [\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"replycount\": \"\u003cinteger\u003e\",\n \"senddate\": \"\u003cstring\u003e\",\n \"senderid\": \"\u003cinteger\u003e\",\n \"shortdetails\": \"\u003cstring\u003e\",\n \"subject\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"replycount\": \"\u003cinteger\u003e\",\n \"senddate\": \"\u003cstring\u003e\",\n \"senderid\": \"\u003cinteger\u003e\",\n \"shortdetails\": \"\u003cstring\u003e\",\n \"subject\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"notification\": \"\u003cboolean\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"paid\": \"\u003cboolean\u003e\",\n \"paidAmountTax\": \"\u003cnumber\u003e\",\n \"paidamount\": \"\u003cnumber\u003e\",\n \"percentcomplete\": \"\u003cinteger\u003e\",\n \"phases\": [\n {\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n }\n ],\n \"name\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n },\n {\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n }\n ],\n \"name\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\"\n }\n ],\n \"priority\": \"\u003cinteger\u003e\",\n \"privatenotes\": \"\u003cstring\u003e\",\n \"projectedBillAmount\": \"\u003cnumber\u003e\",\n \"projectedBillAmountTax\": \"\u003cnumber\u003e\",\n \"projectedGrossMargin\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"projectedTimeManual\": \"\u003cnumber\u003e\",\n \"projectedTimeSpent\": \"\u003cnumber\u003e\",\n \"projectnotes\": [\n {\n \"content\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n },\n {\n \"content\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n }\n ],\n \"purchaseorder\": \"\u003cstring\u003e\",\n \"staff\": [\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\"\n }\n ],\n \"staffid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"staffviewalltasks\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cnumber\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"tags\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\"\n }\n ],\n \"teamid\": \"\u003cinteger\u003e\",\n \"teamname\": \"\u003cstring\u003e\",\n \"template\": \"\u003cboolean\u003e\",\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\",\n \"timerecords\": [\n {\n \"accountedfor\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"endtime\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"notes\": \"\u003cstring\u003e\",\n \"running\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n },\n {\n \"accountedfor\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"endtime\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"notes\": \"\u003cstring\u003e\",\n \"running\": \"\u003cboolean\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n }\n ],\n \"timetracked\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\",\n \"workstagename\": \"\u003cstring\u003e\",\n \"workstages\": [\n {\n \"active\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"setdatetime\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\"\n },\n {\n \"active\": \"\u003cboolean\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"setdatetime\": \"\u003cstring\u003e\",\n \"workstageid\": \"\u003cinteger\u003e\"\n }\n ]\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "bbb68631-794c-4cfe-9420-a353afe5e900", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates", ":projecttemplateid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project Template ID", "type": "text/plain" }, "disabled": false, "key": "projecttemplateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "88c97419-fb0b-4fec-bd33-e5b34869e7d6", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates", ":projecttemplateid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project Template ID", "type": "text/plain" }, "disabled": false, "key": "projecttemplateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3bf44ed1-bd20-4bdd-85dc-c1137336c919", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates", ":projecttemplateid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project Template ID", "type": "text/plain" }, "disabled": false, "key": "projecttemplateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4568d2d8-867a-4f41-bf4f-529cec67c2d3", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates", ":projecttemplateid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project Template ID", "type": "text/plain" }, "disabled": false, "key": "projecttemplateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "14e8e88f-8389-4958-8143-a83c7afedf16", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates", ":projecttemplateid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project Template ID", "type": "text/plain" }, "disabled": false, "key": "projecttemplateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "bf6213f9-96df-42ee-8b98-8ae13459d80f", "name": "/settings/projects/templates/:projecttemplateid/items", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns line items for a specific project template.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/projects/templates/:projecttemplateid/items", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates", ":projecttemplateid", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,itemcollectionid,parentid,itemtypeid,activeworkstate" }, { "description": { "content": "Search by item name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to items within a specific phase (itemcollectionid)", "type": "text/plain" }, "disabled": true, "key": "phaseid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by parent item ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by item type ID", "type": "text/plain" }, "disabled": true, "key": "itemtypeid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project Template ID", "type": "text/plain" }, "disabled": false, "key": "projecttemplateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"createdatetime\": \"\u003cstring\u003e\",\n \"creatorid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"dependenttaskid\": \"\u003cstring\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"discountRate\": \"\u003cnumber\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScoreId\": \"\u003cinteger\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"impactScoreId\": \"\u003cinteger\u003e\",\n \"importanceScoreId\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inTaxRate\": \"\u003cnumber\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"isDiscountPercent\": \"\u003cboolean\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outTaxRate\": \"\u003cnumber\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"prerequisiteid\": \"\u003cstring\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cnumber\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\",\n \"timespent\": \"\u003cnumber\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\",\n \"uniquetoken\": \"\u003cstring\u003e\",\n \"urgencyScoreId\": \"\u003cinteger\u003e\"\n },\n {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"createdatetime\": \"\u003cstring\u003e\",\n \"creatorid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"dependenttaskid\": \"\u003cstring\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"discountRate\": \"\u003cnumber\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScoreId\": \"\u003cinteger\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"impactScoreId\": \"\u003cinteger\u003e\",\n \"importanceScoreId\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inTaxRate\": \"\u003cnumber\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"isDiscountPercent\": \"\u003cboolean\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outTaxRate\": \"\u003cnumber\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"prerequisiteid\": \"\u003cstring\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cnumber\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\",\n \"timespent\": \"\u003cnumber\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\",\n \"uniquetoken\": \"\u003cstring\u003e\",\n \"urgencyScoreId\": \"\u003cinteger\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4db015f5-c040-466b-b872-ec78afb1bdcb", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates", ":projecttemplateid", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,itemcollectionid,parentid,itemtypeid,activeworkstate" }, { "description": { "content": "Search by item name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to items within a specific phase (itemcollectionid)", "type": "text/plain" }, "disabled": true, "key": "phaseid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by parent item ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by item type ID", "type": "text/plain" }, "disabled": true, "key": "itemtypeid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project Template ID", "type": "text/plain" }, "disabled": false, "key": "projecttemplateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "56332f22-f326-4f4b-bb1c-2856b09397e7", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates", ":projecttemplateid", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,itemcollectionid,parentid,itemtypeid,activeworkstate" }, { "description": { "content": "Search by item name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to items within a specific phase (itemcollectionid)", "type": "text/plain" }, "disabled": true, "key": "phaseid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by parent item ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by item type ID", "type": "text/plain" }, "disabled": true, "key": "itemtypeid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project Template ID", "type": "text/plain" }, "disabled": false, "key": "projecttemplateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "0b01605b-d87f-4ae1-ad37-a8057105c024", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates", ":projecttemplateid", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,itemcollectionid,parentid,itemtypeid,activeworkstate" }, { "description": { "content": "Search by item name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to items within a specific phase (itemcollectionid)", "type": "text/plain" }, "disabled": true, "key": "phaseid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by parent item ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by item type ID", "type": "text/plain" }, "disabled": true, "key": "itemtypeid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project Template ID", "type": "text/plain" }, "disabled": false, "key": "projecttemplateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2c0a144d-2789-46e1-ac98-a5714324b52b", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates", ":projecttemplateid", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,itemcollectionid,parentid,itemtypeid,activeworkstate" }, { "description": { "content": "Search by item name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to items within a specific phase (itemcollectionid)", "type": "text/plain" }, "disabled": true, "key": "phaseid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by parent item ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by item type ID", "type": "text/plain" }, "disabled": true, "key": "itemtypeid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" } ], "variable": [ { "description": { "content": "(Required) Project Template ID", "type": "text/plain" }, "disabled": false, "key": "projecttemplateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] }, { "event": [], "id": "e2ca2bf6-4f3b-4196-b0d0-4a4951de3b78", "name": "/settings/projects/templates/:projecttemplateid/phases", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns phases (item collections) for a specific project template.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/projects/templates/:projecttemplateid/phases", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates", ":projecttemplateid", "phases" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,itemcollectiontemplateid,parentid,billAmount" }, { "description": { "content": "Search by phase name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to phases with a specific parent phase ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Project Template ID", "type": "text/plain" }, "disabled": false, "key": "projecttemplateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"datecreated\": \"\u003cstring\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemsActive\": \"\u003cinteger\u003e\",\n \"itemsCompleted\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n },\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"datecreated\": \"\u003cstring\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemsActive\": \"\u003cinteger\u003e\",\n \"itemsCompleted\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "dbe78b4d-1f5b-4d3f-91de-bcca761514d2", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates", ":projecttemplateid", "phases" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,itemcollectiontemplateid,parentid,billAmount" }, { "description": { "content": "Search by phase name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to phases with a specific parent phase ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Project Template ID", "type": "text/plain" }, "disabled": false, "key": "projecttemplateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f35e0f46-bdcb-445b-ab73-e335f63a582f", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates", ":projecttemplateid", "phases" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,itemcollectiontemplateid,parentid,billAmount" }, { "description": { "content": "Search by phase name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to phases with a specific parent phase ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Project Template ID", "type": "text/plain" }, "disabled": false, "key": "projecttemplateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6e18e3ee-5131-4951-b013-4f5c4a1eab99", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates", ":projecttemplateid", "phases" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,itemcollectiontemplateid,parentid,billAmount" }, { "description": { "content": "Search by phase name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to phases with a specific parent phase ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Project Template ID", "type": "text/plain" }, "disabled": false, "key": "projecttemplateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4adf98c6-52c9-477e-9476-24ae301d0af4", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates", ":projecttemplateid", "phases" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,itemcollectiontemplateid,parentid,billAmount" }, { "description": { "content": "Search by phase name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to phases with a specific parent phase ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Project Template ID", "type": "text/plain" }, "disabled": false, "key": "projecttemplateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] }, { "event": [], "id": "b75ba395-3cc1-4456-80dc-d091ad7be371", "name": "/settings/projects/templates/:projecttemplateid/phases", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Adds a Phase (Item Collection) to a specific project template.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/settings/projects/templates/:projecttemplateid/phases", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates", ":projecttemplateid", "phases" ], "query": [], "variable": [ { "description": { "content": "(Required) Project Template ID", "type": "text/plain" }, "disabled": false, "key": "projecttemplateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c11eb056-9ca2-44f7-ad46-732b48ba9ec5", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates", ":projecttemplateid", "phases" ], "query": [], "variable": [ { "description": { "content": "(Required) Project Template ID", "type": "text/plain" }, "disabled": false, "key": "projecttemplateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "31ecd19d-df29-4c4d-89a0-9c347201f5d0", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates", ":projecttemplateid", "phases" ], "query": [], "variable": [ { "description": { "content": "(Required) Project Template ID", "type": "text/plain" }, "disabled": false, "key": "projecttemplateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "794d764b-ab48-40b4-949a-51be0babaf7b", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates", ":projecttemplateid", "phases" ], "query": [], "variable": [ { "description": { "content": "(Required) Project Template ID", "type": "text/plain" }, "disabled": false, "key": "projecttemplateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ec428555-0c23-458a-8289-97f37a52d88f", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates", ":projecttemplateid", "phases" ], "query": [], "variable": [ { "description": { "content": "(Required) Project Template ID", "type": "text/plain" }, "disabled": false, "key": "projecttemplateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] }, { "event": [], "id": "a5bb3d02-b163-481a-b410-56c7c2f5f520", "name": "/settings/projects/templates/:projecttemplateid/phases/:phaseid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns full details of a single template phase (item collection) by ID within a specific template.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/projects/templates/:projecttemplateid/phases/:phaseid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates", ":projecttemplateid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project Template ID", "type": "text/plain" }, "disabled": false, "key": "projecttemplateid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"datecreated\": \"\u003cstring\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemsActive\": \"\u003cinteger\u003e\",\n \"itemsCompleted\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c4b8b6c2-d3c9-418e-bc7d-eaf2049446fc", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates", ":projecttemplateid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project Template ID", "type": "text/plain" }, "disabled": false, "key": "projecttemplateid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "1479b301-72bc-46e5-8fe8-31b0bba40a68", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates", ":projecttemplateid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project Template ID", "type": "text/plain" }, "disabled": false, "key": "projecttemplateid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6aacbdee-b6d2-4021-9fe4-3dcd9ccbbc33", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates", ":projecttemplateid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project Template ID", "type": "text/plain" }, "disabled": false, "key": "projecttemplateid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6eb1d4b2-93f2-4277-b3dc-30dbd73b26d2", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates", ":projecttemplateid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project Template ID", "type": "text/plain" }, "disabled": false, "key": "projecttemplateid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2af77d42-8442-4185-abd2-68a88cb49a98", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates", ":projecttemplateid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project Template ID", "type": "text/plain" }, "disabled": false, "key": "projecttemplateid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "dcf95dc5-bb4d-4581-967e-7c6b662e20c2", "name": "/settings/projects/templates/:projecttemplateid/phases/:phaseid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Updates an existing template phase within a specific project template.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/settings/projects/templates/:projecttemplateid/phases/:phaseid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates", ":projecttemplateid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project Template ID", "type": "text/plain" }, "disabled": false, "key": "projecttemplateid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "42f2a467-51f3-48da-999d-b12cb1e6d73a", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates", ":projecttemplateid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project Template ID", "type": "text/plain" }, "disabled": false, "key": "projecttemplateid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "fd589007-cdf1-4d0e-97c0-0509daa09d81", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates", ":projecttemplateid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project Template ID", "type": "text/plain" }, "disabled": false, "key": "projecttemplateid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "37dfdd02-eb4b-4c93-8add-a009d257992f", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates", ":projecttemplateid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project Template ID", "type": "text/plain" }, "disabled": false, "key": "projecttemplateid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4b0e8edf-ff6c-48e0-9d40-48f45cb947e2", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates", ":projecttemplateid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project Template ID", "type": "text/plain" }, "disabled": false, "key": "projecttemplateid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8853f9d9-fcf0-40b6-83a3-fdec51fbbf5a", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates", ":projecttemplateid", "phases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Project Template ID", "type": "text/plain" }, "disabled": false, "key": "projecttemplateid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "9d9a266e-5602-4219-8ec6-26648003d5d0", "name": "/settings/quotes", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns default Quote settings. These can be changed from the main ProWorkflow application.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/quotes", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "quotes" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"clientemailcontent\": \"\u003cstring\u003e\",\n \"clientemailfromaddress\": \"\u003cstring\u003e\",\n \"clientemailsubject\": \"\u003cstring\u003e\",\n \"contactfooter\": \"\u003cstring\u003e\",\n \"footerdetails\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"logo\": \"\u003cstring\u003e\",\n \"pagetitle\": \"\u003cstring\u003e\",\n \"quoteperiod\": \"\u003cinteger\u003e\",\n \"quoteterms\": \"\u003cstring\u003e\",\n \"showItemDescription\": \"\u003cboolean\u003e\",\n \"showPhases\": \"\u003cboolean\u003e\",\n \"showcostbreakdown\": \"\u003cboolean\u003e\",\n \"usequoteterms\": \"\u003cstring\u003e\"\n },\n {\n \"clientemailcontent\": \"\u003cstring\u003e\",\n \"clientemailfromaddress\": \"\u003cstring\u003e\",\n \"clientemailsubject\": \"\u003cstring\u003e\",\n \"contactfooter\": \"\u003cstring\u003e\",\n \"footerdetails\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"logo\": \"\u003cstring\u003e\",\n \"pagetitle\": \"\u003cstring\u003e\",\n \"quoteperiod\": \"\u003cinteger\u003e\",\n \"quoteterms\": \"\u003cstring\u003e\",\n \"showItemDescription\": \"\u003cboolean\u003e\",\n \"showPhases\": \"\u003cboolean\u003e\",\n \"showcostbreakdown\": \"\u003cboolean\u003e\",\n \"usequoteterms\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "26035507-5d7e-4b83-b084-29ed8e9d190c", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "quotes" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e3b5fdc8-3878-48fa-89cb-c6640e84ff3e", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "quotes" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e30d52af-7eeb-4c6f-86ed-dd48a7541388", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "quotes" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "70cf073f-9fc8-4ea7-92eb-766d20b033f1", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "quotes" ], "query": [], "variable": [] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b50df0a9-5c7c-4b5e-a89f-654117ff7fc5", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "quotes" ], "query": [], "variable": [] } }, "status": "Not Found" } ] }, { "event": [], "id": "f67dd281-a216-46d9-a7a5-22948b419e97", "name": "/settings/quotes/autonumbering", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns the Quotes Autonumbering settings including mask, count, and placeholder.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/quotes/autonumbering", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "quotes", "autonumbering" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"autoquotenumber\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"quotenumbercount\": \"\u003cinteger\u003e\",\n \"quotenumbermask\": \"\u003cstring\u003e\",\n \"quotenumberplaceholder\": \"\u003cstring\u003e\"\n },\n {\n \"autoquotenumber\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"quotenumbercount\": \"\u003cinteger\u003e\",\n \"quotenumbermask\": \"\u003cstring\u003e\",\n \"quotenumberplaceholder\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "25d0bcaf-d4f5-4674-97e9-edf3c06614d2", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "quotes", "autonumbering" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "782f046f-fc04-4e68-9523-94038fa5aa14", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "quotes", "autonumbering" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8baeeab1-fc0d-49fd-b874-47b593b01533", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "quotes", "autonumbering" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f80e7eae-d894-485a-9e5f-afe5c5731f0e", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "quotes", "autonumbering" ], "query": [], "variable": [] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "64dbf126-776c-46d9-b943-7c4fbacc883f", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "quotes", "autonumbering" ], "query": [], "variable": [] } }, "status": "Not Found" } ] }, { "event": [], "id": "ed2678f3-5077-4c58-896c-8bbfb2df431b", "name": "/settings/quotes/templates", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Quote Templates.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/quotes/templates", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "quotes", "templates" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"id\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n },\n {\n \"id\": \"\u003cinteger\u003e\",\n \"title\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "cb9c5a82-bd3d-4268-9380-7c9f194353e1", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "quotes", "templates" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "65aba614-c7cc-4879-94da-39f9ab4d3bc8", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "quotes", "templates" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "666f7540-c72b-402e-926e-8eed8aa41a6b", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "quotes", "templates" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6276453b-55bf-4b57-bf14-bb00e607f573", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "quotes", "templates" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "60a64b07-f2c6-41eb-a44d-b7e522ea037c", "name": "/settings/quotes/templates/:templateid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns detailed information about a single Quote Template, including phases and line items.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/quotes/templates/:templateid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "quotes", "templates", ":templateid" ], "query": [], "variable": [ { "description": { "content": "(Required) Template ID", "type": "text/plain" }, "disabled": false, "key": "templateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"address1\": \"\u003cstring\u003e\",\n \"address2\": \"\u003cstring\u003e\",\n \"address3\": \"\u003cstring\u003e\",\n \"approveddate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"city\": \"\u003cstring\u003e\",\n \"clientcontactname\": \"\u003cstring\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"country\": \"\u003cstring\u003e\",\n \"customfieldname\": \"\u003cstring\u003e\",\n \"customfieldvalue\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"emaileddate\": \"\u003cstring\u003e\",\n \"emailedto\": \"\u003cstring\u003e\",\n \"emailedtoclient\": \"\u003cboolean\u003e\",\n \"grandtotal\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"number\": \"\u003cstring\u003e\",\n \"pagetitle\": \"\u003cstring\u003e\",\n \"phases\": [\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\"\n }\n ],\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n },\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"items\": [\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\"\n },\n {\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\"\n }\n ],\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedInLabour\": \"\u003cnumber\u003e\",\n \"projectedInTotal\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n }\n ],\n \"projectid\": \"\u003cinteger\u003e\",\n \"quotedate\": \"\u003cstring\u003e\",\n \"quotedby\": \"\u003cstring\u003e\",\n \"showcostbreakdown\": \"\u003cboolean\u003e\",\n \"showitemdescription\": \"\u003cboolean\u003e\",\n \"showphases\": \"\u003cboolean\u003e\",\n \"state\": \"\u003cstring\u003e\",\n \"subtotal\": \"\u003cnumber\u003e\",\n \"taxable\": \"\u003cboolean\u003e\",\n \"taxrate\": \"\u003cnumber\u003e\",\n \"taxtotal\": \"\u003cnumber\u003e\",\n \"title\": \"\u003cstring\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"validdate\": \"\u003cstring\u003e\",\n \"zipcode\": \"\u003cstring\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "1617a875-297f-4b97-8cfe-4d6213b25b5c", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "quotes", "templates", ":templateid" ], "query": [], "variable": [ { "description": { "content": "(Required) Template ID", "type": "text/plain" }, "disabled": false, "key": "templateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a21e48f8-fe07-4254-ac05-3bc6cf63908e", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "quotes", "templates", ":templateid" ], "query": [], "variable": [ { "description": { "content": "(Required) Template ID", "type": "text/plain" }, "disabled": false, "key": "templateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "307ecad1-460d-477c-8ba9-58dfc4c6f7ff", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "quotes", "templates", ":templateid" ], "query": [], "variable": [ { "description": { "content": "(Required) Template ID", "type": "text/plain" }, "disabled": false, "key": "templateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "1ed5ca11-3f46-4380-a09f-21f6ed1efd54", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "quotes", "templates", ":templateid" ], "query": [], "variable": [ { "description": { "content": "(Required) Template ID", "type": "text/plain" }, "disabled": false, "key": "templateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6388b60a-209a-4788-b693-f81594473a03", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "quotes", "templates", ":templateid" ], "query": [], "variable": [ { "description": { "content": "(Required) Template ID", "type": "text/plain" }, "disabled": false, "key": "templateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "941b9b42-8043-4008-95ce-2b64dc62ec16", "name": "/settings/servicerates", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Hourly Rate Services (service rates). Price fields (inLabourPrice, outLabourPrice, outLabourPriceMultiplier) are excluded for security.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/servicerates", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "servicerates" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"billable\": \"\u003cboolean\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"taxable\": \"\u003cboolean\u003e\"\n },\n {\n \"billable\": \"\u003cboolean\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"taxable\": \"\u003cboolean\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b56c5735-ef00-4b19-9a6e-c506aae264af", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "servicerates" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e2021f15-8f8f-4c16-a5fd-2c69d8d2256b", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "servicerates" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "bf0bba33-247f-421e-9bd2-27a8ae856781", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "servicerates" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b665e6b2-7c90-4e45-8e4d-0ed03af2b5ca", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "servicerates" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "33ecdacb-9010-4a85-af74-eee399a7b1ea", "name": "/settings/staffrates", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of staff members with their default hourly rate service and sell rate. Pay rate and cost rate fields are excluded for security. In v3 this was available at /settings/quotes/staffrates and /settings/invoices/staffrates — those are now consolidated here.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/staffrates", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "staffrates" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"hourlyrateservicename\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"outprice\": \"\u003cnumber\u003e\"\n },\n {\n \"firstname\": \"\u003cstring\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"hourlyrateservicename\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"lastname\": \"\u003cstring\u003e\",\n \"outprice\": \"\u003cnumber\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "418de5bd-f92f-45e9-b6a5-e0bf6b49b349", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "staffrates" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ea690c20-39bd-4869-be28-7a96b411a28e", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "staffrates" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ca2af13c-deea-4658-8017-114cbd128094", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "staffrates" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e1aea985-3468-40d6-9c12-1f5a4eb223d5", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "staffrates" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "43ae3e76-fb98-4a88-87f5-c7610f797d8a", "name": "/settings/webhooks", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of active Webhook subscriptions for the account.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/webhooks", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "webhooks" ], "query": [ { "description": { "content": "Event type filter (This can only be one of all,newcontact,newpendingcontact,editcontact,editcontactlocation,deletecontact,newcompany,newpendingcompany,editcompany,deletecompany,newfile,deletefile,newinvoice,editinvoice,deleteinvoice,newmessage,editmessage,deletemessage,newproject,editproject,editstageproject,deleteproject,completeproject,restoreProject,newprojectrequest,editprojectrequest,deleteprojectrequest,approveprojectrequest,declineprojectrequest,newquote,editquote,deletequote,newsharednote,editsharednote,deletesharednote,newtask,edittask,deletetask,completetask,reactivatetask,newtime,edittime,deletetime,starttimer,stoptimer,unknown)", "type": "text/plain" }, "disabled": true, "key": "event", "value": "all" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"event\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"url\": \"\u003cstring\u003e\"\n },\n {\n \"event\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"url\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "16ecd20a-ac64-43dc-af74-deed1c25f73e", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "webhooks" ], "query": [ { "description": { "content": "Event type filter (This can only be one of all,newcontact,newpendingcontact,editcontact,editcontactlocation,deletecontact,newcompany,newpendingcompany,editcompany,deletecompany,newfile,deletefile,newinvoice,editinvoice,deleteinvoice,newmessage,editmessage,deletemessage,newproject,editproject,editstageproject,deleteproject,completeproject,restoreProject,newprojectrequest,editprojectrequest,deleteprojectrequest,approveprojectrequest,declineprojectrequest,newquote,editquote,deletequote,newsharednote,editsharednote,deletesharednote,newtask,edittask,deletetask,completetask,reactivatetask,newtime,edittime,deletetime,starttimer,stoptimer,unknown)", "type": "text/plain" }, "disabled": true, "key": "event", "value": "all" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "dcf698b0-e24b-4fb6-9984-251e63301685", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "webhooks" ], "query": [ { "description": { "content": "Event type filter (This can only be one of all,newcontact,newpendingcontact,editcontact,editcontactlocation,deletecontact,newcompany,newpendingcompany,editcompany,deletecompany,newfile,deletefile,newinvoice,editinvoice,deleteinvoice,newmessage,editmessage,deletemessage,newproject,editproject,editstageproject,deleteproject,completeproject,restoreProject,newprojectrequest,editprojectrequest,deleteprojectrequest,approveprojectrequest,declineprojectrequest,newquote,editquote,deletequote,newsharednote,editsharednote,deletesharednote,newtask,edittask,deletetask,completetask,reactivatetask,newtime,edittime,deletetime,starttimer,stoptimer,unknown)", "type": "text/plain" }, "disabled": true, "key": "event", "value": "all" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "fcbd73c8-7525-4b5f-a9b8-1a5aeda515b2", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "webhooks" ], "query": [ { "description": { "content": "Event type filter (This can only be one of all,newcontact,newpendingcontact,editcontact,editcontactlocation,deletecontact,newcompany,newpendingcompany,editcompany,deletecompany,newfile,deletefile,newinvoice,editinvoice,deleteinvoice,newmessage,editmessage,deletemessage,newproject,editproject,editstageproject,deleteproject,completeproject,restoreProject,newprojectrequest,editprojectrequest,deleteprojectrequest,approveprojectrequest,declineprojectrequest,newquote,editquote,deletequote,newsharednote,editsharednote,deletesharednote,newtask,edittask,deletetask,completetask,reactivatetask,newtime,edittime,deletetime,starttimer,stoptimer,unknown)", "type": "text/plain" }, "disabled": true, "key": "event", "value": "all" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" } ], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "99313f73-691b-4eef-97b8-d6246aa72b04", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "webhooks" ], "query": [ { "description": { "content": "Event type filter (This can only be one of all,newcontact,newpendingcontact,editcontact,editcontactlocation,deletecontact,newcompany,newpendingcompany,editcompany,deletecompany,newfile,deletefile,newinvoice,editinvoice,deleteinvoice,newmessage,editmessage,deletemessage,newproject,editproject,editstageproject,deleteproject,completeproject,restoreProject,newprojectrequest,editprojectrequest,deleteprojectrequest,approveprojectrequest,declineprojectrequest,newquote,editquote,deletequote,newsharednote,editsharednote,deletesharednote,newtask,edittask,deletetask,completetask,reactivatetask,newtime,edittime,deletetime,starttimer,stoptimer,unknown)", "type": "text/plain" }, "disabled": true, "key": "event", "value": "all" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" } ], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "ce056cd5-2257-40d2-b876-864b4be11952", "name": "/settings/webhooks", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"event\": \"editcompany\",\n \"url\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Creates a new Webhook subscription.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/settings/webhooks", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "webhooks" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "df7b6067-d0ee-44d3-acd5-04a4f3e614b7", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"event\": \"editcompany\",\n \"url\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "webhooks" ], "query": [], "variable": [] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "48d98885-518f-4582-812f-440994c90fc2", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"event\": \"editcompany\",\n \"url\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "webhooks" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "83e61f66-db55-4214-a823-27884d5b2ccc", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"event\": \"editcompany\",\n \"url\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "webhooks" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "5a16461e-45ea-43fb-bd1c-3b6ca523ac3c", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"event\": \"editcompany\",\n \"url\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "webhooks" ], "query": [], "variable": [] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f01c21fd-3ea1-4607-8055-485d4ddc5c64", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"event\": \"editcompany\",\n \"url\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "webhooks" ], "query": [], "variable": [] } }, "status": "Not Found" } ] }, { "event": [], "id": "63f291f1-97d0-4253-b3db-6f62869b8750", "name": "/settings/webhooks/requests", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Webhook delivery requests for debugging. Requests older than 7 days are automatically deleted.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/webhooks/requests", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "webhooks", "requests" ], "query": [ { "description": { "content": "Event type filter (This can only be one of all,company,contact,file,invoice,message,project,projectrequest,quote,sharednote,task,time,timer)", "type": "text/plain" }, "disabled": true, "key": "event", "value": "all" }, { "description": { "content": "Web Hook ID or comma-separated list of IDs", "type": "text/plain" }, "disabled": true, "key": "resthookid", "value": "\u003cstring\u003e" }, { "description": { "content": "Request status filter (This can only be one of pending,complete,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "pending" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"completetime\": \"\u003cstring\u003e\",\n \"dataid\": \"\u003cinteger\u003e\",\n \"dataurl\": \"\u003cstring\u003e\",\n \"event\": \"\u003cstring\u003e\",\n \"httpstatuscode\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"nextruntime\": \"\u003cstring\u003e\",\n \"resthookid\": \"\u003cinteger\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"tries\": \"\u003cinteger\u003e\",\n \"url\": \"\u003cstring\u003e\"\n },\n {\n \"completetime\": \"\u003cstring\u003e\",\n \"dataid\": \"\u003cinteger\u003e\",\n \"dataurl\": \"\u003cstring\u003e\",\n \"event\": \"\u003cstring\u003e\",\n \"httpstatuscode\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"nextruntime\": \"\u003cstring\u003e\",\n \"resthookid\": \"\u003cinteger\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"tries\": \"\u003cinteger\u003e\",\n \"url\": \"\u003cstring\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "1b85c038-9db7-45cf-8228-230d589f4531", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "webhooks", "requests" ], "query": [ { "description": { "content": "Event type filter (This can only be one of all,company,contact,file,invoice,message,project,projectrequest,quote,sharednote,task,time,timer)", "type": "text/plain" }, "disabled": true, "key": "event", "value": "all" }, { "description": { "content": "Web Hook ID or comma-separated list of IDs", "type": "text/plain" }, "disabled": true, "key": "resthookid", "value": "\u003cstring\u003e" }, { "description": { "content": "Request status filter (This can only be one of pending,complete,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "pending" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6dc87a99-900a-4115-b7d0-7036d902060e", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "webhooks", "requests" ], "query": [ { "description": { "content": "Event type filter (This can only be one of all,company,contact,file,invoice,message,project,projectrequest,quote,sharednote,task,time,timer)", "type": "text/plain" }, "disabled": true, "key": "event", "value": "all" }, { "description": { "content": "Web Hook ID or comma-separated list of IDs", "type": "text/plain" }, "disabled": true, "key": "resthookid", "value": "\u003cstring\u003e" }, { "description": { "content": "Request status filter (This can only be one of pending,complete,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "pending" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "467dca0d-05ae-4cd1-a8a8-28f7ecc9ed0d", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "webhooks", "requests" ], "query": [ { "description": { "content": "Event type filter (This can only be one of all,company,contact,file,invoice,message,project,projectrequest,quote,sharednote,task,time,timer)", "type": "text/plain" }, "disabled": true, "key": "event", "value": "all" }, { "description": { "content": "Web Hook ID or comma-separated list of IDs", "type": "text/plain" }, "disabled": true, "key": "resthookid", "value": "\u003cstring\u003e" }, { "description": { "content": "Request status filter (This can only be one of pending,complete,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "pending" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" } ], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3abc4f2c-0f07-4f75-a991-62c6dd49adfb", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "webhooks", "requests" ], "query": [ { "description": { "content": "Event type filter (This can only be one of all,company,contact,file,invoice,message,project,projectrequest,quote,sharednote,task,time,timer)", "type": "text/plain" }, "disabled": true, "key": "event", "value": "all" }, { "description": { "content": "Web Hook ID or comma-separated list of IDs", "type": "text/plain" }, "disabled": true, "key": "resthookid", "value": "\u003cstring\u003e" }, { "description": { "content": "Request status filter (This can only be one of pending,complete,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "pending" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" } ], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "15c3535e-f24a-4576-901c-07c04d2493d5", "name": "/settings/webhooks/:webhookid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns details of a single Webhook subscription.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/webhooks/:webhookid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "webhooks", ":webhookid" ], "query": [], "variable": [ { "description": { "content": "(Required) Webhook ID", "type": "text/plain" }, "disabled": false, "key": "webhookid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f79ad608-6edc-4b72-a25e-9aeffe45e5a5", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "webhooks", ":webhookid" ], "query": [], "variable": [ { "description": { "content": "(Required) Webhook ID", "type": "text/plain" }, "disabled": false, "key": "webhookid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9695c845-7553-4b7b-bb52-7a7838d2d227", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "webhooks", ":webhookid" ], "query": [], "variable": [ { "description": { "content": "(Required) Webhook ID", "type": "text/plain" }, "disabled": false, "key": "webhookid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "1c44ad23-cff5-49f9-a3eb-91679389fae9", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "webhooks", ":webhookid" ], "query": [], "variable": [ { "description": { "content": "(Required) Webhook ID", "type": "text/plain" }, "disabled": false, "key": "webhookid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "57282d4e-bea4-490b-b9de-11fd92941cb4", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "webhooks", ":webhookid" ], "query": [], "variable": [ { "description": { "content": "(Required) Webhook ID", "type": "text/plain" }, "disabled": false, "key": "webhookid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b47afe0d-80b6-4531-80f9-23d53a4fcc50", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "webhooks", ":webhookid" ], "query": [], "variable": [ { "description": { "content": "(Required) Webhook ID", "type": "text/plain" }, "disabled": false, "key": "webhookid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "520e362d-9d4b-4669-824e-1481769a71ce", "name": "/settings/webhooks/:webhookid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"divisionid\": \"\u003cinteger\u003e\",\n \"event\": \"edittime\",\n \"url\": \"\u003cstring\u003e\"\n}" }, "description": { "content": "Updates a Webhook subscription.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/settings/webhooks/:webhookid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "webhooks", ":webhookid" ], "query": [], "variable": [ { "description": { "content": "(Required) Webhook ID", "type": "text/plain" }, "disabled": false, "key": "webhookid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "bb78a5e0-eb06-433b-bd32-f709615b092e", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"divisionid\": \"\u003cinteger\u003e\",\n \"event\": \"edittime\",\n \"url\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "webhooks", ":webhookid" ], "query": [], "variable": [ { "description": { "content": "(Required) Webhook ID", "type": "text/plain" }, "disabled": false, "key": "webhookid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2bc4c993-f719-4cfb-829f-f4e8e7a5cc21", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"divisionid\": \"\u003cinteger\u003e\",\n \"event\": \"edittime\",\n \"url\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "webhooks", ":webhookid" ], "query": [], "variable": [ { "description": { "content": "(Required) Webhook ID", "type": "text/plain" }, "disabled": false, "key": "webhookid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b183ad99-77f6-4223-aa0d-f3e604e6d897", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"divisionid\": \"\u003cinteger\u003e\",\n \"event\": \"edittime\",\n \"url\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "webhooks", ":webhookid" ], "query": [], "variable": [ { "description": { "content": "(Required) Webhook ID", "type": "text/plain" }, "disabled": false, "key": "webhookid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8d82e55d-ba49-4c4e-84cf-ae9dea35d326", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"divisionid\": \"\u003cinteger\u003e\",\n \"event\": \"edittime\",\n \"url\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "webhooks", ":webhookid" ], "query": [], "variable": [ { "description": { "content": "(Required) Webhook ID", "type": "text/plain" }, "disabled": false, "key": "webhookid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "571fdb9a-417d-4b5b-9350-e92ea6cfd492", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"divisionid\": \"\u003cinteger\u003e\",\n \"event\": \"edittime\",\n \"url\": \"\u003cstring\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "webhooks", ":webhookid" ], "query": [], "variable": [ { "description": { "content": "(Required) Webhook ID", "type": "text/plain" }, "disabled": false, "key": "webhookid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "efc9c7ab-c0e5-4f31-8076-9da31e64b793", "name": "/settings/webhooks/:webhookid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Soft deletes a Webhook subscription.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/settings/webhooks/:webhookid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "webhooks", ":webhookid" ], "query": [], "variable": [ { "description": { "content": "(Required) Webhook ID", "type": "text/plain" }, "disabled": false, "key": "webhookid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a3442de7-4959-4f53-9593-1b6f20da00b0", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "webhooks", ":webhookid" ], "query": [], "variable": [ { "description": { "content": "(Required) Webhook ID", "type": "text/plain" }, "disabled": false, "key": "webhookid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8cf36085-97fd-4812-a25f-6320d89f5aea", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "webhooks", ":webhookid" ], "query": [], "variable": [ { "description": { "content": "(Required) Webhook ID", "type": "text/plain" }, "disabled": false, "key": "webhookid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "13993d7c-9a37-47ee-ab4f-8b189084cbd1", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "webhooks", ":webhookid" ], "query": [], "variable": [ { "description": { "content": "(Required) Webhook ID", "type": "text/plain" }, "disabled": false, "key": "webhookid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ad59847c-25ea-4293-903a-125ddd546d82", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "webhooks", ":webhookid" ], "query": [], "variable": [ { "description": { "content": "(Required) Webhook ID", "type": "text/plain" }, "disabled": false, "key": "webhookid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f457ea2f-8895-421e-9c39-fee85f31a50e", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "webhooks", ":webhookid" ], "query": [], "variable": [ { "description": { "content": "(Required) Webhook ID", "type": "text/plain" }, "disabled": false, "key": "webhookid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "84f3475c-cc6e-4994-876b-73840ac75c79", "name": "/settings/workstages", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Work Stages. Use the type parameter to filter by stage type.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/workstages", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "workstages" ], "query": [ { "description": { "content": "Filter by work stage type (This can only be one of item,project,quote,invoice)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "quote" }, { "description": { "content": "Filter by work state (exact match)", "type": "text/plain" }, "disabled": true, "key": "workstate", "value": "\u003cstring\u003e" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"nextstage\": \"\u003cboolean\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"workstate\": \"\u003cstring\u003e\",\n \"worktypeid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"nextstage\": \"\u003cboolean\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"workstate\": \"\u003cstring\u003e\",\n \"worktypeid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ca628ac8-076b-4900-94fa-5ab6d9ecf96c", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "workstages" ], "query": [ { "description": { "content": "Filter by work stage type (This can only be one of item,project,quote,invoice)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "quote" }, { "description": { "content": "Filter by work state (exact match)", "type": "text/plain" }, "disabled": true, "key": "workstate", "value": "\u003cstring\u003e" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7450e2ac-5101-462c-9018-3479ffc7fff2", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "workstages" ], "query": [ { "description": { "content": "Filter by work stage type (This can only be one of item,project,quote,invoice)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "quote" }, { "description": { "content": "Filter by work state (exact match)", "type": "text/plain" }, "disabled": true, "key": "workstate", "value": "\u003cstring\u003e" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9a7fe42c-5795-4999-adea-8f6f52818123", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "workstages" ], "query": [ { "description": { "content": "Filter by work stage type (This can only be one of item,project,quote,invoice)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "quote" }, { "description": { "content": "Filter by work state (exact match)", "type": "text/plain" }, "disabled": true, "key": "workstate", "value": "\u003cstring\u003e" } ], "variable": [] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "7988babd-b458-47bb-9e44-094c2f2bf310", "name": "/settings/workstages/invoice", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Work Stages for type 'invoice'", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/workstages/invoice", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "workstages", "invoice" ], "query": [ { "description": { "content": "Filter by work state (exact match)", "type": "text/plain" }, "disabled": true, "key": "workstate", "value": "\u003cstring\u003e" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"nextstage\": \"\u003cboolean\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"workstate\": \"\u003cstring\u003e\",\n \"worktypeid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"nextstage\": \"\u003cboolean\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"workstate\": \"\u003cstring\u003e\",\n \"worktypeid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2645dd0a-5e8a-4b00-b52e-a2f600db018f", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "workstages", "invoice" ], "query": [ { "description": { "content": "Filter by work state (exact match)", "type": "text/plain" }, "disabled": true, "key": "workstate", "value": "\u003cstring\u003e" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "79d99244-e9fe-434b-8383-c5e726815f20", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "workstages", "invoice" ], "query": [ { "description": { "content": "Filter by work state (exact match)", "type": "text/plain" }, "disabled": true, "key": "workstate", "value": "\u003cstring\u003e" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "007318aa-6e22-4773-8247-3ef96af9597b", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "workstages", "invoice" ], "query": [ { "description": { "content": "Filter by work state (exact match)", "type": "text/plain" }, "disabled": true, "key": "workstate", "value": "\u003cstring\u003e" } ], "variable": [] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "82c12dc6-d8c4-4f6f-9d8c-91244e26c01f", "name": "/settings/workstages/item", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Work Stages for type 'item'", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/workstages/item", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "workstages", "item" ], "query": [ { "description": { "content": "Filter by work state (exact match)", "type": "text/plain" }, "disabled": true, "key": "workstate", "value": "\u003cstring\u003e" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"nextstage\": \"\u003cboolean\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"workstate\": \"\u003cstring\u003e\",\n \"worktypeid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"nextstage\": \"\u003cboolean\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"workstate\": \"\u003cstring\u003e\",\n \"worktypeid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c3a4e5c1-8107-42e0-a087-642b8fbc6dc2", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "workstages", "item" ], "query": [ { "description": { "content": "Filter by work state (exact match)", "type": "text/plain" }, "disabled": true, "key": "workstate", "value": "\u003cstring\u003e" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "87f477b0-526c-4182-a676-f02351ba912a", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "workstages", "item" ], "query": [ { "description": { "content": "Filter by work state (exact match)", "type": "text/plain" }, "disabled": true, "key": "workstate", "value": "\u003cstring\u003e" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "94911c9a-893d-428d-8b24-a242c0536ca5", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "workstages", "item" ], "query": [ { "description": { "content": "Filter by work state (exact match)", "type": "text/plain" }, "disabled": true, "key": "workstate", "value": "\u003cstring\u003e" } ], "variable": [] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "1b408f6b-83d6-47a8-a8e9-0b5221b2fe23", "name": "/settings/workstages/project", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Work Stages for type 'project'", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/workstages/project", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "workstages", "project" ], "query": [ { "description": { "content": "Filter by work state (exact match)", "type": "text/plain" }, "disabled": true, "key": "workstate", "value": "\u003cstring\u003e" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"nextstage\": \"\u003cboolean\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"workstate\": \"\u003cstring\u003e\",\n \"worktypeid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"nextstage\": \"\u003cboolean\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"workstate\": \"\u003cstring\u003e\",\n \"worktypeid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "31976a9e-1f49-40f1-ade9-b847974a361f", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "workstages", "project" ], "query": [ { "description": { "content": "Filter by work state (exact match)", "type": "text/plain" }, "disabled": true, "key": "workstate", "value": "\u003cstring\u003e" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "39eaa294-29b5-4be2-afb7-1f7b142e21a5", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "workstages", "project" ], "query": [ { "description": { "content": "Filter by work state (exact match)", "type": "text/plain" }, "disabled": true, "key": "workstate", "value": "\u003cstring\u003e" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2d945488-4850-4749-8aee-0f7ae9792fac", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "workstages", "project" ], "query": [ { "description": { "content": "Filter by work state (exact match)", "type": "text/plain" }, "disabled": true, "key": "workstate", "value": "\u003cstring\u003e" } ], "variable": [] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "63ea98df-8f79-431c-9833-c6469f8806f5", "name": "/settings/workstages/quote", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Work Stages for type 'quote'", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/workstages/quote", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "workstages", "quote" ], "query": [ { "description": { "content": "Filter by work state (exact match)", "type": "text/plain" }, "disabled": true, "key": "workstate", "value": "\u003cstring\u003e" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"color\": \"\u003cstring\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"nextstage\": \"\u003cboolean\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"workstate\": \"\u003cstring\u003e\",\n \"worktypeid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n },\n {\n \"color\": \"\u003cstring\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"divisionid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"nextstage\": \"\u003cboolean\u003e\",\n \"type\": \"\u003cstring\u003e\",\n \"workstate\": \"\u003cstring\u003e\",\n \"worktypeid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "eead7647-a04e-4974-9ed3-e19b1bc83cdb", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "workstages", "quote" ], "query": [ { "description": { "content": "Filter by work state (exact match)", "type": "text/plain" }, "disabled": true, "key": "workstate", "value": "\u003cstring\u003e" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "090dcf14-17f3-48ea-a5c1-9093f3379c8b", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "workstages", "quote" ], "query": [ { "description": { "content": "Filter by work state (exact match)", "type": "text/plain" }, "disabled": true, "key": "workstate", "value": "\u003cstring\u003e" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f92ed5c3-6a70-48d3-bc8b-9061065c2e30", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "workstages", "quote" ], "query": [ { "description": { "content": "Filter by work state (exact match)", "type": "text/plain" }, "disabled": true, "key": "workstate", "value": "\u003cstring\u003e" } ], "variable": [] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "fd2f7fb8-843c-4337-9280-155ba689a131", "name": "/templateitems", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of all template line items across all templates, based on the filters specified.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/templateitems", "url": { "host": [ "{{baseUrl}}" ], "path": [ "templateitems" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,itemcollectionid,parentid,itemtypeid,activeworkstate" }, { "description": { "content": "Search by item name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Template ID or list of Template IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "templateid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to items within a specific phase (itemcollectionid)", "type": "text/plain" }, "disabled": true, "key": "phaseid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by parent item ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by item type ID", "type": "text/plain" }, "disabled": true, "key": "itemtypeid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"createdatetime\": \"\u003cstring\u003e\",\n \"creatorid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"dependenttaskid\": \"\u003cstring\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"discountRate\": \"\u003cnumber\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScoreId\": \"\u003cinteger\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"impactScoreId\": \"\u003cinteger\u003e\",\n \"importanceScoreId\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inTaxRate\": \"\u003cnumber\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"isDiscountPercent\": \"\u003cboolean\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outTaxRate\": \"\u003cnumber\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"prerequisiteid\": \"\u003cstring\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cnumber\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\",\n \"timespent\": \"\u003cnumber\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\",\n \"uniquetoken\": \"\u003cstring\u003e\",\n \"urgencyScoreId\": \"\u003cinteger\u003e\"\n },\n {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"createdatetime\": \"\u003cstring\u003e\",\n \"creatorid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"dependenttaskid\": \"\u003cstring\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"discountRate\": \"\u003cnumber\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScoreId\": \"\u003cinteger\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"impactScoreId\": \"\u003cinteger\u003e\",\n \"importanceScoreId\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inTaxRate\": \"\u003cnumber\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"isDiscountPercent\": \"\u003cboolean\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outTaxRate\": \"\u003cnumber\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"prerequisiteid\": \"\u003cstring\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cnumber\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\",\n \"timespent\": \"\u003cnumber\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\",\n \"uniquetoken\": \"\u003cstring\u003e\",\n \"urgencyScoreId\": \"\u003cinteger\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "288460d0-0f48-400c-badc-055eae1fbe48", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "templateitems" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,itemcollectionid,parentid,itemtypeid,activeworkstate" }, { "description": { "content": "Search by item name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Template ID or list of Template IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "templateid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to items within a specific phase (itemcollectionid)", "type": "text/plain" }, "disabled": true, "key": "phaseid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by parent item ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by item type ID", "type": "text/plain" }, "disabled": true, "key": "itemtypeid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "444d7ab2-3d25-405f-a9d8-0bf45a21085b", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "templateitems" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,itemcollectionid,parentid,itemtypeid,activeworkstate" }, { "description": { "content": "Search by item name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Template ID or list of Template IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "templateid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to items within a specific phase (itemcollectionid)", "type": "text/plain" }, "disabled": true, "key": "phaseid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by parent item ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by item type ID", "type": "text/plain" }, "disabled": true, "key": "itemtypeid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c10ce5e8-d928-4ba8-8852-00037d9cf4be", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "templateitems" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,itemcollectionid,parentid,itemtypeid,activeworkstate" }, { "description": { "content": "Search by item name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Template ID or list of Template IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "templateid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to items within a specific phase (itemcollectionid)", "type": "text/plain" }, "disabled": true, "key": "phaseid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by parent item ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by item type ID", "type": "text/plain" }, "disabled": true, "key": "itemtypeid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "aaf8fffc-fce1-4893-8bab-d77bee695feb", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "templateitems" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,itemcollectionid,parentid,itemtypeid,activeworkstate" }, { "description": { "content": "Search by item name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Template ID or list of Template IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "templateid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to items within a specific phase (itemcollectionid)", "type": "text/plain" }, "disabled": true, "key": "phaseid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by parent item ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Filter by item type ID", "type": "text/plain" }, "disabled": true, "key": "itemtypeid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "15b6fc98-3683-4d97-9cd1-ba3119475ace", "name": "/templateitems/:itemid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns full details of a single template item by ID.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/templateitems/:itemid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "templateitems", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Template Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"activeworkstageid\": \"\u003cinteger\u003e\",\n \"activeworkstate\": \"\u003cstring\u003e\",\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"categoryid\": \"\u003cinteger\u003e\",\n \"chargeRateType\": \"\u003cinteger\u003e\",\n \"code\": \"\u003cstring\u003e\",\n \"completedate\": \"\u003cstring\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"costRateType\": \"\u003cinteger\u003e\",\n \"createdatetime\": \"\u003cstring\u003e\",\n \"creatorid\": \"\u003cinteger\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"dependenttaskid\": \"\u003cstring\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"discountRate\": \"\u003cnumber\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"effortScoreId\": \"\u003cinteger\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"impactScoreId\": \"\u003cinteger\u003e\",\n \"importanceScoreId\": \"\u003cinteger\u003e\",\n \"inAccountingCodeId\": \"\u003cinteger\u003e\",\n \"inLabourPrice\": \"\u003cnumber\u003e\",\n \"inTaxCodeId\": \"\u003cinteger\u003e\",\n \"inTaxRate\": \"\u003cnumber\u003e\",\n \"inUnitId\": \"\u003cinteger\u003e\",\n \"inUnitPrice\": \"\u003cnumber\u003e\",\n \"inUnitQty\": \"\u003cnumber\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"isDiscountPercent\": \"\u003cboolean\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemtypeid\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"manualBillAmount\": \"\u003cnumber\u003e\",\n \"manualBudget\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outAccountingCodeId\": \"\u003cinteger\u003e\",\n \"outLabourPrice\": \"\u003cnumber\u003e\",\n \"outLabourPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outTaxCodeId\": \"\u003cinteger\u003e\",\n \"outTaxRate\": \"\u003cnumber\u003e\",\n \"outUnitId\": \"\u003cinteger\u003e\",\n \"outUnitPrice\": \"\u003cnumber\u003e\",\n \"outUnitPriceMultiplier\": \"\u003cnumber\u003e\",\n \"outUnitQty\": \"\u003cnumber\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"prerequisiteid\": \"\u003cstring\u003e\",\n \"priorityid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cnumber\u003e\",\n \"tagid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\",\n \"timespent\": \"\u003cnumber\u003e\",\n \"trackingOptionId\": \"\u003cstring\u003e\",\n \"uniquetoken\": \"\u003cstring\u003e\",\n \"urgencyScoreId\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "01c41e42-b805-4fc5-af94-a1330abbb07c", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "templateitems", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Template Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "053bd064-be9d-43aa-b087-f413edacb7e9", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "templateitems", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Template Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "35867af7-078e-4c33-8e32-bb29857358eb", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "templateitems", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Template Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e18c6f52-0b9f-4a85-9712-08d5873a8a40", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "templateitems", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Template Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "107821b5-6e26-467c-b386-3836a0c06350", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "templateitems", ":itemid" ], "query": [], "variable": [ { "description": { "content": "(Required) Template Item ID", "type": "text/plain" }, "disabled": false, "key": "itemid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "e8606bf7-a2d4-41e5-96a2-f8af820d890d", "name": "/templatephases", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of all template phases (item collections) across all templates.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/templatephases", "url": { "host": [ "{{baseUrl}}" ], "path": [ "templatephases" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,itemcollectiontemplateid,parentid,billAmount" }, { "description": { "content": "Search by phase name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Template ID or comma-separated list of Template IDs", "type": "text/plain" }, "disabled": true, "key": "templateid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to phases with a specific parent phase ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"datecreated\": \"\u003cstring\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemsActive\": \"\u003cinteger\u003e\",\n \"itemsCompleted\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n },\n {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"datecreated\": \"\u003cstring\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemsActive\": \"\u003cinteger\u003e\",\n \"itemsCompleted\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "bba479b3-474f-4d8c-a73c-80e83e839dc2", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "templatephases" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,itemcollectiontemplateid,parentid,billAmount" }, { "description": { "content": "Search by phase name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Template ID or comma-separated list of Template IDs", "type": "text/plain" }, "disabled": true, "key": "templateid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to phases with a specific parent phase ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "151ce9ff-5aca-4cfa-85f0-aead1acacb44", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "templatephases" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,itemcollectiontemplateid,parentid,billAmount" }, { "description": { "content": "Search by phase name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Template ID or comma-separated list of Template IDs", "type": "text/plain" }, "disabled": true, "key": "templateid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to phases with a specific parent phase ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c12c7a15-a0f1-4a9e-81fe-41fefbc0a5f1", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "templatephases" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,itemcollectiontemplateid,parentid,billAmount" }, { "description": { "content": "Search by phase name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Template ID or comma-separated list of Template IDs", "type": "text/plain" }, "disabled": true, "key": "templateid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to phases with a specific parent phase ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e32eec63-90c6-4c9b-a850-a2cd96646e33", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "templatephases" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,itemcollectiontemplateid,parentid,billAmount" }, { "description": { "content": "Search by phase name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Template ID or comma-separated list of Template IDs", "type": "text/plain" }, "disabled": true, "key": "templateid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter to phases with a specific parent phase ID (0 = top-level only)", "type": "text/plain" }, "disabled": true, "key": "parentid", "value": "\u003cinteger\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,sortorder)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "sortorder" }, { "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "3744ef98-5024-4628-b51d-3c2ee6091ad5", "name": "/templatephases", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"templateid\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Adds a Phase (Item Collection) to a template.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/templatephases", "url": { "host": [ "{{baseUrl}}" ], "path": [ "templatephases" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "01430743-617e-4088-bf18-f7e7fa4505eb", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"templateid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "templatephases" ], "query": [], "variable": [] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "3c5d4194-0405-410f-ae6a-52e8cc22f810", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"templateid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "templatephases" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "bbee07b6-9b48-4b2e-a137-251d55101a23", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"templateid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "templatephases" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "319cd640-e096-4e8f-9f49-d8d7a64a4771", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"templateid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "templatephases" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "c4c9c581-491b-438c-9da2-1acabb3337fa", "name": "/templatephases/:phaseid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns full details of a single template phase (item collection) by ID.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/templatephases/:phaseid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "templatephases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"billAmount\": \"\u003cnumber\u003e\",\n \"billAmountTax\": \"\u003cnumber\u003e\",\n \"billType\": \"\u003cinteger\u003e\",\n \"budget\": \"\u003cnumber\u003e\",\n \"budgetTax\": \"\u003cnumber\u003e\",\n \"budgetType\": \"\u003cinteger\u003e\",\n \"datecreated\": \"\u003cstring\u003e\",\n \"deleted\": \"\u003cboolean\u003e\",\n \"discount\": \"\u003cnumber\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estInTotalTax\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemsActive\": \"\u003cinteger\u003e\",\n \"itemsCompleted\": \"\u003cinteger\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"storyPoints\": \"\u003cnumber\u003e\",\n \"timeBillable\": \"\u003cnumber\u003e\",\n \"timeallocated\": \"\u003cnumber\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "0348e1db-97e2-4a7e-9cb7-27e5148883fd", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "templatephases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "63f639f0-1b58-4f24-91dc-f129eafedf39", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "templatephases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9f43470a-2f3a-41e8-b134-ed9488f5a10d", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "templatephases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "76021e66-b9f4-49c8-9bdc-921075d13dbc", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "templatephases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "16d2e994-6426-47d6-ba72-735884f526ed", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "templatephases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "8cb9cf4a-4d8b-4738-b319-94f876db89d0", "name": "/templatephases/:phaseid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Updates an existing template phase.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/templatephases/:phaseid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "templatephases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d22240fa-0c25-4008-a94a-bc7dae95ff65", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "templatephases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2f700196-0873-439c-b9fd-04bb37474bb3", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "templatephases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "faf83da3-2aee-4b37-b6b0-e37954cb752f", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "templatephases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "51773cc2-96c3-4a4d-a643-279fda4383fe", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "templatephases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d2be92a1-5ffe-4067-94d7-d7e6407c4c17", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"name\": \"\u003cstring\u003e\",\n \"parentid\": \"\u003cinteger\u003e\",\n \"sortorder\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "templatephases", ":phaseid" ], "query": [], "variable": [ { "description": { "content": "(Required) Phase ID", "type": "text/plain" }, "disabled": false, "key": "phaseid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] } ], "name": "settings" }, { "description": "", "item": [ { "event": [], "id": "e7a63953-0cc5-4e39-9149-2fe9c72ab228", "name": "/time", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Time Records based on the filters specified. By default returns time tracked in the last 6 days. The fields parameter controls which data is returned for each record.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/time", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- contact - Contact ID and name\n- item (or task) - Item ID and name\n- itemid (or taskid) - Item ID only\n- itemname (or taskname) - Item name only\n- project - Project ID, title, and number\n- company - Company ID and name\n- dates - Start date, start time, end time\n- timetracked - Time spent (in minutes)\n- notes - Time record notes\n- billable - Billable flag (from item)\n- accountedfor - Accounted for flag\n- timeallocationid - Time allocation ID\n- itemcollectionid - Item collection (phase) ID\n- lastmodified - Last modified date (UTC)\n- all - All fields", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "contact,item,dates,timetracked" }, { "description": { "content": "Contact filter. \n- contactid/s - Time tracked by specified contacts Example: 1,2,3\n- me - Time tracked by requesting user\n- all - All contacts (default)", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Project ID or list of Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Item (task) ID or list of IDs (comma-separated). Alias: taskid", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Alias for itemid parameter.", "type": "text/plain" }, "disabled": true, "key": "taskid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company ID or list of Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project Category ID or list of Category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or after this date. Accepts yyyy-mm-dd or relative: -6d, -1w, -1m, -1y. Default: -6d", "type": "text/plain" }, "disabled": true, "key": "trackedfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or before this date. Accepts yyyy-mm-dd or relative: +0d, +1w. Default: +0d", "type": "text/plain" }, "disabled": true, "key": "trackedto", "value": "\u003cstring\u003e" }, { "description": { "content": "Billable filter. \n- billable - Billable time only\n- nonbillable - Non-billable time only\n- all - All time (default) (This can only be one of billable,nonbillable,all)", "type": "text/plain" }, "disabled": true, "key": "billable", "value": "all" }, { "description": { "content": "Filter by project status (activeworkstate). \n- active - Active projects only\n- complete - Completed projects only\n- all - All projects (default) (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Filter by item activeworkstate. \n- active - Active items only\n- complete - Completed items only\n- deleted - Deleted items only\n- all - All items (default) (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Alias for activeworkstate parameter. (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "deleted" }, { "description": { "content": "Search by notes. \n- string - Records where Notes contains string\n- !string - Records where Notes does not contain string", "type": "text/plain" }, "disabled": true, "key": "searchnotes", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by item name. \n- string - Records where Item Name contains string\n- !string - Records where Item Name does not contain string", "type": "text/plain" }, "disabled": true, "key": "searchitem", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or after this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID greater than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID less than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Time Record IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,date,projectid,itemid,taskid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"accountedfor\": \"\u003cboolean\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"contactname\": \"\u003cstring\u003e\",\n \"endtime\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"itemname\": \"\u003cstring\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"notes\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeallocationid\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n },\n {\n \"accountedfor\": \"\u003cboolean\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"contactname\": \"\u003cstring\u003e\",\n \"endtime\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"itemname\": \"\u003cstring\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"notes\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeallocationid\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8a839a94-04d9-41d5-90e0-e1c8ecc601e7", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- contact - Contact ID and name\n- item (or task) - Item ID and name\n- itemid (or taskid) - Item ID only\n- itemname (or taskname) - Item name only\n- project - Project ID, title, and number\n- company - Company ID and name\n- dates - Start date, start time, end time\n- timetracked - Time spent (in minutes)\n- notes - Time record notes\n- billable - Billable flag (from item)\n- accountedfor - Accounted for flag\n- timeallocationid - Time allocation ID\n- itemcollectionid - Item collection (phase) ID\n- lastmodified - Last modified date (UTC)\n- all - All fields", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "contact,item,dates,timetracked" }, { "description": { "content": "Contact filter. \n- contactid/s - Time tracked by specified contacts Example: 1,2,3\n- me - Time tracked by requesting user\n- all - All contacts (default)", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Project ID or list of Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Item (task) ID or list of IDs (comma-separated). Alias: taskid", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Alias for itemid parameter.", "type": "text/plain" }, "disabled": true, "key": "taskid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company ID or list of Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project Category ID or list of Category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or after this date. Accepts yyyy-mm-dd or relative: -6d, -1w, -1m, -1y. Default: -6d", "type": "text/plain" }, "disabled": true, "key": "trackedfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or before this date. Accepts yyyy-mm-dd or relative: +0d, +1w. Default: +0d", "type": "text/plain" }, "disabled": true, "key": "trackedto", "value": "\u003cstring\u003e" }, { "description": { "content": "Billable filter. \n- billable - Billable time only\n- nonbillable - Non-billable time only\n- all - All time (default) (This can only be one of billable,nonbillable,all)", "type": "text/plain" }, "disabled": true, "key": "billable", "value": "all" }, { "description": { "content": "Filter by project status (activeworkstate). \n- active - Active projects only\n- complete - Completed projects only\n- all - All projects (default) (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Filter by item activeworkstate. \n- active - Active items only\n- complete - Completed items only\n- deleted - Deleted items only\n- all - All items (default) (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Alias for activeworkstate parameter. (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "deleted" }, { "description": { "content": "Search by notes. \n- string - Records where Notes contains string\n- !string - Records where Notes does not contain string", "type": "text/plain" }, "disabled": true, "key": "searchnotes", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by item name. \n- string - Records where Item Name contains string\n- !string - Records where Item Name does not contain string", "type": "text/plain" }, "disabled": true, "key": "searchitem", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or after this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID greater than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID less than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Time Record IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,date,projectid,itemid,taskid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "586f0e7b-d648-4ce5-9024-a2c832a50c0d", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- contact - Contact ID and name\n- item (or task) - Item ID and name\n- itemid (or taskid) - Item ID only\n- itemname (or taskname) - Item name only\n- project - Project ID, title, and number\n- company - Company ID and name\n- dates - Start date, start time, end time\n- timetracked - Time spent (in minutes)\n- notes - Time record notes\n- billable - Billable flag (from item)\n- accountedfor - Accounted for flag\n- timeallocationid - Time allocation ID\n- itemcollectionid - Item collection (phase) ID\n- lastmodified - Last modified date (UTC)\n- all - All fields", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "contact,item,dates,timetracked" }, { "description": { "content": "Contact filter. \n- contactid/s - Time tracked by specified contacts Example: 1,2,3\n- me - Time tracked by requesting user\n- all - All contacts (default)", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Project ID or list of Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Item (task) ID or list of IDs (comma-separated). Alias: taskid", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Alias for itemid parameter.", "type": "text/plain" }, "disabled": true, "key": "taskid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company ID or list of Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project Category ID or list of Category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or after this date. Accepts yyyy-mm-dd or relative: -6d, -1w, -1m, -1y. Default: -6d", "type": "text/plain" }, "disabled": true, "key": "trackedfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or before this date. Accepts yyyy-mm-dd or relative: +0d, +1w. Default: +0d", "type": "text/plain" }, "disabled": true, "key": "trackedto", "value": "\u003cstring\u003e" }, { "description": { "content": "Billable filter. \n- billable - Billable time only\n- nonbillable - Non-billable time only\n- all - All time (default) (This can only be one of billable,nonbillable,all)", "type": "text/plain" }, "disabled": true, "key": "billable", "value": "all" }, { "description": { "content": "Filter by project status (activeworkstate). \n- active - Active projects only\n- complete - Completed projects only\n- all - All projects (default) (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Filter by item activeworkstate. \n- active - Active items only\n- complete - Completed items only\n- deleted - Deleted items only\n- all - All items (default) (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Alias for activeworkstate parameter. (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "deleted" }, { "description": { "content": "Search by notes. \n- string - Records where Notes contains string\n- !string - Records where Notes does not contain string", "type": "text/plain" }, "disabled": true, "key": "searchnotes", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by item name. \n- string - Records where Item Name contains string\n- !string - Records where Item Name does not contain string", "type": "text/plain" }, "disabled": true, "key": "searchitem", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or after this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID greater than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID less than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Time Record IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,date,projectid,itemid,taskid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7f8b36b9-dbd1-46ed-9d09-e1127e701382", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- contact - Contact ID and name\n- item (or task) - Item ID and name\n- itemid (or taskid) - Item ID only\n- itemname (or taskname) - Item name only\n- project - Project ID, title, and number\n- company - Company ID and name\n- dates - Start date, start time, end time\n- timetracked - Time spent (in minutes)\n- notes - Time record notes\n- billable - Billable flag (from item)\n- accountedfor - Accounted for flag\n- timeallocationid - Time allocation ID\n- itemcollectionid - Item collection (phase) ID\n- lastmodified - Last modified date (UTC)\n- all - All fields", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "contact,item,dates,timetracked" }, { "description": { "content": "Contact filter. \n- contactid/s - Time tracked by specified contacts Example: 1,2,3\n- me - Time tracked by requesting user\n- all - All contacts (default)", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Project ID or list of Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Item (task) ID or list of IDs (comma-separated). Alias: taskid", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Alias for itemid parameter.", "type": "text/plain" }, "disabled": true, "key": "taskid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company ID or list of Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project Category ID or list of Category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or after this date. Accepts yyyy-mm-dd or relative: -6d, -1w, -1m, -1y. Default: -6d", "type": "text/plain" }, "disabled": true, "key": "trackedfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or before this date. Accepts yyyy-mm-dd or relative: +0d, +1w. Default: +0d", "type": "text/plain" }, "disabled": true, "key": "trackedto", "value": "\u003cstring\u003e" }, { "description": { "content": "Billable filter. \n- billable - Billable time only\n- nonbillable - Non-billable time only\n- all - All time (default) (This can only be one of billable,nonbillable,all)", "type": "text/plain" }, "disabled": true, "key": "billable", "value": "all" }, { "description": { "content": "Filter by project status (activeworkstate). \n- active - Active projects only\n- complete - Completed projects only\n- all - All projects (default) (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Filter by item activeworkstate. \n- active - Active items only\n- complete - Completed items only\n- deleted - Deleted items only\n- all - All items (default) (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Alias for activeworkstate parameter. (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "deleted" }, { "description": { "content": "Search by notes. \n- string - Records where Notes contains string\n- !string - Records where Notes does not contain string", "type": "text/plain" }, "disabled": true, "key": "searchnotes", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by item name. \n- string - Records where Item Name contains string\n- !string - Records where Item Name does not contain string", "type": "text/plain" }, "disabled": true, "key": "searchitem", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or after this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID greater than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID less than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Time Record IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,date,projectid,itemid,taskid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c86620c0-a198-4bff-bfe8-2d83f66507eb", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available fields: \n- contact - Contact ID and name\n- item (or task) - Item ID and name\n- itemid (or taskid) - Item ID only\n- itemname (or taskname) - Item name only\n- project - Project ID, title, and number\n- company - Company ID and name\n- dates - Start date, start time, end time\n- timetracked - Time spent (in minutes)\n- notes - Time record notes\n- billable - Billable flag (from item)\n- accountedfor - Accounted for flag\n- timeallocationid - Time allocation ID\n- itemcollectionid - Item collection (phase) ID\n- lastmodified - Last modified date (UTC)\n- all - All fields", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "contact,item,dates,timetracked" }, { "description": { "content": "Contact filter. \n- contactid/s - Time tracked by specified contacts Example: 1,2,3\n- me - Time tracked by requesting user\n- all - All contacts (default)", "type": "text/plain" }, "disabled": true, "key": "contacts", "value": "\u003cstring\u003e" }, { "description": { "content": "Project ID or list of Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Item (task) ID or list of IDs (comma-separated). Alias: taskid", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Alias for itemid parameter.", "type": "text/plain" }, "disabled": true, "key": "taskid", "value": "\u003cstring\u003e" }, { "description": { "content": "Company ID or list of Company IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "companyid", "value": "\u003cstring\u003e" }, { "description": { "content": "Project Category ID or list of Category IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "categoryid", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or after this date. Accepts yyyy-mm-dd or relative: -6d, -1w, -1m, -1y. Default: -6d", "type": "text/plain" }, "disabled": true, "key": "trackedfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Time tracked on or before this date. Accepts yyyy-mm-dd or relative: +0d, +1w. Default: +0d", "type": "text/plain" }, "disabled": true, "key": "trackedto", "value": "\u003cstring\u003e" }, { "description": { "content": "Billable filter. \n- billable - Billable time only\n- nonbillable - Non-billable time only\n- all - All time (default) (This can only be one of billable,nonbillable,all)", "type": "text/plain" }, "disabled": true, "key": "billable", "value": "all" }, { "description": { "content": "Filter by project status (activeworkstate). \n- active - Active projects only\n- complete - Completed projects only\n- all - All projects (default) (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "all" }, { "description": { "content": "Filter by item activeworkstate. \n- active - Active items only\n- complete - Completed items only\n- deleted - Deleted items only\n- all - All items (default) (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "activeworkstate", "value": "all" }, { "description": { "content": "Alias for activeworkstate parameter. (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "deleted" }, { "description": { "content": "Search by notes. \n- string - Records where Notes contains string\n- !string - Records where Notes does not contain string", "type": "text/plain" }, "disabled": true, "key": "searchnotes", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by item name. \n- string - Records where Item Name contains string\n- !string - Records where Item Name does not contain string", "type": "text/plain" }, "disabled": true, "key": "searchitem", "value": "\u003cstring\u003e" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or after this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records modified on or before this date (UTC). ISO8601 or relative", "type": "text/plain" }, "disabled": true, "key": "lastmodifiedutcto", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID greater than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Records with ID less than or equal to this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Time Record IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,date,projectid,itemid,taskid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page Number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page Size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "e8cdd76e-25de-4016-979e-daf69cf67118", "name": "/time", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"notes\": \"\u003cstring\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeAllocationId\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Create a new Time Record. Tracks time spent on an item by a contact.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/time", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "52b272da-008f-47d0-ab49-d4a1d5af38ea", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"notes\": \"\u003cstring\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeAllocationId\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time" ], "query": [], "variable": [] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9662ebb2-7190-49a5-bb54-9c7f3c697a04", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"notes\": \"\u003cstring\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeAllocationId\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e2eb64b9-e649-4411-abf9-0d67d65e121e", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"notes\": \"\u003cstring\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeAllocationId\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "1829540a-897b-478b-8ada-6f8d8eefd37b", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"notes\": \"\u003cstring\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeAllocationId\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "4e8a75f6-e180-4950-bbab-7fe2285d052e", "name": "/time/contact", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": \"\u003cinteger\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Reassigns the contact on one or more time log entries.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/time/contact", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time", "contact" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a9f0ace1-095d-4546-b259-5c9f98bafe3b", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": \"\u003cinteger\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time", "contact" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f4ff61db-a4ac-4bd8-b7c3-b9e19ac47bfd", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": \"\u003cinteger\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time", "contact" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "360ac1f0-c458-4f73-ab2b-8cb9b90f8070", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": \"\u003cinteger\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time", "contact" ], "query": [], "variable": [] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "e56c3ab5-7961-4b90-b044-7d0e4c9cf7bb", "name": "/time/invoice", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Updates the invoice item association on one or more time log entries.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/time/invoice", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time", "invoice" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8f49f265-2dd0-49d8-a7b8-dc586850ad22", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time", "invoice" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "c9ac3ab1-de56-4494-9218-19ed3d622b92", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time", "invoice" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4f507194-6113-4f45-a75b-9779571f658a", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time", "invoice" ], "query": [], "variable": [] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "d8732269-a766-4ac6-b548-366c69220333", "name": "/time/rate", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Reassigns the hourly rate service on one or more time log entries.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/time/rate", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time", "rate" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "dfa7943d-bfbe-4138-a2e4-cc175956c5e8", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time", "rate" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8da59b7c-0e41-4cc7-8cb0-fdbcae609613", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time", "rate" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a7ab1851-e78c-4b54-9712-769cb1e356e8", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time", "rate" ], "query": [], "variable": [] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "1f04017a-6742-4f32-a123-8ae3971e23bc", "name": "/time/start", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"itemid\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Starts a running timer for the authenticated user against an item.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/time/start", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time", "start" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6d0131fb-200a-4846-a026-cfb573960631", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"itemid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time", "start" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "7552d37c-0e17-4ae5-9b7b-6493d5a77f4e", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"itemid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time", "start" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b72357b6-20eb-4b3b-8071-b11daddbc640", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"itemid\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time", "start" ], "query": [], "variable": [] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "dba9fc26-3f0c-49b1-a42c-7a0cd7851519", "name": "/time/stop", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"notes\": \"\u003cstring\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Stops the currently running timer for the authenticated user.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/time/stop", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time", "stop" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "fe411d2a-9470-43f7-8b3c-d7db0a753d95", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"notes\": \"\u003cstring\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time", "stop" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4a0dbd47-6f43-4290-9564-b50ad0f74aac", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"notes\": \"\u003cstring\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time", "stop" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "cd203ed1-b64a-406f-848f-84c02aca9765", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"notes\": \"\u003cstring\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time", "stop" ], "query": [], "variable": [] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "ab94421a-a5b5-4725-b718-fe3eed6ad0af", "name": "/time/uninvoice", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Marks one or more time log entries as not invoiced.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/time/uninvoice", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time", "uninvoice" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "18325087-3775-41dc-9519-34a5f7fd514e", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time", "uninvoice" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ab77dd0e-a0c7-4c51-8b7a-79335d1929d6", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time", "uninvoice" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ceb0f754-a390-4e7b-bca2-dbf88a62accf", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time", "uninvoice" ], "query": [], "variable": [] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "e31bb69c-e38c-400f-8478-933ba185a9b5", "name": "/time/:timeid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns details of a single Time Record by ID.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/time/:timeid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time", ":timeid" ], "query": [], "variable": [ { "description": { "content": "(Required) Time Record ID", "type": "text/plain" }, "disabled": false, "key": "timeid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"accountedfor\": \"\u003cboolean\u003e\",\n \"billable\": \"\u003cboolean\u003e\",\n \"companyid\": \"\u003cinteger\u003e\",\n \"companyname\": \"\u003cstring\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"contactname\": \"\u003cstring\u003e\",\n \"endtime\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"itemcollectionid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"itemname\": \"\u003cstring\u003e\",\n \"lastmodifiedutc\": \"\u003cstring\u003e\",\n \"notes\": \"\u003cstring\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeallocationid\": \"\u003cinteger\u003e\",\n \"timespent\": \"\u003cnumber\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "200e4a45-6fcf-451c-aaf4-6469e4ef82bd", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time", ":timeid" ], "query": [], "variable": [ { "description": { "content": "(Required) Time Record ID", "type": "text/plain" }, "disabled": false, "key": "timeid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9743dbe8-e89f-4a45-917f-6823b1eb57eb", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time", ":timeid" ], "query": [], "variable": [ { "description": { "content": "(Required) Time Record ID", "type": "text/plain" }, "disabled": false, "key": "timeid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "210f161f-e8f0-43a5-ac49-ad7cfbd7dc47", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time", ":timeid" ], "query": [], "variable": [ { "description": { "content": "(Required) Time Record ID", "type": "text/plain" }, "disabled": false, "key": "timeid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "eb5aaaf9-1a87-4f8f-9091-ed7ac298efcb", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time", ":timeid" ], "query": [], "variable": [ { "description": { "content": "(Required) Time Record ID", "type": "text/plain" }, "disabled": false, "key": "timeid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "45f5bd5a-0fd6-4d92-bf94-d05342d8d31d", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time", ":timeid" ], "query": [], "variable": [ { "description": { "content": "(Required) Time Record ID", "type": "text/plain" }, "disabled": false, "key": "timeid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "d380c81c-effe-40d3-a7dd-e743171e2c7f", "name": "/time/:timeid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"itemid\": \"\u003cinteger\u003e\",\n \"notes\": \"\u003cstring\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Update an existing Time Record.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/time/:timeid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time", ":timeid" ], "query": [], "variable": [ { "description": { "content": "(Required) Time Record ID", "type": "text/plain" }, "disabled": false, "key": "timeid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d9518033-3713-47bf-87c4-de69154a3890", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"itemid\": \"\u003cinteger\u003e\",\n \"notes\": \"\u003cstring\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time", ":timeid" ], "query": [], "variable": [ { "description": { "content": "(Required) Time Record ID", "type": "text/plain" }, "disabled": false, "key": "timeid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "084c6a76-d8ce-40ee-8cf5-7cff048e33b0", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"itemid\": \"\u003cinteger\u003e\",\n \"notes\": \"\u003cstring\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time", ":timeid" ], "query": [], "variable": [ { "description": { "content": "(Required) Time Record ID", "type": "text/plain" }, "disabled": false, "key": "timeid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e5b55a91-b07b-436b-b927-ce46ac75454b", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"itemid\": \"\u003cinteger\u003e\",\n \"notes\": \"\u003cstring\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time", ":timeid" ], "query": [], "variable": [ { "description": { "content": "(Required) Time Record ID", "type": "text/plain" }, "disabled": false, "key": "timeid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "cc5ae086-1948-4ada-bb46-4d8453cf902e", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"itemid\": \"\u003cinteger\u003e\",\n \"notes\": \"\u003cstring\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timespent\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time", ":timeid" ], "query": [], "variable": [ { "description": { "content": "(Required) Time Record ID", "type": "text/plain" }, "disabled": false, "key": "timeid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] }, { "event": [], "id": "37a22e55-b554-47cc-bac3-cd908e04654f", "name": "/time/:timeid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Delete an existing Time Record.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/time/:timeid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time", ":timeid" ], "query": [], "variable": [ { "description": { "content": "(Required) Time Record ID", "type": "text/plain" }, "disabled": false, "key": "timeid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2e00b85b-002a-4c09-b419-073a97e88245", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time", ":timeid" ], "query": [], "variable": [ { "description": { "content": "(Required) Time Record ID", "type": "text/plain" }, "disabled": false, "key": "timeid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "290b8952-28fb-4cbc-a546-823abffdb656", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time", ":timeid" ], "query": [], "variable": [ { "description": { "content": "(Required) Time Record ID", "type": "text/plain" }, "disabled": false, "key": "timeid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "6cc6dc2e-45fd-498d-ac38-ffd3a059ba73", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time", ":timeid" ], "query": [], "variable": [ { "description": { "content": "(Required) Time Record ID", "type": "text/plain" }, "disabled": false, "key": "timeid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "94e2685f-f563-494b-b25d-29fa4656edc9", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "time", ":timeid" ], "query": [], "variable": [ { "description": { "content": "(Required) Time Record ID", "type": "text/plain" }, "disabled": false, "key": "timeid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] } ], "name": "time" }, { "description": "", "item": [ { "event": [], "id": "a6e96c06-5d6a-4e29-9458-d80e2c63d6e5", "name": "/timeallocations", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Time Allocations based on the specified filters. The fields parameter allows you to choose which data fields to return for each allocation.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/timeallocations", "url": { "host": [ "{{baseUrl}}" ], "path": [ "timeallocations" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: contact, item (or task), itemid (or taskid), project, time, labour, all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "contact,item,project,time" }, { "description": { "content": "Project ID or list of Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Contact ID or list of Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "contactid", "value": "\u003cstring\u003e" }, { "description": { "content": "Item (task) ID or list of IDs (comma-separated). Alias: taskid", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Alias for itemid parameter.", "type": "text/plain" }, "disabled": true, "key": "taskid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "active" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Allocations with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Allocations with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Time Allocation IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,contactid,itemid,taskid,projectid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"contactid\": \"\u003cinteger\u003e\",\n \"estinlabour\": \"\u003cnumber\u003e\",\n \"estoutlabour\": \"\u003cnumber\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inlabourprice\": \"\u003cnumber\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"outlabourprice\": \"\u003cnumber\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timebillable\": \"\u003cinteger\u003e\"\n },\n {\n \"contactid\": \"\u003cinteger\u003e\",\n \"estinlabour\": \"\u003cnumber\u003e\",\n \"estoutlabour\": \"\u003cnumber\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inlabourprice\": \"\u003cnumber\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"outlabourprice\": \"\u003cnumber\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timebillable\": \"\u003cinteger\u003e\"\n }\n ],\n \"meta\": {\n \"count\": \"\u003cinteger\u003e\",\n \"total\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "bb985535-14c3-48de-b90d-1b1c4e704d6b", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "timeallocations" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: contact, item (or task), itemid (or taskid), project, time, labour, all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "contact,item,project,time" }, { "description": { "content": "Project ID or list of Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Contact ID or list of Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "contactid", "value": "\u003cstring\u003e" }, { "description": { "content": "Item (task) ID or list of IDs (comma-separated). Alias: taskid", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Alias for itemid parameter.", "type": "text/plain" }, "disabled": true, "key": "taskid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "active" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Allocations with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Allocations with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Time Allocation IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,contactid,itemid,taskid,projectid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2e611d13-a90b-488a-a27d-8425c54d5cfc", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "timeallocations" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: contact, item (or task), itemid (or taskid), project, time, labour, all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "contact,item,project,time" }, { "description": { "content": "Project ID or list of Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Contact ID or list of Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "contactid", "value": "\u003cstring\u003e" }, { "description": { "content": "Item (task) ID or list of IDs (comma-separated). Alias: taskid", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Alias for itemid parameter.", "type": "text/plain" }, "disabled": true, "key": "taskid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "active" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Allocations with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Allocations with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Time Allocation IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,contactid,itemid,taskid,projectid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "bde5cebd-c736-4298-be6b-08f21df15ffb", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "timeallocations" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: contact, item (or task), itemid (or taskid), project, time, labour, all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "contact,item,project,time" }, { "description": { "content": "Project ID or list of Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Contact ID or list of Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "contactid", "value": "\u003cstring\u003e" }, { "description": { "content": "Item (task) ID or list of IDs (comma-separated). Alias: taskid", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Alias for itemid parameter.", "type": "text/plain" }, "disabled": true, "key": "taskid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "active" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Allocations with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Allocations with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Time Allocation IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,contactid,itemid,taskid,projectid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "51a52b46-c7e8-48e7-ab7b-190865e0654e", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "timeallocations" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: contact, item (or task), itemid (or taskid), project, time, labour, all", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "contact,item,project,time" }, { "description": { "content": "Project ID or list of Project IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "projectid", "value": "\u003cstring\u003e" }, { "description": { "content": "Contact ID or list of Contact IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "contactid", "value": "\u003cstring\u003e" }, { "description": { "content": "Item (task) ID or list of IDs (comma-separated). Alias: taskid", "type": "text/plain" }, "disabled": true, "key": "itemid", "value": "\u003cstring\u003e" }, { "description": { "content": "Alias for itemid parameter.", "type": "text/plain" }, "disabled": true, "key": "taskid", "value": "\u003cstring\u003e" }, { "description": { "content": "Filter by project status (This can only be one of active,complete,all)", "type": "text/plain" }, "disabled": true, "key": "projectstatus", "value": "active" }, { "description": { "content": "Division ID (Advanced plan only)", "type": "text/plain" }, "disabled": true, "key": "divisionid", "value": "\u003cstring\u003e" }, { "description": { "content": "Allocations with ID \u003e= this value", "type": "text/plain" }, "disabled": true, "key": "idfrom", "value": "\u003cstring\u003e" }, { "description": { "content": "Allocations with ID \u003c= this value", "type": "text/plain" }, "disabled": true, "key": "idto", "value": "\u003cstring\u003e" }, { "description": { "content": "List of Time Allocation IDs (comma-separated)", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,contactid,itemid,taskid,projectid)", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "id" }, { "description": { "content": "Sort order (This can only be one of asc,desc)", "type": "text/plain" }, "disabled": true, "key": "sortorder", "value": "asc" }, { "description": { "content": "Page number (must be used with pagesize)", "type": "text/plain" }, "disabled": true, "key": "pagenumber", "value": "\u003cinteger\u003e" }, { "description": { "content": "Page size (must be used with pagenumber)", "type": "text/plain" }, "disabled": true, "key": "pagesize", "value": "\u003cinteger\u003e" }, { "description": { "content": "Include total row count in meta (default false). Set to true to run the count query.", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "84375b49-83bf-4941-96c2-70370ae757fb", "name": "/timeallocations", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "[\n {\n \"contactid\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n },\n {\n \"contactid\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n }\n]" }, "description": { "content": "Updates multiple Time Allocations in a single call. Each item in the array must include an id.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/timeallocations", "url": { "host": [ "{{baseUrl}}" ], "path": [ "timeallocations" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "ddc9820a-6893-49bd-bab5-d4ac4d300cc8", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "[\n {\n \"contactid\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n },\n {\n \"contactid\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n }\n]" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "timeallocations" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "44edc0ee-c692-4aee-b1c5-25e4a40e43a5", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "[\n {\n \"contactid\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n },\n {\n \"contactid\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n }\n]" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "timeallocations" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "b3dc6406-6f4b-49be-be8e-22680990db57", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "[\n {\n \"contactid\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n },\n {\n \"contactid\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n }\n]" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "timeallocations" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "796cf779-2f35-4720-9202-e12c0812ad49", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "[\n {\n \"contactid\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n },\n {\n \"contactid\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n }\n]" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "timeallocations" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "69451046-fe65-4b2a-92ea-c51dc9b7c667", "name": "/timeallocations", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "[\n {\n \"contactid\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n },\n {\n \"contactid\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n }\n]" }, "description": { "content": "Creates one or more Time Allocations. Accepts a JSON array of objects matching the SetTimeAllocationInput schema.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "name": "/timeallocations", "url": { "host": [ "{{baseUrl}}" ], "path": [ "timeallocations" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4546984a-9708-4cda-998d-b7d968f8bf01", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "[\n {\n \"contactid\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n },\n {\n \"contactid\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n }\n]" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "timeallocations" ], "query": [], "variable": [] } }, "status": "Created" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "107c075e-bc31-4987-9b37-8916fca0959e", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "[\n {\n \"contactid\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n },\n {\n \"contactid\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n }\n]" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "timeallocations" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "00490d8b-e199-4ee8-b665-c986fc72443a", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "[\n {\n \"contactid\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n },\n {\n \"contactid\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n }\n]" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "timeallocations" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "73175c5b-b7ce-42cd-980c-d33cda75fd7a", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "[\n {\n \"contactid\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n },\n {\n \"contactid\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n }\n]" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "POST", "url": { "host": [ "{{baseUrl}}" ], "path": [ "timeallocations" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "7a9b4c2c-ea51-4525-9709-081d8344d4af", "name": "/timeallocations", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Deletes multiple Time Allocations by ID. The GraphQL setTimeAllocation mutation is called with deleted=true for each allocation.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/timeallocations", "url": { "host": [ "{{baseUrl}}" ], "path": [ "timeallocations" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8f2cb36d-d290-4ab7-9f9d-62b599f6671d", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "timeallocations" ], "query": [], "variable": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a0be8570-2ca4-4582-a46e-66dd4e6af43e", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "timeallocations" ], "query": [], "variable": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "4cde8beb-a79d-44da-88d5-7923582112d5", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "timeallocations" ], "query": [], "variable": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9efadde7-12c6-4a8d-9177-5d678b853010", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "timeallocations" ], "query": [], "variable": [] } }, "status": "Forbidden" } ] }, { "event": [], "id": "4c518d3c-8634-485a-ae73-bb6f488700f5", "name": "/timeallocations/:timeallocationid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns details of a single Time Allocation.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/timeallocations/:timeallocationid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "timeallocations", ":timeallocationid" ], "query": [], "variable": [ { "description": { "content": "(Required) Time Allocation ID", "type": "text/plain" }, "disabled": false, "key": "timeallocationid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"contactid\": \"\u003cinteger\u003e\",\n \"estinlabour\": \"\u003cnumber\u003e\",\n \"estoutlabour\": \"\u003cnumber\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inlabourprice\": \"\u003cnumber\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"outlabourprice\": \"\u003cnumber\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\",\n \"timebillable\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9bc341d1-50ab-4b08-b430-2aa2ebe4a96e", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "timeallocations", ":timeallocationid" ], "query": [], "variable": [ { "description": { "content": "(Required) Time Allocation ID", "type": "text/plain" }, "disabled": false, "key": "timeallocationid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "312f2422-3ff1-4cc6-8e9b-9ff3a44fb82d", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "timeallocations", ":timeallocationid" ], "query": [], "variable": [ { "description": { "content": "(Required) Time Allocation ID", "type": "text/plain" }, "disabled": false, "key": "timeallocationid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "528acdbd-52c9-4f96-9c47-de56484e7a28", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "timeallocations", ":timeallocationid" ], "query": [], "variable": [ { "description": { "content": "(Required) Time Allocation ID", "type": "text/plain" }, "disabled": false, "key": "timeallocationid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "2c5e1970-7bf7-45c7-b03d-bba3c4c624f0", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "timeallocations", ":timeallocationid" ], "query": [], "variable": [ { "description": { "content": "(Required) Time Allocation ID", "type": "text/plain" }, "disabled": false, "key": "timeallocationid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "316b7dcc-2c25-49c7-a4b6-2e88d2f36847", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "timeallocations", ":timeallocationid" ], "query": [], "variable": [ { "description": { "content": "(Required) Time Allocation ID", "type": "text/plain" }, "disabled": false, "key": "timeallocationid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "18b79e32-5d13-4cdd-bccc-7f72d0cb3459", "name": "/timeallocations/:timeallocationid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n}" }, "description": { "content": "Updates an existing Time Allocation.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/timeallocations/:timeallocationid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "timeallocations", ":timeallocationid" ], "query": [], "variable": [ { "description": { "content": "(Required) Time Allocation ID", "type": "text/plain" }, "disabled": false, "key": "timeallocationid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "0620c0e7-82c8-4c8a-a2c6-4dd4a161e0a0", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "timeallocations", ":timeallocationid" ], "query": [], "variable": [ { "description": { "content": "(Required) Time Allocation ID", "type": "text/plain" }, "disabled": false, "key": "timeallocationid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a1eb9afc-4527-4fb9-a0ff-d08221e80b52", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "timeallocations", ":timeallocationid" ], "query": [], "variable": [ { "description": { "content": "(Required) Time Allocation ID", "type": "text/plain" }, "disabled": false, "key": "timeallocationid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9550f56a-d6e9-4c65-9143-4d80769e473c", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "timeallocations", ":timeallocationid" ], "query": [], "variable": [ { "description": { "content": "(Required) Time Allocation ID", "type": "text/plain" }, "disabled": false, "key": "timeallocationid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "72580991-3f37-49ee-bbbf-31c1440f5489", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"contactid\": \"\u003cinteger\u003e\",\n \"hourlyrateserviceid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"starttime\": \"\u003cstring\u003e\",\n \"timeBillable\": \"\u003cinteger\u003e\",\n \"timeallocated\": \"\u003cinteger\u003e\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "PUT", "url": { "host": [ "{{baseUrl}}" ], "path": [ "timeallocations", ":timeallocationid" ], "query": [], "variable": [ { "description": { "content": "(Required) Time Allocation ID", "type": "text/plain" }, "disabled": false, "key": "timeallocationid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] }, { "event": [], "id": "5a8ee1ec-f1da-4b17-97f7-b6bbee5668b3", "name": "/timeallocations/:timeallocationid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Deletes a single Time Allocation by ID.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/timeallocations/:timeallocationid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "timeallocations", ":timeallocationid" ], "query": [], "variable": [ { "description": { "content": "(Required) Time Allocation ID", "type": "text/plain" }, "disabled": false, "key": "timeallocationid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": \"\",\n \"message\": \"\u003cstring\u003e\",\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "01fdd65d-9b0d-4d83-85c6-1cd9af02920f", "name": "OK", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "timeallocations", ":timeallocationid" ], "query": [], "variable": [ { "description": { "content": "(Required) Time Allocation ID", "type": "text/plain" }, "disabled": false, "key": "timeallocationid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f233a8eb-bf82-4163-9fd4-6838b7816731", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "timeallocations", ":timeallocationid" ], "query": [], "variable": [ { "description": { "content": "(Required) Time Allocation ID", "type": "text/plain" }, "disabled": false, "key": "timeallocationid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "8a581111-55a0-4517-89cf-b9bc6d4b8a4d", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "timeallocations", ":timeallocationid" ], "query": [], "variable": [ { "description": { "content": "(Required) Time Allocation ID", "type": "text/plain" }, "disabled": false, "key": "timeallocationid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "22dcfc4d-c7e5-49bd-93a9-b91bfa9d2726", "name": "Forbidden", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "timeallocations", ":timeallocationid" ], "query": [], "variable": [ { "description": { "content": "(Required) Time Allocation ID", "type": "text/plain" }, "disabled": false, "key": "timeallocationid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "95a001c6-b71b-4fb0-835a-933432515ad5", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "\u003cAPI Key\u003e" } ], "method": "DELETE", "url": { "host": [ "{{baseUrl}}" ], "path": [ "timeallocations", ":timeallocationid" ], "query": [], "variable": [ { "description": { "content": "(Required) Time Allocation ID", "type": "text/plain" }, "disabled": false, "key": "timeallocationid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] } ], "name": "timeallocations" } ], "variable": [ { "key": "baseUrl", "value": "https://api.proworkflow.com/api/v4" }, { "key": "apiKey", "type": "string", "value": "" } ] }