{ "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": "a727fc1d-bbee-452a-b176-f7cef2060334", "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": "a41ca31d-4a08-4970-a8cd-40857399d43a", "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": "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": "Legacy fuzzy search term across name, code, and email (prefix with ! to negate)", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Legacy partial match on company name (prefix with ! to negate)", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Legacy partial match on company code (prefix with ! to negate)", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Legacy partial match on company email (prefix with ! to negate)", "type": "text/plain" }, "disabled": true, "key": "searchemail", "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": "Maximum results when using fuzzy search (q). Default 10, max 100", "type": "text/plain" }, "disabled": true, "key": "qlimit", "value": "10" }, { "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": "other" }, { "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). When q is present, this is always forced to 1.", "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": "8a4cc79f-acd4-4f37-ba26-c66fb212279c", "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": "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": "Legacy fuzzy search term across name, code, and email (prefix with ! to negate)", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Legacy partial match on company name (prefix with ! to negate)", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Legacy partial match on company code (prefix with ! to negate)", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Legacy partial match on company email (prefix with ! to negate)", "type": "text/plain" }, "disabled": true, "key": "searchemail", "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": "Maximum results when using fuzzy search (q). Default 10, max 100", "type": "text/plain" }, "disabled": true, "key": "qlimit", "value": "10" }, { "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": "other" }, { "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). When q is present, this is always forced to 1.", "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": "c230fd17-c1d7-4d84-a3ab-f07c6cb07d30", "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": "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": "Legacy fuzzy search term across name, code, and email (prefix with ! to negate)", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Legacy partial match on company name (prefix with ! to negate)", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Legacy partial match on company code (prefix with ! to negate)", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Legacy partial match on company email (prefix with ! to negate)", "type": "text/plain" }, "disabled": true, "key": "searchemail", "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": "Maximum results when using fuzzy search (q). Default 10, max 100", "type": "text/plain" }, "disabled": true, "key": "qlimit", "value": "10" }, { "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": "other" }, { "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). When q is present, this is always forced to 1.", "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": "9dd31324-7b2c-4770-9091-23a52f284b8f", "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": "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": "Legacy fuzzy search term across name, code, and email (prefix with ! to negate)", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Legacy partial match on company name (prefix with ! to negate)", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Legacy partial match on company code (prefix with ! to negate)", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Legacy partial match on company email (prefix with ! to negate)", "type": "text/plain" }, "disabled": true, "key": "searchemail", "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": "Maximum results when using fuzzy search (q). Default 10, max 100", "type": "text/plain" }, "disabled": true, "key": "qlimit", "value": "10" }, { "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": "other" }, { "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). When q is present, this is always forced to 1.", "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": "6ae39a47-e2b7-4322-b1db-84fa5e68a8b3", "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": "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": "Legacy fuzzy search term across name, code, and email (prefix with ! to negate)", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Legacy partial match on company name (prefix with ! to negate)", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Legacy partial match on company code (prefix with ! to negate)", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Legacy partial match on company email (prefix with ! to negate)", "type": "text/plain" }, "disabled": true, "key": "searchemail", "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": "Maximum results when using fuzzy search (q). Default 10, max 100", "type": "text/plain" }, "disabled": true, "key": "qlimit", "value": "10" }, { "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": "other" }, { "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). When q is present, this is always forced to 1.", "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": "987c8b90-4171-493e-9923-68e524370aa7", "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": "02dedaaf-45de-4308-b9aa-ad6f2656d9f2", "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": "26f50467-c288-4335-8f60-80cd5218720a", "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": "c3652ec8-c7da-4a1e-8b6d-e4dbaed425f6", "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": "484abe6f-216d-449b-b59c-7d0fcfce1326", "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": "a76ca473-4e1e-4c9a-8a7f-bb61883a4fef", "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": "Legacy fuzzy search term across name, code, and email (prefix with ! to negate)", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Legacy partial match on company name (prefix with ! to negate)", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Legacy partial match on company code (prefix with ! to negate)", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Legacy partial match on company email (prefix with ! to negate)", "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": "7725a22a-54ce-42c3-9854-c80a06784c8e", "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": "Legacy fuzzy search term across name, code, and email (prefix with ! to negate)", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Legacy partial match on company name (prefix with ! to negate)", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Legacy partial match on company code (prefix with ! to negate)", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Legacy partial match on company email (prefix with ! to negate)", "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": "8c38bd32-8392-484f-986f-48e3d9d00ed5", "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": "Legacy fuzzy search term across name, code, and email (prefix with ! to negate)", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Legacy partial match on company name (prefix with ! to negate)", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Legacy partial match on company code (prefix with ! to negate)", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Legacy partial match on company email (prefix with ! to negate)", "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": "2829a222-3a0b-4d07-923c-ec2c5831c0ca", "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": "Legacy fuzzy search term across name, code, and email (prefix with ! to negate)", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Legacy partial match on company name (prefix with ! to negate)", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Legacy partial match on company code (prefix with ! to negate)", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Legacy partial match on company email (prefix with ! to negate)", "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": "e7fd61f2-2e7b-4d4b-bf3e-05fc4637e25b", "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": "Legacy fuzzy search term across name, code, and email (prefix with ! to negate)", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Legacy partial match on company name (prefix with ! to negate)", "type": "text/plain" }, "disabled": true, "key": "searchname", "value": "\u003cstring\u003e" }, { "description": { "content": "Legacy partial match on company code (prefix with ! to negate)", "type": "text/plain" }, "disabled": true, "key": "searchcode", "value": "\u003cstring\u003e" }, { "description": { "content": "Legacy partial match on company email (prefix with ! to negate)", "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": "923d0a47-2b69-4fc5-9bb9-6eea6579bb1a", "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": "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": "9a0089ab-7341-455e-a21a-5d5037a7d0e3", "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": "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": "b57ec2a9-d597-4b86-85ff-d9962ab04c33", "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": "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": "4550907b-2f57-4be7-864c-70187bf49170", "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": "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": "0ce53a7a-6cbe-4a51-86e9-2153ad386aa6", "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": "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": "4d3de688-986d-4403-a69d-12dfccc48e6a", "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": "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": "bb0cbde7-5147-40d4-9895-d1338a9c0f6c", "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": "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": "39d1435b-9fba-4ec5-aece-e9d728b2686b", "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": "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": "92d030b8-a30e-4972-ba13-9520ef57c997", "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": "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": "cd70cb4e-527d-4543-af28-732b77331e4f", "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": "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": "d158e98d-6d3b-428d-af47-ab7b35d962cb", "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": "eb9fc26c-9121-4950-afd2-dc01e190cfff", "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": "c685a352-e561-4eb8-b6a0-5c4b4bc53af5", "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": "ceceb39d-b0d6-4d95-8e80-37c76318d995", "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": "d3f02ed6-ef66-45d2-9390-ae12debd3912", "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": "2a259c3a-85e7-44c1-b696-ead130dc2a35", "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": "5f60310b-8482-4e7d-bbb3-ba0fa163f895", "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": "36e68445-664a-4f7c-9477-954bf7af10f6", "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": "8c4ea7e6-8e0d-476e-b7d4-807ad79340c3", "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": "775e2e17-c4fd-44f7-ac23-fe9e3ad2f71e", "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": "dec70a65-abc5-4fc6-ba68-4395072d5791", "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": "754b50be-d047-40c6-8203-92f4bb5b07d2", "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": "e2ab5c7f-f70f-4e0c-8498-616e4ccb472d", "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": "a6dadcc2-bce1-4b7f-913b-e3ca1c16da88", "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": "19623895-65f0-4574-951a-f1fb42945b76", "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": "43001e85-8406-44c6-a204-9117757a0dd2", "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\": \"contractor\",\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": "86862472-42a3-4cbe-83da-2dee5b00ca0c", "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\": \"contractor\",\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": "266ab559-622f-40d0-a7a5-6c8551e63b63", "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\": \"contractor\",\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": "cd129d6d-56e5-495b-9ad6-dabf22794795", "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\": \"contractor\",\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": "3267d3c3-29b1-4c31-adc2-9462b8ad2cc1", "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\": \"contractor\",\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": "206d798c-e794-44b8-9180-59b31d1f655f", "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\": \"contractor\",\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": "26a7d927-e0ac-48a4-b825-2faa6a2cdb97", "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": "2ed57cce-0920-47c7-a88a-a8523bd191db", "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": "c1dc552e-d8d7-4ad3-bc38-c360e79f7f8d", "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": "5705e529-c1a8-44fe-b992-80420fc6119f", "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": "8ef2326c-05f4-49e7-8367-e9ee4c15d5c0", "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": "83dc5fac-cc3f-4b9c-ba69-fadad6993557", "name": "/companies/:companyid/files", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Files for a Company 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": "/companies/:companyid/files", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: date, description, folder, link, name, owner, size", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,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": "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,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) 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 \"contactid\": \"\u003cinteger\u003e\",\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 \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"itemname\": \"\u003cstring\u003e\",\n \"link\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"pastedimage\": \"\u003cboolean\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\u003e\",\n \"size\": \"\u003cinteger\u003e\"\n },\n {\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\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 \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"itemname\": \"\u003cstring\u003e\",\n \"link\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"pastedimage\": \"\u003cboolean\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\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": "98fdcaea-7ff9-4aa7-8781-486eb5353234", "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", "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: date, description, folder, link, name, owner, size", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,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": "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,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) 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": "1671ae33-6ec6-40a7-80e2-09400369afb1", "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", "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: date, description, folder, link, name, owner, size", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,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": "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,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) 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": "036d1e7e-ff0e-46fe-84b8-d9a2ed3986e5", "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", "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: date, description, folder, link, name, owner, size", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,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": "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,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) 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": "becf08c8-e9e4-4bd5-95a4-67a4a1ea70c9", "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", "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: date, description, folder, link, name, owner, size", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,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": "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,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) 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": "aee29399-8270-48c3-8feb-6180a884c2c9", "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", "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: date, description, folder, link, name, owner, size", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,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": "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,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) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "e2d10ed0-8c01-4c9e-8125-009ee75e2aa2", "name": "/companies/:companyid/files", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "mode": "formdata" }, "description": { "content": "Upload a file to a Company's root folder. Send a multipart/form-data request with the file in the \"file\" field. 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": "/companies/:companyid/files", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "files" ], "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 \"fileid\": \"\u003cinteger\u003e\",\n \"filesize\": \"\u003cinteger\u003e\",\n \"folderid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"pastedimage\": \"\u003cboolean\u003e\",\n \"uniquetoken\": \"\u003cstring\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "469aa572-ae19-4a10-81e9-bce3b39d5cd3", "name": "Created", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "companies", ":companyid", "files" ], "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": "16ff80b7-92ef-4e04-87c7-987093db7b4c", "name": "Bad Request", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "companies", ":companyid", "files" ], "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": "eee20233-9609-44ca-9127-a343b2579d17", "name": "Unauthorized", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "companies", ":companyid", "files" ], "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": "e1bcb67e-a140-4058-aa0a-25bb81009489", "name": "Forbidden", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "companies", ":companyid", "files" ], "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": "33c9d549-6ca0-454e-ae88-ad0504697710", "name": "Not Found", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "companies", ":companyid", "files" ], "query": [], "variable": [ { "description": { "content": "(Required) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "1f1cb63a-80e0-4b25-9dea-b2f26196d5d0", "name": "/companies/:companyid/folders", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of custom Folders for a Company based on the specified filters.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/companies/:companyid/folders", "url": { "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyid", "folders" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: name, description, type, size, date, owner, contacts, 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) 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 \"contactid\": \"\u003cinteger\u003e\",\n \"contacts\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"contacts\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\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": "1c6cf829-4b75-4673-8a3c-942a40372f9b", "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", "folders" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: name, description, type, size, date, owner, contacts, 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) 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": "d3fd10a3-8c1e-4b76-be99-a59db95b5c35", "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", "folders" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: name, description, type, size, date, owner, contacts, 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) 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": "5fad0d68-8f8e-42e0-84f1-8bba11f29fd9", "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", "folders" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: name, description, type, size, date, owner, contacts, 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) 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": "b22381b1-019d-4a0e-84e0-42d87bfb5aad", "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", "folders" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: name, description, type, size, date, owner, contacts, 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) 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": "5d57297b-e04c-4630-844c-6b18d448aa9c", "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", "folders" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: name, description, type, size, date, owner, contacts, 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) Company ID", "type": "text/plain" }, "disabled": false, "key": "companyid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "2e7f6ac5-65a5-40a1-8666-a6aada1420ba", "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": "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": "true" }, { "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": "active" }, { "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": "377e4518-754f-434b-83bd-09f71c008c63", "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": "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": "true" }, { "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": "active" }, { "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": "4618cf32-5655-4143-b523-359088b45551", "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": "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": "true" }, { "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": "active" }, { "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": "fce0d602-4485-4f13-a4f2-9d238e0a69e1", "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": "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": "true" }, { "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": "active" }, { "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": "c0bef617-43b5-4c08-b0f4-1cd8638a48f1", "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": "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": "true" }, { "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": "active" }, { "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": "6e9ce04f-7a6d-4cdf-90c9-11e84759f812", "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": "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": "90c084c6-efea-48f6-9144-6f78ec828dcb", "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": "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": "d093fe2f-a5ac-4b9e-9fd8-ec353b4e2c91", "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": "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": "3034a769-f17e-46c1-8759-4caae9df0244", "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": "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": "688e0046-1e42-4433-8c43-3cb22b025dcf", "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": "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": "f63f5edd-7995-430c-a8e0-87358320d3a4", "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": "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": "f44f77ad-3551-471f-b0d5-b47a97a1d1e9", "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": "false" }, { "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": "ff451ab6-7178-4fd6-8696-69c9cde75701", "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": "false" }, { "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": "649ec1dc-b2b8-45e7-b327-53e1eaedb0d5", "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": "false" }, { "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": "662afef3-d0c8-4666-b69a-da760b9bf11b", "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": "false" }, { "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": "23c1455d-549e-4c45-9616-0a33e1cc1365", "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": "false" }, { "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": "3d53aafa-1c6d-485e-81b4-ce75fb7ef4ca", "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": "e66fb2a6-499a-4e9d-b750-062a67b5c3ab", "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": "3e0bdc9a-114e-40d3-ada4-4ffc7b524715", "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": "28093679-3cf4-4331-a09b-c1833ff49e78", "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": "12edee2c-a1a1-4412-abbf-fed0a638ca10", "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": "635006f1-d02a-4dd3-a865-d4f433fd7214", "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": "4c635c3c-ca5e-46ec-bbc0-16494311a6f9", "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": "59030c2f-4ed2-43d0-a270-27af3c29215f", "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": "2342089e-2865-4efc-9b70-68328a396db1", "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": "f2d0b3b1-add8-4def-b159-f26f14a6ff1e", "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": "e1ec6ede-4db9-4d20-ab76-73c6b34632df", "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": "892171e8-ed81-4a68-a452-bc04826fc965", "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": "93618ce0-901e-4030-8ead-aca445b30967", "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": "4d81fe08-e690-4e75-84da-9a3a2a9b8ca2", "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": "71d5dcf9-2143-4e12-8c83-49078f78182e", "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": "ed510f11-2f98-4dcc-9e7a-2200b489b611", "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": "ee6312e7-6050-40a9-98ac-8cf8bd0ecec8", "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": "09c9fd99-ac90-4515-879c-4cea3da66076", "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": "ed6ef5c6-14b9-4c03-826f-e1198af47596", "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": "066b264c-4458-4bd2-8f6a-f74b08321ac1", "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": "9c9a3a2e-17a0-4393-a6ab-719ef3f3efc9", "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": "03a29c2b-3a55-4350-bdc1-37bd6bdcd9d4", "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": "3320a768-7055-422e-9e89-0fc4798308cf", "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": "d31014eb-e5c9-4203-92a4-75028675f472", "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": "6eb026a0-a9a3-40cc-9798-bbb28fd3f481", "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": "4d5ee9d7-86b8-4917-a478-b3df190e1067", "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": "936156a2-0a14-43a2-a720-4cce4d532cf5", "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": "880b9b52-5c00-48f7-b2ca-b1512b6a8e73", "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": "6a93fe7d-5c15-4307-84b5-955337efb614", "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": "31b17674-d784-4428-9380-f77770b54bd1", "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": "9ec41c40-a9a1-429c-9749-dce2d8f38384", "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": "4c0a5bfe-c48c-4de2-816c-caabf5470cb4", "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": "b83f898a-d9a1-464a-8836-5df1158eb807", "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": "79ee5cce-bfca-4309-9a5f-71ee63bd4ce8", "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": "53196b5b-b499-4b48-87c1-8990e3686c74", "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": "162bc1d0-f8b4-45b7-b665-5fae42488846", "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": "b1a1ba48-f5c4-4fe5-b83b-5b7680e512cc", "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": "ba7659e8-89dc-4e96-b223-59462c9dc316", "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": "787c59f4-0eea-4c6d-a497-f6b0d58af84c", "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": "a2d1f1cd-b729-4963-8c91-214d59b2491d", "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": "4a54e9f4-07b4-4bbd-b737-4d390ee1c2e6", "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": "4fb6b39c-9157-45cd-8d1c-9f4e0f00cf1b", "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": "81033bf5-5461-45d3-8e79-61ecfbb55ed7", "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": "c304d1d9-af02-4ecf-861d-aa9b8c4c3438", "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": "7f04edc5-f707-4529-beca-c46f5262e7f2", "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": "54252b01-4d6e-4bb0-855d-6558ccfbd951", "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": "a0a262f6-3f63-4edb-a97d-42efe9f21df6", "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": "7b2fdcd9-a4a3-40d6-8d57-0ca91c35db44", "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": "abb55b01-ece9-4839-a2cf-569695aa86cd", "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": "7b48300e-a9a7-42fb-9c52-a13341a2ee7b", "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": "76807e50-367a-436e-985b-fe5ea01a40ce", "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": "b679db0f-1ff6-41d1-9970-1edf99d748e4", "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": "Project status (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "all" }, { "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": "72061f01-b444-4916-bddf-4f7a33ea0acd", "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": "Project status (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "all" }, { "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": "028e738f-eccd-4a91-9cc3-f03330de0cc9", "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": "Project status (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "all" }, { "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": "cc4aa380-e0b9-44e0-bbbc-b8d950162e01", "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": "Project status (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "all" }, { "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": "eaca02db-6b1d-406c-89cb-bc9fb55d1d54", "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": "Project status (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "all" }, { "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": "bdeb491a-dfce-4931-a06a-715478e93c75", "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": "2f95263b-a5e4-46ba-a00f-4396569a5d08", "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": "e0ce4e2b-151e-44d2-985d-a3ed1aa8b32c", "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": "faff22a3-b7f9-436f-8190-b55f5d147ed1", "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": "a720d7bc-7cc8-4b10-ab8d-0fbe3b181156", "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": "722ce8e3-2d2d-4f88-8c27-6f879d05ed48", "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": "e8293a2c-495d-469c-9f5c-78e9e500c6b8", "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": "Quote status (This can only be one of pending,sent,accepted,addedtoproject,declined,expired,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "deleted" }, { "description": { "content": "Quote type (This can only be one of estimate,quote,all)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "estimate" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "true" }, { "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": "active" }, { "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": "week" }, { "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": "36c5bb37-1180-4d64-a7c9-5ee748cc51a5", "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": "Quote status (This can only be one of pending,sent,accepted,addedtoproject,declined,expired,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "deleted" }, { "description": { "content": "Quote type (This can only be one of estimate,quote,all)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "estimate" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "true" }, { "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": "active" }, { "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": "week" }, { "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": "3b473f43-483e-414f-b9a9-06a0a9c478d8", "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": "Quote status (This can only be one of pending,sent,accepted,addedtoproject,declined,expired,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "deleted" }, { "description": { "content": "Quote type (This can only be one of estimate,quote,all)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "estimate" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "true" }, { "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": "active" }, { "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": "week" }, { "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": "fec56d2b-38bf-47d4-8e33-8db658da27ba", "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": "Quote status (This can only be one of pending,sent,accepted,addedtoproject,declined,expired,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "deleted" }, { "description": { "content": "Quote type (This can only be one of estimate,quote,all)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "estimate" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "true" }, { "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": "active" }, { "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": "week" }, { "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": "f26f2cc4-040b-42ad-9631-53041f37d5f1", "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": "Quote status (This can only be one of pending,sent,accepted,addedtoproject,declined,expired,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "deleted" }, { "description": { "content": "Quote type (This can only be one of estimate,quote,all)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "estimate" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "true" }, { "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": "active" }, { "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": "week" }, { "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": "ccee623c-7aa7-493e-a529-574cb43ab40e", "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": "3875972b-bd2d-48f3-a048-06b40c9550e0", "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": "10c209ed-2d63-4ebe-aab8-76f5b2370e62", "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": "99dd2f0f-f5e3-41bb-9806-4bc0e5aaa286", "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": "b4c8c2da-d3ab-49dd-92f6-b23734f29a4c", "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": "bc8f3d83-bb34-42b4-8590-17b0c3bf993f", "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": "359cdcf3-4a80-4904-af07-f238b3fde8ca", "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": "c5950405-5705-4ea0-bf1b-fc2f66d5a88b", "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": "63f9af72-ec8b-4769-a4bb-b29f33ee643c", "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": "8c254343-52e2-4742-99d0-e48f61ba2575", "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": "8aa6fd7d-a2fb-49c7-8ff3-45c25a922338", "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": "cf8187a8-2eae-4b75-a52b-fad767c66cf8", "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": "3b1d7105-6ac3-402c-a83e-b5942ee22ebf", "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": "dd54e951-e568-41aa-8f44-24f11b1a1547", "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": "3a405bf9-ec0f-4bd5-8575-ca17d9137c43", "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": "3b9abb18-ce2e-4282-a909-17e223e4b136", "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": "30204bc9-0365-44a6-9726-c87ba3d66e94", "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": "e12a32f3-688b-4c52-9386-f7f69cb6cc65", "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": "a50b0d23-344b-4b05-b25e-2c220a39c3c7", "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": "ff1f4068-9818-40a8-bf11-1da818985745", "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": "402bad4c-9738-4dec-8d99-0a6493b99694", "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": "8378cfe9-f8dd-4175-b878-45863a859b41", "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": "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": "false" }, { "description": { "content": "Login access filter (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "false" }, { "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": "37e3adfe-005e-4068-a185-d1328d6e771b", "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": "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": "false" }, { "description": { "content": "Login access filter (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "false" }, { "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": "f8b94223-01e0-4738-aa46-32aa4153142d", "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": "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": "false" }, { "description": { "content": "Login access filter (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "false" }, { "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": "2fa93fa5-2ace-4167-a6f0-77c6b69b1d3a", "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": "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": "false" }, { "description": { "content": "Login access filter (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "false" }, { "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": "6f0bf321-b150-4922-881b-d45e333b1480", "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": "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": "false" }, { "description": { "content": "Login access filter (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "false" }, { "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": "371fbc51-2c00-4293-bf6f-8f0bc8a61dd3", "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": "dfd110cc-16d0-474e-a457-684822b74121", "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": "89495b7e-3e20-4881-aa7f-4bce3523310c", "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": "16f720d0-9738-4bef-9fc0-9a941cd3c0a6", "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": "d951a61d-2e94-4cf1-94f0-67056843eab6", "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": "83b5bb94-62c9-486b-ba3f-df4a901d867b", "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": "24783678-3de8-43a5-85a4-494c4cf71718", "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": "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": "Maximum results when using fuzzy search (q). Default 10, max 100", "type": "text/plain" }, "disabled": true, "key": "qlimit", "value": "10" }, { "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": "other" }, { "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": "false" }, { "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": "958a9d19-98a7-469d-a526-0253a9276863", "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": "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": "Maximum results when using fuzzy search (q). Default 10, max 100", "type": "text/plain" }, "disabled": true, "key": "qlimit", "value": "10" }, { "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": "other" }, { "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": "false" }, { "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": "f7d85c5d-1798-4efa-89e9-ab08a40ec52d", "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": "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": "Maximum results when using fuzzy search (q). Default 10, max 100", "type": "text/plain" }, "disabled": true, "key": "qlimit", "value": "10" }, { "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": "other" }, { "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": "false" }, { "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": "c88c0186-3129-4325-ab91-1c73900452cd", "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": "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": "Maximum results when using fuzzy search (q). Default 10, max 100", "type": "text/plain" }, "disabled": true, "key": "qlimit", "value": "10" }, { "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": "other" }, { "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": "false" }, { "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": "c68435f4-89a9-4ab4-9ba0-640d93ac5588", "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": "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": "Maximum results when using fuzzy search (q). Default 10, max 100", "type": "text/plain" }, "disabled": true, "key": "qlimit", "value": "10" }, { "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": "other" }, { "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": "false" }, { "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": "ee9cc5fb-2c50-4c16-a363-fed9a510857f", "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": "3098d47c-3873-4e53-a08a-663adb3f2c38", "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": "1e9befc0-9084-4ab4-a692-ead5c7b6131a", "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": "358718c1-bcad-477e-b0da-3ac80440335e", "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": "2b712818-175f-42eb-afd0-78c889fe7350", "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": "d3dc9639-d0e3-4b39-bcd9-6bf331bd6bb7", "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": "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": "false" }, { "description": { "content": "Login access filter (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "false" }, { "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": "f15740f8-1aa5-4532-8f32-0b25147086cd", "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": "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": "false" }, { "description": { "content": "Login access filter (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "false" }, { "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": "1170fdb5-38ba-4cca-b3e4-d027ee5ca094", "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": "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": "false" }, { "description": { "content": "Login access filter (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "false" }, { "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": "45d696a5-64e5-499e-8be1-0a0b9a21d33d", "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": "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": "false" }, { "description": { "content": "Login access filter (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "false" }, { "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": "213f8169-19c5-4d32-a56f-6352eeeeb1ba", "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": "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": "false" }, { "description": { "content": "Login access filter (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "false" }, { "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": "f1a585c7-0c9e-4d34-a242-6c745ad29290", "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": "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": "false" }, { "description": { "content": "Login access filter (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "false" }, { "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": "97c63483-036c-4a1f-aa8f-611f3809172f", "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": "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": "false" }, { "description": { "content": "Login access filter (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "false" }, { "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": "04423f9e-c592-49e6-8448-6c7041df93cf", "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": "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": "false" }, { "description": { "content": "Login access filter (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "false" }, { "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": "8dc36227-6c31-4326-a730-bb684dd39d82", "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": "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": "false" }, { "description": { "content": "Login access filter (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "false" }, { "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": "2cc711a6-ffa6-41fb-baf1-f44e05db5144", "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": "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": "false" }, { "description": { "content": "Login access filter (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "false" }, { "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": "1d8e8ade-c1df-4164-ba04-5aa12839b566", "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": "837e3661-ce5b-435d-ad84-39f84a1fb34b", "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": "ae9bd377-9a64-4e3b-acbf-5e6936a424a2", "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": "0c065ae3-f12b-47d4-aa34-1c7f663a5b21", "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": "a06aca37-68f4-4dc6-a827-7b1b3d50a3ab", "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": "860dacf4-5b0b-4cc7-a3a6-dd719875e3f9", "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": "1609c073-2130-49e5-b992-54dd37f94dfa", "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": "ee8c328a-c13c-48c5-9cbf-27ffd3c39501", "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": "ddc3f7b8-96e1-4c36-9fe1-5af9547667d3", "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": "5a0f8bdf-8456-4b0e-b7a8-5f1d8d7c7efd", "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": "ac31dfc8-edad-4d48-a0f4-76625a99242b", "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": "d7c59729-bec7-4130-ad14-9405bb178805", "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": "9150db3d-0875-4df7-9b82-42b744a1817a", "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": "7ebd3d52-d32c-4d4a-b146-2937ed05188a", "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": "9027f946-5b26-416c-acb5-db47d512fcd0", "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": "358ea1ea-a228-420d-9d2d-e7d5df945cf9", "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": "d056329b-9340-4e3b-90fd-fb431d2bc368", "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": "5a1e93b1-6ff7-4f66-b8d9-23514a01bc34", "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": "509bd5e0-9f8a-4722-9adb-402e00cdc4d4", "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": "44e21059-45be-446f-8633-e8aa36a676cd", "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": "c5c29b30-9219-4627-8a05-7f15225389c1", "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": "a6e98e3b-f504-4b02-9bb7-ff28bbfa5b4c", "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": "c1b2b288-3d99-4554-b8a5-d532edd18d89", "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": "1d016af7-8277-4e9d-a77f-c5ab9f0b5d5b", "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": "3af96cc0-0569-487e-aa11-dc8686b0cfbd", "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": "6d5cc291-846c-4506-be91-391baafbc5f4", "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": "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": "false" }, { "description": { "content": "Login access filter (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "false" }, { "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": "15284bc4-6f56-4a5c-8aef-4138be7e9e1a", "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": "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": "false" }, { "description": { "content": "Login access filter (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "false" }, { "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": "2100de6d-a589-408b-9f2b-0b5c3150c762", "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": "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": "false" }, { "description": { "content": "Login access filter (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "false" }, { "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": "6045ee08-2562-4f0b-9c1f-0fe8bbb14f8a", "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": "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": "false" }, { "description": { "content": "Login access filter (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "false" }, { "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": "c0671743-5ef8-4cd3-bd6a-95a4000aa656", "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": "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": "false" }, { "description": { "content": "Login access filter (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "false" }, { "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": "e7cf89eb-b9f1-4f8b-a91a-7a6706aae79b", "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": "178849d4-2f71-49c5-8f9e-091c15a4b223", "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": "49758625-b69f-496e-abca-1a939f00948c", "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": "b7ef7617-1fb5-46d1-aef8-26cbb753c9de", "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": "cafcac0a-5a66-481f-8cde-273dc7b5fdc4", "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": "62bba2b3-345d-462f-8b71-0efc262b6fe3", "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": "ed3c8daa-1505-4d9c-9392-74eed4d94bb8", "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": "410059d1-c36d-4ceb-9045-2e2e8b279656", "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": "275d0a6a-1189-4f1b-814c-8c366c58c121", "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": "e75d7e25-6251-42f4-b1ac-adaa7cc14e95", "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": "12f1a400-47b4-40a6-a22c-1de3ea7c602a", "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": "37c5a610-c0f3-4399-b629-621d41f210b6", "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": "e007fda7-739c-4975-884d-72272beedd6a", "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": "866dc819-ff89-475a-93a8-09a8d5afb56f", "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": "067db2ed-7d22-4e87-aa17-15789877ec47", "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": "898e67f4-6f82-463e-b6b1-f797c08aaa77", "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": "fe0798f5-b2be-4eaf-b83f-62f5e3c682eb", "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": "f1751eac-6b4f-439a-883c-7e18a46f25c5", "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": "fc2f69d2-3032-449e-8ee2-c5bbdea53589", "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": "f9383654-08c3-4700-92d0-a23dabb9d09a", "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": "90d1e471-1ea3-4904-af57-8d6e3b5ed7a1", "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": "565f718d-7be2-4fdf-be62-af70fef52c7a", "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": "5dbfd5a0-675b-49ba-a44d-08be6e9ace5b", "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": "1b19f3a5-5e7e-452e-a02f-d9db48739aca", "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": "bf772d0a-593e-4cea-afa3-25c5be5d9ae5", "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": "7a34c31a-6b3f-4247-bc8f-9bc09c418d8c", "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": "50788923-a94b-4e90-8f64-25922f492027", "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": "c3225813-6eda-43e9-87ff-974b5cf3453c", "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": "4b25331f-6ec4-4f42-9fa8-af9c7eda8a39", "name": "/contacts/:contactid/files", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Files for a Contact 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": "/contacts/:contactid/files", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: date, description, folder, link, name, owner, size", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,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": "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,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) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\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 \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"itemname\": \"\u003cstring\u003e\",\n \"link\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"pastedimage\": \"\u003cboolean\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\u003e\",\n \"size\": \"\u003cinteger\u003e\"\n },\n {\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\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 \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"itemname\": \"\u003cstring\u003e\",\n \"link\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"pastedimage\": \"\u003cboolean\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\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": "55d49ee3-1c6a-41e6-a395-17b93930e563", "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", "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: date, description, folder, link, name, owner, size", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,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": "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,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) 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": "eedad5cc-e341-4ec0-9615-2d91e61ea35a", "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", "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: date, description, folder, link, name, owner, size", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,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": "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,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) 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": "2c5edd7b-6589-42e8-8d78-d2f46f29622b", "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", "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: date, description, folder, link, name, owner, size", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,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": "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,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) 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": "937c768f-4008-4e6b-a529-ee449dbb5ae6", "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", "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: date, description, folder, link, name, owner, size", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,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": "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,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) 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": "5da8c7c8-0e02-46bd-9bb4-f75e0c6fe87f", "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", "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: date, description, folder, link, name, owner, size", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,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": "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,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) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "b31cd0c9-a7b1-48cd-bec7-41278cabcadb", "name": "/contacts/:contactid/files", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "mode": "formdata" }, "description": { "content": "Upload a file to a Contact's root folder. Send a multipart/form-data request with the file in the \"file\" field. 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": "/contacts/:contactid/files", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "files" ], "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 \"fileid\": \"\u003cinteger\u003e\",\n \"filesize\": \"\u003cinteger\u003e\",\n \"folderid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"pastedimage\": \"\u003cboolean\u003e\",\n \"uniquetoken\": \"\u003cstring\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "41b7a2cf-3895-479f-909a-efa49081216b", "name": "Created", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "contacts", ":contactid", "files" ], "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": "2fcb0dd8-b831-4ef1-8161-3c8fe4a280e7", "name": "Bad Request", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "contacts", ":contactid", "files" ], "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": "7791b068-7dd3-40bb-a7d5-f28dbb9d299a", "name": "Unauthorized", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "contacts", ":contactid", "files" ], "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": "38f03157-699a-4eb5-ac7e-eca92a0f9a30", "name": "Forbidden", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "contacts", ":contactid", "files" ], "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": "763d2806-7ce9-48b9-8520-d93006788de9", "name": "Not Found", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "contacts", ":contactid", "files" ], "query": [], "variable": [ { "description": { "content": "(Required) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "deff417c-89cc-4e7e-b86f-4d3cbed814bd", "name": "/contacts/:contactid/folders", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of custom Folders for a Contact based on the specified filters.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/contacts/:contactid/folders", "url": { "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contactid", "folders" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: name, description, type, size, date, owner, contacts, 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) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"contacts\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"contacts\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\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": "7d656ee9-bcc3-4ecd-bdc7-74dd4202c523", "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", "folders" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: name, description, type, size, date, owner, contacts, 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) 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": "57bb7ecf-7276-4ae4-b0f8-149c43e99ef6", "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", "folders" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: name, description, type, size, date, owner, contacts, 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) 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": "a3fe2691-eb79-4e37-b9f2-c0b6e48d6361", "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", "folders" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: name, description, type, size, date, owner, contacts, 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) 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": "4a7c6957-a62c-456b-a3ce-a2c403348cdd", "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", "folders" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: name, description, type, size, date, owner, contacts, 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) 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": "bd7a2ef6-c440-4cc8-9ccb-001d3411413c", "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", "folders" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: name, description, type, size, date, owner, contacts, 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) Contact ID", "type": "text/plain" }, "disabled": false, "key": "contactid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "7929f5ab-4850-4221-96e9-ff0427d8c4d5", "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": "d0c2e11f-f976-4e6c-8556-25e489db8bdf", "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": "d6aa05ff-7c95-493d-8f3b-71dafcc536e4", "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": "c7779fe3-c0e3-47ad-8446-fbd984ac516c", "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": "bfe68515-b51b-4d05-a040-4cde740e9b8c", "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": "0c4ebd9e-a209-4c68-bba1-bc2a9f09a196", "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": "901f6713-a9e0-4b0f-bd57-3d40c3c8f8a9", "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": "d94fde0b-84bb-49d6-8605-7dc868c581e0", "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": "8d8aeeaa-33d9-4b15-90f0-438f12a56568", "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": "8b909b1c-fea6-4992-b746-5b6a3a8d4571", "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": "7699a151-fd7a-4d51-9677-c77ed1178bc8", "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": "0fa411d4-436a-4f6c-855a-fd2b515b9b96", "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": "9eb9d6dc-596c-411c-a4f6-1964d63eb1a6", "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": "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": "b766cdc3-494e-4c17-ac38-8c4b025dab18", "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": "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": "8eef6ef5-bc6b-4de5-8869-b576bde5ac0f", "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": "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": "8ea9b862-e00c-4708-9860-c44454c1c51d", "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": "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": "15466f25-6f35-47c1-923d-4d279126f289", "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": "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": "55bfdd12-6cd4-4809-b876-cd5ccb9a636e", "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": "967bc803-4ffa-4e53-b65c-6e3114f4f192", "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": "bf46f00b-82a6-4581-94bd-6520881c4b87", "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": "f9d639bd-fa7f-4f21-9d90-c02454e28f77", "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": "e374e685-a50e-404a-963f-0c55cbdc37e2", "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": "20490cc6-c1ea-4d20-9963-f14a02a69017", "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": "60332c41-814c-4ea7-8ccd-e838a5c6636b", "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": "d26dc513-2e0e-4c6b-b9e7-604fd8a2eccf", "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": "11c78bef-3556-4f92-8684-e2a4d49ea3f6", "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": "283f65aa-f159-4c3d-86cc-32c6154d80ad", "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": "8472f1cf-707e-4009-90d6-c495b620e0aa", "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": "7c4776ba-ede4-427f-8e5d-0a078862848a", "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": "8596d8f1-a21a-4100-89ab-22642aa4dd6a", "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": "4c4bf1d2-12a1-48f3-89fb-bd90f249de5b", "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": "6ff478fc-6ad3-4fbe-be04-6a1a78e2d023", "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": "a23b870e-9230-45c6-bef1-563cb8928204", "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": "455478ea-af92-4d67-875f-17e20792ad28", "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": "d184cc10-f147-4254-a32d-71ae927552cf", "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": "13aa39c3-c46c-4171-879a-36ef249971d2", "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": "fcb0f103-7992-4620-8868-df873136065f", "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": "6f4feaf2-5f65-4b09-a79a-a707e2576e89", "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": "4485db9b-8365-4c7d-921c-e3b60ab6737e", "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": "79f0e664-079f-4a02-9212-bd2dde1bbc35", "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": "04f13add-433f-4fb0-9178-1eeb4c1b0386", "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": "f723b4e9-71ca-424b-9cdd-63591fa962f3", "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": "ca5d3c89-8881-4f7c-905d-f81745950dfa", "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": "89e44966-d5f5-47c1-aad8-88e9336a9db1", "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": "5e63a3e9-abac-4b1a-a3d4-6afccb922e4c", "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": "fc1ff3a1-7aeb-44c5-8a81-b560f049ecce", "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": "1f80ff18-cbf0-4109-bbf2-e2d6c6c272d4", "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": "690d33d7-159f-4b10-9ec8-f9ab3ee1485e", "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": "07c4cd29-f8be-4168-88c6-113dcc90e315", "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": "6afc945c-7563-4542-a048-b7d9a200042f", "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": "5fde040e-d1d2-480c-b8b2-34dc778d89d8", "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": "db423ccd-f9f9-4c15-9860-23711cb1bef2", "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": "76221423-af47-4dd2-ac41-cade9eefc5d9", "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": "e74cf614-3f38-4bd7-9773-af5ce85beb7b", "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": "d6723246-0cae-44e6-b45b-94c242085e1e", "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": "edec1249-50f1-4ef7-ac2f-af0b9eb5d285", "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": "b5b9a672-7c42-41f1-b211-573a92946de2", "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": "2c90375b-3998-4faf-8347-d73c8d53bc74", "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": "Project status (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "all" }, { "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": "9cb069b4-fac1-48c7-beca-e249203178c7", "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": "Project status (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "all" }, { "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": "6d55320a-fb17-4f8c-8411-3d42e3dcd3d4", "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": "Project status (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "all" }, { "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": "0f9ce9d6-b2af-464e-ab2f-3a409c89a7c4", "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": "Project status (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "all" }, { "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": "8133ebb5-7203-4c21-81c0-69235e45c705", "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": "Project status (This can only be one of active,complete,deleted,all)", "type": "text/plain" }, "disabled": true, "key": "status", "value": "all" }, { "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": "3cbb0dcd-62c2-4a9b-be73-275a515586ed", "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": "f30addf9-4b8e-4b82-88a3-85b044f65ec7", "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": "904d926c-de5a-4833-8980-5a7420df5182", "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": "b6d3db4f-9763-4a82-b161-0c9c304f6553", "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": "2b247520-3150-4efe-b861-12889e06f5bb", "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": "183f7fd8-4c38-4b1e-9889-f2dd45fd25f2", "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": "2dfb1cd2-076f-4bd0-8a8d-3cee9dd264e5", "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": "4eb2a28c-af5c-47d8-97b8-30813bba1b45", "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": "2185cc31-71d3-4e87-8c12-8ee66d2514dd", "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": "0b98d2c9-9986-4bfe-b82c-0dbcd23b6516", "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": "5bc84265-2ad2-43b9-a152-c2c4dd3ba000", "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": "e6ce4996-8617-49f4-8e4c-ba291dbcecbd", "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": "883a54a5-2ebd-405b-a5f8-fac91f0d03bf", "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": "697033ad-8e17-48b0-a63d-82629202dbb9", "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": "a19a94e7-782a-4513-bffb-6cca52830718", "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": "163f43e0-539b-4120-a7df-2d476d504d19", "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": "888a08b3-2a5b-4383-8342-bd39b93d7d35", "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": "5e4290bd-35fe-44b5-9fbe-cdefd966c2dc", "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": "272fcc44-8f5f-4f65-ace0-6a38da04b995", "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": "7813bc82-08c7-408f-b3ca-7fdc9e7096d3", "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": "7d4a5c36-e99d-4c6e-82ba-24199a021016", "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": "c62ab712-47fd-4814-b27c-3e7086e48916", "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": "180c9c0c-a240-42ee-8f53-e9606c6fe754", "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": "3d6025de-5652-4f09-b235-b3fd4fbb1581", "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": "59ef8279-eb42-4ba1-8c9b-d46329b0f162", "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": "d2fe0abd-52d9-4535-9c80-23a857039dbd", "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": "5be690d0-3d56-459c-9eb9-218a0b561c2d", "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": "76111791-545f-4ad6-861e-3ea8cfda4dda", "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": "b80bfb27-9ef6-481b-8b4f-2a36b8b48d25", "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": "1ddfca1d-ef09-4ff2-882f-3b19b6f33916", "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": "72cc93ab-4529-4208-ba38-3ec356e89cbf", "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": "aa637837-162f-4ecf-88fc-09d28d220e5b", "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": "955fac84-a180-4f34-aa30-e88afc91ed58", "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": "787babde-202f-425d-a9e5-c2e0475300b5", "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": "17e5def9-cde1-45c1-9d92-fa4037b87676", "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": "90f350fa-a0bb-4bfb-a91a-aa16d41deca1", "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": "d8895a40-0647-4d14-8c7d-f26619b27aee", "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": "6015c7da-6f5e-4769-a2d1-0aae65385dc7", "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": "31da1270-2c57-4f79-a5be-1261f09183f5", "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": "044dac9f-427c-49d1-b8a8-cf683a499500", "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": "3915ed98-3e8b-40f3-818c-f88cc4f1885d", "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": "eefc5951-abac-432f-883f-28042f63928f", "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": "e2f334ce-b807-4e31-975b-6a2773b2fa66", "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": "5480c5b8-fbd8-488b-87d0-563f9dfe08f0", "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": "Filter by contact type (This can only be one of client,contractor,staff,other)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "other" }, { "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": "false" }, { "description": { "content": "Filter by login access (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "false" }, { "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": "f371b9ad-88b8-49d5-99ea-875ef9b89ddc", "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": "Filter by contact type (This can only be one of client,contractor,staff,other)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "other" }, { "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": "false" }, { "description": { "content": "Filter by login access (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "false" }, { "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": "6e1c2a9d-04fe-4cb7-a081-7958cd210c2f", "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": "Filter by contact type (This can only be one of client,contractor,staff,other)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "other" }, { "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": "false" }, { "description": { "content": "Filter by login access (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "false" }, { "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": "253777d5-90e2-43fe-b675-ae1c6ce5aedf", "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": "Filter by contact type (This can only be one of client,contractor,staff,other)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "other" }, { "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": "false" }, { "description": { "content": "Filter by login access (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "false" }, { "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": "79f9453f-f116-49aa-894a-6890663e2405", "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": "Filter by contact type (This can only be one of client,contractor,staff,other)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "other" }, { "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": "false" }, { "description": { "content": "Filter by login access (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "false" }, { "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": "76668df4-017c-427c-b7d5-4e1055808002", "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": "Filter by contact type (This can only be one of client,contractor,staff,other)", "type": "text/plain" }, "disabled": true, "key": "type", "value": "other" }, { "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": "false" }, { "description": { "content": "Filter by login access (This can only be one of true,false)", "type": "text/plain" }, "disabled": true, "key": "allowlogin", "value": "false" }, { "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": "5cacbc48-73e9-4082-9acd-29471db567dd", "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": "5a5d13e8-16ca-4c53-aa99-9ab89db4a183", "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": "24e9096f-f687-4649-a63e-cf2e655ad529", "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": "2da70896-4535-4f0d-8914-c5f6580bf386", "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": "9baa9088-dc6b-44e9-85e2-35e1ab0d76e1", "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": "c03f86cc-386d-44aa-ab33-8154ece9297f", "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": "3a837630-ef6e-46ec-9e9a-d79134c02072", "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": "badd6092-07cf-44e7-af7c-aaf8442a45d1", "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": "57744dae-7b05-4254-915b-36f0a537634d", "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": "edffd208-e61e-4fe0-bfa5-5ae8b2fd22d8", "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": "71485b8f-f264-4e67-ac11-895772742c6e", "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": "c0e7e349-b5b9-473b-be7b-073861ab2dc5", "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": "ae4679b4-383c-4fff-ae99-3a58722ee050", "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": "all" }, { "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 \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\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 \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"itemname\": \"\u003cstring\u003e\",\n \"link\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"pastedimage\": \"\u003cboolean\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\u003e\",\n \"size\": \"\u003cinteger\u003e\"\n },\n {\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\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 \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"itemname\": \"\u003cstring\u003e\",\n \"link\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"pastedimage\": \"\u003cboolean\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\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": "04652373-52d3-418e-8f0a-d2f338f5701c", "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": "all" }, { "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": "7d68f861-f599-483c-a365-d3f2f7ca72c7", "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": "all" }, { "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": "94796a65-bd62-4baa-948c-609a181464b3", "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": "all" }, { "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": "6b3bd7ab-cc61-4b1b-9d58-2a11175af5d0", "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": "all" }, { "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": "e2e97204-417a-4eef-b92c-40bace01f575", "name": "/files", "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 Files by ID in a single request. Files that don't exist, are already deleted, or aren't visible to the caller are silently skipped rather than causing an error.", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "name": "/files", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files" ], "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": "d3174edc-b3d2-436f-8c5d-59cd5991b8dc", "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": [ "files" ], "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": "53c756c2-5488-4467-8e29-5b92c0a347b6", "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": [ "files" ], "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": "6f496e15-fa80-4518-a949-9662a8e3d227", "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": [ "files" ], "query": [], "variable": [] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "8bf866c1-ac1a-46ad-a0be-3f7f9693304a", "name": "/files/download", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Downloads multiple files as a single ZIP archive. Files not found on disk are silently skipped. Returns 404 if none of the requested files can be found.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/zip" } ], "method": "GET", "name": "/files/download", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", "download" ], "query": [ { "description": { "content": "(Required) Comma-separated list of File IDs", "type": "text/plain" }, "disabled": true, "key": "fileids", "value": "\u003cstring\u003e" } ], "variable": [] } }, "response": [ { "_postman_previewlanguage": "text", "body": "\u003cbinary\u003e", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/zip" } ], "id": "d85e4970-6d8a-4c99-9ff7-467dc8195ac5", "name": "ZIP archive containing the requested files", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/zip" }, { "description": { "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", "download" ], "query": [ { "description": { "content": "(Required) Comma-separated list of File IDs", "type": "text/plain" }, "disabled": true, "key": "fileids", "value": "\u003cstring\u003e" } ], "variable": [] } }, "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/zip" } ], "id": "4ac58913-4080-40a6-8576-a93c1bda9432", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/zip" }, { "description": { "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", "download" ], "query": [ { "description": { "content": "(Required) Comma-separated list of File IDs", "type": "text/plain" }, "disabled": true, "key": "fileids", "value": "\u003cstring\u003e" } ], "variable": [] } }, "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/zip" } ], "id": "0b79d900-8c91-4f59-b026-47984e31a1b8", "name": "Unauthorized", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/zip" }, { "description": { "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", "download" ], "query": [ { "description": { "content": "(Required) Comma-separated list of File IDs", "type": "text/plain" }, "disabled": true, "key": "fileids", "value": "\u003cstring\u003e" } ], "variable": [] } }, "status": "Unauthorized" }, { "_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/zip" } ], "id": "94159d9b-1385-4c59-885b-1978765ee4bd", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/zip" }, { "description": { "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", "download" ], "query": [ { "description": { "content": "(Required) Comma-separated list of File IDs", "type": "text/plain" }, "disabled": true, "key": "fileids", "value": "\u003cstring\u003e" } ], "variable": [] } }, "status": "Not Found" } ] }, { "event": [], "id": "57964bc6-24c8-4e91-988f-91ef68d58369", "name": "/files/move", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"folderid\": \"\u003cinteger\u003e\",\n \"ids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n}" }, "description": { "content": "Moves one or more Files into a different root, custom, or item folder. The destination folder must belong to the same parent entity (Job, Quote, Invoice, ItemCollectionTemplate, Contact, Company, Product, QuoteSetting, or InvoiceSetting) as the files being moved — cross-entity moves are rejected per-file and reported in skippedids rather than failing the whole request. Files already in the destination folder are also reported as skipped (no-op).", "type": "text/plain" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "name": "/files/move", "url": { "host": [ "{{baseUrl}}" ], "path": [ "files", "move" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"movedids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"skippedids\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ]\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "e4169788-4a2a-46fa-9a70-1267a6bbd7c0", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"folderid\": \"\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": [ "files", "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": "52a42577-2c3f-4cae-89f4-d702c3232d76", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"folderid\": \"\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": [ "files", "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": 404, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9193ec97-77c7-4e52-afc0-be3674bd6f28", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"folderid\": \"\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": [ "files", "move" ], "query": [], "variable": [] } }, "status": "Not Found" } ] }, { "event": [], "id": "870ed9eb-b705-4964-802b-c056dc440cc0", "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 \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\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 \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"itemname\": \"\u003cstring\u003e\",\n \"link\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"pastedimage\": \"\u003cboolean\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\u003e\",\n \"size\": \"\u003cinteger\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "a9bd2fe1-01d1-4df4-99e1-2e493bc5acdc", "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": "f5e8b3dd-03e3-4a05-9f1f-0942e6192ac5", "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": "f01d53f4-2657-4374-b743-58f4a7fabc81", "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": "99b70dbd-c365-49b1-896d-05d87aade540", "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": "b269127b-b27a-4551-a718-c6778b7ae07f", "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": "3993df37-410a-487f-9421-5c7ebb5bb7b0", "name": "/files/:fileid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Soft-delete a File by ID. Removes the on-disk copy, recomputes the owning folder's size, unlinks the file from any Job message that references it, and syncs the deletion to connected clients. Works across all entity types (Job, Quote, Invoice, ItemCollectionTemplate, Contact, Company, Product, QuoteSetting, InvoiceSetting).", "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": "12934baf-d6e7-4f41-bf6d-adefe418c8d8", "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": "784c7898-5f7d-4db1-b200-f38aa6a60c5b", "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": "6bfb3c42-77b5-4a36-b21c-84b9ddfc0c11", "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": "ab16e28c-6e1b-4d28-af75-182d20a4145d", "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": "a1c60ce4-d551-4eb9-857c-02fe560fa7c3", "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": "0ecdef76-0a63-4f4f-a492-2d5e59c0c30f", "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": "0c7e8b92-f148-43ef-ba72-2ef96b13ae24", "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": "97a3f300-847e-46cb-a80d-a4f78b71f7ea", "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": "d10e95a4-a729-47cc-8fb2-727c5f20afb2", "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": "dc9d7690-327f-4786-82fb-561fcbce6ffe", "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": "4700fdd9-f10e-4e3e-b522-be205daaba2a", "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" } ] }, { "event": [], "id": "b5f7b2f9-eec7-4178-9c64-017b1b74a3ef", "name": "/:accountname/api/v4/files/public/:fileid/:token", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Downloads a file using its account name, File ID, and secret uniquetoken — no session/API authentication required. Intended for public-facing use (e.g. rendering images in shared/public views). The uniquetoken acts as an unguessable capability; anyone with the URL can download the file, so treat it as secret. Returns 404 for any mismatch (wrong token, wrong file, deleted file) without distinguishing the reason.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/octet-stream" } ], "method": "GET", "name": "/:accountname/api/v4/files/public/:fileid/:token", "url": { "host": [ "{{baseUrl}}" ], "path": [ ":accountname", "api", "v4", "files", "public", ":fileid", ":token" ], "query": [], "variable": [ { "description": { "content": "(Required) Account folder name", "type": "text/plain" }, "disabled": false, "key": "accountname", "type": "any", "value": "\u003cstring\u003e" }, { "description": { "content": "(Required) File ID", "type": "text/plain" }, "disabled": false, "key": "fileid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) File's uniquetoken", "type": "text/plain" }, "disabled": false, "key": "token", "type": "any", "value": "\u003cstring\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "text", "body": "\u003cbinary\u003e", "code": 200, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/octet-stream" } ], "id": "c48e3270-8a70-427f-af92-34e940077864", "name": "File content", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/octet-stream" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ ":accountname", "api", "v4", "files", "public", ":fileid", ":token" ], "query": [], "variable": [ { "description": { "content": "(Required) Account folder name", "type": "text/plain" }, "disabled": false, "key": "accountname", "type": "any", "value": "\u003cstring\u003e" }, { "description": { "content": "(Required) File ID", "type": "text/plain" }, "disabled": false, "key": "fileid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) File's uniquetoken", "type": "text/plain" }, "disabled": false, "key": "token", "type": "any", "value": "\u003cstring\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": "7bc5100c-7449-4707-b229-59ce64b05d9c", "name": "Bad Request", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/octet-stream" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ ":accountname", "api", "v4", "files", "public", ":fileid", ":token" ], "query": [], "variable": [ { "description": { "content": "(Required) Account folder name", "type": "text/plain" }, "disabled": false, "key": "accountname", "type": "any", "value": "\u003cstring\u003e" }, { "description": { "content": "(Required) File ID", "type": "text/plain" }, "disabled": false, "key": "fileid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) File's uniquetoken", "type": "text/plain" }, "disabled": false, "key": "token", "type": "any", "value": "\u003cstring\u003e" } ] } }, "status": "Bad Request" }, { "_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": "36379ee4-67e7-4eec-a05f-23a93d227800", "name": "Not Found", "originalRequest": { "body": {}, "header": [ { "key": "Accept", "value": "application/octet-stream" } ], "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ ":accountname", "api", "v4", "files", "public", ":fileid", ":token" ], "query": [], "variable": [ { "description": { "content": "(Required) Account folder name", "type": "text/plain" }, "disabled": false, "key": "accountname", "type": "any", "value": "\u003cstring\u003e" }, { "description": { "content": "(Required) File ID", "type": "text/plain" }, "disabled": false, "key": "fileid", "type": "any", "value": "\u003cinteger\u003e" }, { "description": { "content": "(Required) File's uniquetoken", "type": "text/plain" }, "disabled": false, "key": "token", "type": "any", "value": "\u003cstring\u003e" } ] } }, "status": "Not Found" } ] } ], "name": "files" }, { "description": "", "item": [ { "event": [], "id": "94fbdf07-c8f9-44a5-a99f-02cbeb3500fb", "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 \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"contacts\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"contacts\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\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": "e0ad7fdf-18e2-4522-9207-3f5a76f4c3f1", "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": "665236d2-8802-44bc-bfa4-525b303c4c1a", "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": "ae3105d1-b81b-4153-8bb1-8a762e7680e3", "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": "883b49f8-fd77-42cf-9410-52a22d0e9c15", "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": "4b5c4a09-b1a4-429a-bd24-ff0c65b7759e", "name": "/files/folders", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\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": "474d4213-69d5-4a49-a9dd-17f81a122417", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\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": "5edcd5a3-c459-4b3a-af5a-40295e67a30a", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\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": "c441d9a7-61fc-4b80-bb4b-27b1b4681bb1", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\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": "da9ae13d-de41-47b0-8a1e-374473376a91", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\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": "54eaf8d6-c743-44db-bdb5-08e7889418aa", "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 \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"contacts\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\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": "8bbec6c7-3d99-4490-a005-0889fce1b6f4", "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": "bd40adca-48cc-4ccf-9d68-7e4f1947f78c", "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": "3b526e96-2b57-4519-80e2-41de39464604", "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": "031d6f39-1452-4a91-9067-c5b8f5412354", "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": "a24fb4c8-b204-4cda-906b-5b7458c5f753", "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": "913f13a4-f188-4e3d-87ec-02cc96a9500b", "name": "/files/folders/:folderid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\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": "433e0d30-a47b-496c-903f-6e7e4a82fe4c", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\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": "fce5e6a7-6f77-482f-82ba-13abaaa0f9d0", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\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": "921151b2-8b68-40ca-b00a-3492f764cdeb", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\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": "56d3761c-0c02-4d13-b8cc-8bd0d3b84a12", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\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": "9ac374e2-a3a2-4d92-abed-ec6df2d41589", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"description\": \"\u003cstring\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\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": "973184d8-4955-4fb4-9935-48127b84d9bc", "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": "2552239b-4915-4d2c-b7d0-58284d9cee25", "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": "cf0a838b-4510-44d8-a44b-4995cd72ac96", "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": "ee46f937-29bc-4354-ab7a-fb81a6d676e7", "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": "55d6c8ac-d060-48a2-a6e3-13cb34423d6c", "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": "e93983b6-d46b-4740-af38-96aee3e0fba5", "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": "25ec53d4-e9ae-43f9-b33c-76c0a230331f", "name": "/files/folders/:folderid/files", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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 \"pastedimage\": \"\u003cboolean\u003e\",\n \"uniquetoken\": \"\u003cstring\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "671ce9d5-601f-4b86-98ee-df449794be04", "name": "Created", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": "13841b5e-71d2-429d-858f-35128eef7c6c", "name": "Bad Request", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": "841ed5b5-0f7b-4232-b570-43fc18f23ab3", "name": "Unauthorized", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": "60524922-d472-482d-8011-1d02075cafb7", "name": "Forbidden", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": "9fb5e1c2-5e92-439f-834d-613129dec154", "name": "Not Found", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": "e27bd67a-291e-4596-823c-9e7632040141", "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": "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": "title" }, { "description": { "content": "Maximum results when using fuzzy search (q). Default 10, max 100", "type": "text/plain" }, "disabled": true, "key": "qlimit", "value": "10" }, { "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": "all" }, { "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": "all" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "true" }, { "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": "active" }, { "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": "week" }, { "description": { "content": "Date field for subtotals grouping (This can only be one of invoiced,due,paid)", "type": "text/plain" }, "disabled": true, "key": "subtotalsdateoption", "value": "due" }, { "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). When q is present, this is always forced to 1.", "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": "77269523-ebeb-4331-bf3f-9876139849d5", "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": "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": "title" }, { "description": { "content": "Maximum results when using fuzzy search (q). Default 10, max 100", "type": "text/plain" }, "disabled": true, "key": "qlimit", "value": "10" }, { "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": "all" }, { "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": "all" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "true" }, { "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": "active" }, { "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": "week" }, { "description": { "content": "Date field for subtotals grouping (This can only be one of invoiced,due,paid)", "type": "text/plain" }, "disabled": true, "key": "subtotalsdateoption", "value": "due" }, { "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). When q is present, this is always forced to 1.", "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": "448b806a-f267-4a7a-a9d8-8aacacc7110b", "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": "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": "title" }, { "description": { "content": "Maximum results when using fuzzy search (q). Default 10, max 100", "type": "text/plain" }, "disabled": true, "key": "qlimit", "value": "10" }, { "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": "all" }, { "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": "all" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "true" }, { "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": "active" }, { "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": "week" }, { "description": { "content": "Date field for subtotals grouping (This can only be one of invoiced,due,paid)", "type": "text/plain" }, "disabled": true, "key": "subtotalsdateoption", "value": "due" }, { "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). When q is present, this is always forced to 1.", "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": "1efc4d88-b3b2-4020-86ab-560502b0f3d0", "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": "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": "title" }, { "description": { "content": "Maximum results when using fuzzy search (q). Default 10, max 100", "type": "text/plain" }, "disabled": true, "key": "qlimit", "value": "10" }, { "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": "all" }, { "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": "all" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "true" }, { "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": "active" }, { "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": "week" }, { "description": { "content": "Date field for subtotals grouping (This can only be one of invoiced,due,paid)", "type": "text/plain" }, "disabled": true, "key": "subtotalsdateoption", "value": "due" }, { "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). When q is present, this is always forced to 1.", "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": "7e05112d-f66a-453a-a068-e0138b332ca0", "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": "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": "title" }, { "description": { "content": "Maximum results when using fuzzy search (q). Default 10, max 100", "type": "text/plain" }, "disabled": true, "key": "qlimit", "value": "10" }, { "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": "all" }, { "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": "all" }, { "description": { "content": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "true" }, { "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": "active" }, { "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": "week" }, { "description": { "content": "Date field for subtotals grouping (This can only be one of invoiced,due,paid)", "type": "text/plain" }, "disabled": true, "key": "subtotalsdateoption", "value": "due" }, { "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). When q is present, this is always forced to 1.", "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": "7b5a8263-33c5-4766-bfcd-2e1c310c7c08", "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": "47426059-d705-41ec-b00d-91ee4ef04acd", "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": "3ee9e157-2329-460e-b140-507ad6bc832e", "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": "c85bd258-cf6c-4f54-9069-107cbd290a17", "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": "4fb7fe3a-fe91-42dc-9c98-76ff577b9df6", "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": "be3598e9-2606-4676-83d1-843434d2d8dc", "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": "909f4eff-9b0a-4eda-beea-30b6a837666d", "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": "9281c4b8-c2e6-4d33-ba08-d3c69a03cad7", "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": "05d94212-a11f-42b2-9c90-813b37598d38", "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": "5d9087ca-d374-447c-a627-1e55f748bb8e", "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": "0964f063-6869-4603-8c8b-323071d6630c", "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": "283086ef-e4df-4007-aa82-d18a63ca68e8", "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": "c266c296-f82e-412c-a9b9-d99af0a57a0c", "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": "44f40870-3896-4581-8b40-01e478fb6abc", "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": "12cbd0f5-0e55-4723-8ca0-da3c4bdb52fa", "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": "2284ac39-8bbb-4e55-b1ef-74523a9ebda3", "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": "6afe9a4a-9c13-4674-8c74-7ea5d385e75f", "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": "1da76a35-b2f3-4ba9-8fa8-a665490d7584", "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": "d8d084ef-b8c5-4e9b-a6fb-5104fc49ff3e", "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": "ff6fcafc-8f6a-45dc-850e-506c2d733342", "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": "c90d1d4c-c1f6-4735-8b73-8786611576da", "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": "65e57d98-5609-4599-ba71-3e2c6935abd1", "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": "20a5c292-0eca-4ddd-b2c6-3f2454a0f5c5", "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": "c6af06b3-acc1-4440-8baf-55e730ccf597", "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": "6ef1fced-b716-46e8-b921-b27e4222d4ca", "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": "1847e14a-388f-46f5-975d-dbb073b6e23e", "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": "baa441d1-c2d9-4428-9aef-3b37fb2595d4", "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": "9fde1ade-9ac0-427d-ba38-306b868f2150", "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": "4bf85261-f7a0-42bd-8f71-afb5708b6f56", "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": "755957a5-6565-4d7e-aafc-a2e85a6311c5", "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": "65851fa9-7eda-4d2a-8453-8832a59d3e3f", "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": "60436c38-db02-441b-b313-8acacf2a9f57", "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": "d93c1ef3-7df8-4e15-86c2-0e8e3e171253", "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": "be6eb541-1554-4d47-b601-6e12829e9b68", "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": "56b56f9f-e686-47a4-83ae-50f4eaf07acf", "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": "88bbfe6f-b045-404d-bea3-44f8468d8fa8", "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": "88cf8295-51da-43d2-b7ad-53dad3754c2d", "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": "22cb290b-eab4-4149-aa77-30e74353b3e4", "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": "1bdf1f5c-f1e1-478b-81bc-40d78eb9d4f4", "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": "803bf757-46f2-406a-8ced-0889a0c84fbf", "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": "2c511807-5909-44d7-979f-4aaa1e5248c7", "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": "abe75b1d-2479-40b0-ae9d-1b25ca0c938f", "name": "/invoices/items/:itemid/files", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "mode": "formdata" }, "description": { "content": "Upload a file to an Invoice Item (item folder). Send a multipart/form-data request with the file in the \"file\" field. 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": "/invoices/items/:itemid/files", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", "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 \"pastedimage\": \"\u003cboolean\u003e\",\n \"uniquetoken\": \"\u003cstring\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "232b41db-4838-43d5-a11a-f58801c7beb0", "name": "Created", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "invoices", "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": "096ccedc-a566-4496-bbf2-d6ef62f465e3", "name": "Bad Request", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "invoices", "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": "f0dcec68-9ee3-437b-9503-ce15b505a995", "name": "Unauthorized", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "invoices", "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": "6929aadc-146a-47a4-80ac-f6e2157c9272", "name": "Forbidden", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "invoices", "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": "00a59c7f-e198-4de7-8309-c5ff0b7a7f39", "name": "Not Found", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "invoices", "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": "1e52cec0-d4af-4777-b2fc-394894edc6fb", "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": "03202d9d-909e-42ad-aaa9-a93a4348aaad", "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": "04c6db13-fb8d-4f7d-82de-7e474baf8f32", "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": "418e8f70-0b73-404c-930a-179c9c48fcb2", "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": "eb584b2c-5635-4b3d-abf6-8fdda014bdd5", "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": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "true" }, { "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": "active" }, { "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": "92194862-b7bd-4909-9adc-4f9250f94218", "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": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "true" }, { "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": "active" }, { "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": "6db61918-74e2-4758-8294-aeacbd5e9fa1", "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": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "true" }, { "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": "active" }, { "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": "72a46a29-0810-46c2-bdf7-e857874785a3", "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": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "true" }, { "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": "active" }, { "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": "dc7cb063-0b6f-46d8-9b75-73ab6e9e9571", "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": "Filter by taxable status (This can only be one of true,false,all)", "type": "text/plain" }, "disabled": true, "key": "taxable", "value": "true" }, { "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": "active" }, { "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": "62b4e8f6-b32b-4603-b15a-efa7e1765d1f", "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": "840d67c4-e65e-4b43-bf12-222a2ae992a5", "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": "489c3302-adcd-42e6-ab7c-32bcd427232d", "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": "620c9332-fd7b-4107-845d-6c66e90eba10", "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": "6a19a3cb-ac6a-445e-b9d9-4539e6a24e91", "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": "e6abdfb8-9257-4c6e-8015-dd390b400ef4", "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": "ef877714-03a3-488b-9e69-d52db5aa1077", "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": "fa99124a-1184-48df-aefc-86c2030e0f40", "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": "af13fb1f-a598-4c41-966a-bfb60d73c625", "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": "bdbbdf6f-0c7c-40af-ac67-212b9f868268", "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": "710fb62c-6a35-4441-8f13-c0d23446e224", "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": "05209179-578d-426c-bde4-78ba201ed5d9", "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": "2c9a033e-6923-43ce-9db9-273a0f2a4f58", "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": "341b6b9d-e843-49f1-b749-40cd63cd7090", "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": "01d2f1ae-8e31-4c7f-b7df-eeb80d02b10c", "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": "2841690c-3060-416b-8bf9-352373be982d", "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": "e0786d2d-a2f6-491c-8fa9-baaa4995ca75", "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": "ba8c8d16-d0c9-427d-ac50-8e64d1d80836", "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": "154f07c7-f89b-4c4e-b778-233390d49200", "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": "38b83d95-aaf3-45be-a39d-5bfffd98f4c3", "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": "14ee077c-b41f-402b-879f-a7e0efa89243", "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": "20bc3bd6-72c9-4ec2-a0b6-ea37170bb00d", "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": "e841010e-7fa6-4d8e-8067-40f92ebf8343", "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": "70d2401c-37fd-4231-a87a-a42791ac8704", "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": "5c1a8b1a-99fa-47f6-8033-e60f0b861972", "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": "b48ed60a-fe7e-4cd0-a8f3-ad05891711db", "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": "7e50b54b-c16e-4bfb-ab70-8cb3b55d1e9d", "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": "fc9291b5-9b2e-4f2c-bdb0-9db5eadd6ccd", "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": "061d0287-e749-46e1-90b4-d080fde961cc", "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": "4674b9bc-aec8-4b25-902d-773fc06d1ef6", "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": "2a5567bb-3603-4c9b-960f-b0c7d19aff3b", "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": "8c515b8d-a41a-48f3-a5fd-4859feec940a", "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": "5aa857aa-17c3-4826-a3bb-98daebe5557d", "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": "d4112008-9e10-498f-a038-795abc25add4", "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": "9087a2b2-f5a1-4252-a60f-2662b750b400", "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": "92809b0c-ddd0-4c38-9980-d5b84cf249c0", "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": "e4d425d2-f6de-4a19-82b9-7cb8beb67b23", "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": "4b242741-563f-439a-9f42-192589fe4546", "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": "76e00dd3-8a99-4f65-a70c-f80f446710bf", "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": "83800615-3042-44b1-bb34-ac19b8c1d3db", "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": "00b70f82-97b2-450e-8103-de37a9497925", "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": "916a3cb5-43bb-4609-84e1-627f345ea259", "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": "689a1ea1-d8be-4b63-9423-209362b06aba", "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\": \"submitted\",\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": "91e7937c-1fb7-42b1-bf4a-a12d818858e1", "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\": \"submitted\",\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": "4e07d2a2-a618-4ad6-9894-b3a26155e6b6", "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\": \"submitted\",\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": "07fe8c3b-388d-48fc-96fd-35e960ba95c6", "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\": \"submitted\",\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": "9b2ad3d9-70f4-4064-b465-0e0de5abef75", "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\": \"submitted\",\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": "5adec227-254d-48e3-a14d-d35418968caf", "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\": \"submitted\",\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": "b1e00797-0d66-4255-8a10-c6d04674baf3", "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": "94aefdc4-42ce-4d88-8069-69823309bfae", "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": "43e79c79-4e7f-42b1-8107-5c77390825d1", "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": "5fe08981-691d-4570-91af-5faa250a1830", "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": "05388864-c762-4d85-a38e-25bb5e86baab", "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": "a3ab5148-fbb6-4ddf-a669-77794ae3c671", "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": "45da8049-a32d-4c20-ac35-9e933a1a88ed", "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": "e88c49f6-dac7-4368-9933-79c83ccb3f1b", "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": "496fafd3-ff6c-40be-9efc-2550323fbd3f", "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": "25bd70ab-61c6-48bc-a4b1-585368ba7be1", "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": "f6687074-fb13-4803-8050-65dd407f048c", "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": "9aee1e98-adf1-4353-9b48-f0996d2e66fc", "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": "371a9f64-4ae3-4c50-a5fd-a84f32cd3964", "name": "/invoices/:invoiceid/files", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Files for an Invoice 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": "/invoices/:invoiceid/files", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "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": "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) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\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 \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"itemname\": \"\u003cstring\u003e\",\n \"link\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"pastedimage\": \"\u003cboolean\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\u003e\",\n \"size\": \"\u003cinteger\u003e\"\n },\n {\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\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 \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"itemname\": \"\u003cstring\u003e\",\n \"link\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"pastedimage\": \"\u003cboolean\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\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": "c25ca9c5-4d65-4c98-846d-32e8c6e66039", "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", "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": "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) 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": "2e8ac3ac-2c72-4dba-9384-8d1b1c0a3bb5", "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", "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": "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) 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": "14176055-d1be-46e2-af75-ad8de2eb1c61", "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", "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": "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) 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": "2b9aabb1-61b3-43af-b855-987fc0e95c33", "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", "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": "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) 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": "0926cc76-120b-4b0d-9976-8462f17d66ff", "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", "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": "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) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "891fb28e-09e0-4444-9c81-d231707c5866", "name": "/invoices/:invoiceid/files", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "mode": "formdata" }, "description": { "content": "Upload a file to an Invoice's root folder. Send a multipart/form-data request with the file in the \"file\" field. To upload to an item folder use POST /invoices/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": "/invoices/:invoiceid/files", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "files" ], "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 \"fileid\": \"\u003cinteger\u003e\",\n \"filesize\": \"\u003cinteger\u003e\",\n \"folderid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"pastedimage\": \"\u003cboolean\u003e\",\n \"uniquetoken\": \"\u003cstring\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "1270ddb1-2cdd-452d-8202-e34e7b8a2765", "name": "Created", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "invoices", ":invoiceid", "files" ], "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": "a1153460-2102-4c9a-9e73-661b07ce364c", "name": "Bad Request", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "invoices", ":invoiceid", "files" ], "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": "26a03f0a-01de-49e0-b649-1447a2b05e36", "name": "Unauthorized", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "invoices", ":invoiceid", "files" ], "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": "db07faf4-e3ef-4558-b573-8bfcfaed48c8", "name": "Forbidden", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "invoices", ":invoiceid", "files" ], "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": "5c8d6536-6f9c-4c4a-9dd2-5780910fdacf", "name": "Not Found", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "invoices", ":invoiceid", "files" ], "query": [], "variable": [ { "description": { "content": "(Required) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "06487d71-43ed-446e-a021-728f65c33f08", "name": "/invoices/:invoiceid/folders", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of custom Folders for an Invoice based on the specified filters.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/invoices/:invoiceid/folders", "url": { "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":invoiceid", "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) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"contacts\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"contacts\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\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": "8b37f0a4-ba3f-409f-a010-fcfc929ee54d", "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", "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) 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": "bedfd50d-b70f-4609-87d3-94e6f649c0d1", "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", "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) 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": "1fc21b5c-f725-4115-b3e7-e44a6a3d044b", "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", "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) 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": "3e8403f1-14d3-4ebb-9737-2bc367cd17e2", "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", "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) 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": "78895558-f598-497a-9735-3d5a87af7b82", "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", "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) Invoice ID", "type": "text/plain" }, "disabled": false, "key": "invoiceid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "fdb76165-dd1e-4410-ac2a-f8b0d5cf0486", "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": "f9037bd1-a5ef-422f-ba27-2b172752499c", "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": "cd777170-8bcb-4ff1-becc-90401bad2267", "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": "3810e1e8-f9f9-40fc-8bc8-1b7808caf8cd", "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": "feaa0c65-2ced-4465-af90-1938a5e81d26", "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": "ecc3a244-17cf-46dc-8e4e-f5d1e3a78bfa", "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": "d6b1d534-40a2-4687-b01b-44c00fef0a6a", "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": "5549cf4e-1e82-4a2a-8374-01e182be17a1", "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": "3f49f09f-fadf-41d5-b333-789a0bfc4d3a", "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": "eaee1812-be90-4922-99f9-6152d54a1f87", "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": "2fd426b1-f4d5-4d2e-8e61-db0c2ccf4439", "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": "700a8fc9-8f8f-4427-ba93-ffb45ea60b41", "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": "c0e6e69f-6869-4e8d-a813-2026a216a027", "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": "a26fcd2e-69ec-4424-8230-523d881c9809", "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": "c3cb36b4-0e8a-4818-a578-c2c3604d252e", "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": "6e80c543-a444-467c-97f7-3a844e49c85f", "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": "a3b65cd4-3686-4761-ae22-1d2616658d41", "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": "9063ca6f-9365-41a2-953a-229e91398733", "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": "bfa62b1d-fb0a-45f4-8e4a-74df606de4f2", "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": "27e53ab5-8999-4b74-a0d3-2fc31d375414", "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": "43beefa6-90db-4468-b01b-486edf4e1c5d", "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": "347446d3-aef4-4e16-b94e-a3b1ce9c14f1", "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": "6076d738-de51-46dc-a5f6-e8ae34531994", "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": "89b76a4e-29e9-4d45-b931-a159c7556be4", "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": "c452b2c9-7c49-4c1e-bdaa-97a0933ecc5d", "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": "75e94155-fb0e-43e2-9f38-f95fd93be56f", "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": "098c0d11-742d-4cf8-a170-62e9c11323c2", "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": "d6759e02-bf42-4796-82ec-db7a7907616b", "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": "3908bcfa-5e29-4281-a698-accc50caac1e", "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": "4d1f91d8-4f52-4f91-a727-e6880df8d477", "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": "a1d5c831-ab8e-4895-9992-ed1bce604c60", "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": "304f98a5-d17c-4d43-85d7-4a0b40855c22", "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": "a6adbfcf-bce1-4b19-a241-f6214eb621fd", "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": "742215e5-15c8-4d2b-a9f2-859fb5873c90", "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": "669a2975-3f6a-44df-ad3d-2c85d1849bb1", "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": "c7f3ba48-b77e-4d6a-b50b-b34df98691a3", "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": "a193cf59-18d5-4797-b164-08eb4b32d801", "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": "00306bab-c809-4bfd-8d6e-e7e46e7e8933", "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": "f894953f-0d97-46de-9b4e-fe4998baeca1", "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": "4ab096a1-8ce8-47c2-b9e1-13487959d9eb", "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": "d5782c91-f7eb-4f89-b9ae-59f8d3ed6817", "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": "136f73a1-74be-4509-ba5c-9487f32448f4", "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": "0b668e73-d7ba-472c-a2bd-fb50fa92cefd", "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": "84e319c6-57f5-4e67-b866-bf2445aa20cd", "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": "2c13a8a5-44f7-4393-8824-a7da91411e6f", "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": "e3389694-cb6d-4468-b801-7f7653793947", "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": "5f9e977e-0294-41cc-a0ce-f255f7a314e1", "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": "da4e7e1c-3ec2-4cd9-ab82-2b99db6e5e08", "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": "d9689607-a752-4c64-a73a-99cdca172341", "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": "c600b1c0-8db8-42d1-a837-b6e4d98dc240", "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": "a2b1708a-8b75-46c4-af9d-9cffa4032129", "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": "29e75d2a-b1c2-4b74-886d-8b154e4bbcc8", "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": "ff9435a0-c293-4f2c-8bc6-641fd6ae3e56", "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": "805d8d67-7546-4e2a-b349-794c5ba4e602", "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": "db807c9f-973d-4494-a9b6-f4a56b48434c", "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": "91ae8fc3-cf0b-4399-adb6-8efd4a0bfe41", "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": "3746e3d0-ce6b-4041-a3e1-9daf59bb08fe", "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": "b7f4d418-f0de-48d9-8701-bc80a165e0be", "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": "b4dfceb5-87e6-49cc-b2bc-ef8bc074edf5", "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": "2fff5788-82f4-44b5-8f88-24bf77e8d7fb", "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": "5a1fa507-ad4c-4d20-8925-391125e8d203", "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": "4e5e0dac-858b-4877-be09-dbfcf0e1f75e", "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": "70a95054-0081-459b-964e-792ad80bac42", "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": "e91e2a72-8e85-418c-9067-43606279f969", "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": "6f8898f8-a97f-45d5-b2ec-7b58736fd58e", "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": "ba348639-ded7-4a65-b285-a7244e9725d6", "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": "6f4e20e7-d1e4-4ff6-89c1-a437448ff991", "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": "b5a045bb-59d8-4d21-b736-f8172a67bbe0", "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": "2b2a90da-2c0f-47f5-98b9-19ff4e4789be", "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": "029441b2-bf56-48cf-a78e-5f4094a3bce9", "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": "ad7072d4-ddb0-47a2-a360-77797268cb0a", "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": "e25190f3-978a-44c9-91e1-b39c47c66063", "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": "fcbced5e-496e-459d-91d9-e245eb69098e", "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": "6582b4ec-4f59-4c87-b120-4c1c197c7cdd", "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": "5f2304ad-449a-4578-b26a-8767d403b2f2", "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": "a9646400-b311-4612-958e-ada8c43b6595", "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": "2d299956-e9e8-4e11-b4b0-382a2fff8e2f", "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": "f3411299-3ed3-4545-8c0d-802de0658fa8", "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": "484b8893-9c63-4bb0-9c36-d20c4a016bc2", "name": "/itemtemplates", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of item templates (reusable sets of phases and items). Use the returned id with POST /projects/{projectid}/itemtemplates, or with the itemtemplate field on project creation. Item templates are distinct from project templates (GET /settings/projects/templates).", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/itemtemplates", "url": { "host": [ "{{baseUrl}}" ], "path": [ "itemtemplates" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,startdate" }, { "description": { "content": "Search by template name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Item Template ID or comma-separated list of IDs", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,startdate,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 \"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 \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estOutTotal\": \"\u003cnumber\u003e\",\n \"estOutTotalTax\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemDueDate\": \"\u003cstring\u003e\",\n \"itemStartDate\": \"\u003cstring\u003e\",\n \"itemsActive\": \"\u003cinteger\u003e\",\n \"itemsCompleted\": \"\u003cinteger\u003e\",\n \"itemsDiscount\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\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 \"deleted\": \"\u003cboolean\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estOutTotal\": \"\u003cnumber\u003e\",\n \"estOutTotalTax\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemDueDate\": \"\u003cstring\u003e\",\n \"itemStartDate\": \"\u003cstring\u003e\",\n \"itemsActive\": \"\u003cinteger\u003e\",\n \"itemsCompleted\": \"\u003cinteger\u003e\",\n \"itemsDiscount\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\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": "8c8d1046-f817-4532-abc0-6dd0f29b719c", "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": [ "itemtemplates" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,startdate" }, { "description": { "content": "Search by template name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Item Template ID or comma-separated list of IDs", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,startdate,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": "a7ac9b6d-04b2-4d96-962a-8e0fa9845bc4", "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": [ "itemtemplates" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,startdate" }, { "description": { "content": "Search by template name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Item Template ID or comma-separated list of IDs", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,startdate,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": "9a94a1af-9429-4581-94ca-1a56308502d5", "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": [ "itemtemplates" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,startdate" }, { "description": { "content": "Search by template name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Item Template ID or comma-separated list of IDs", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,startdate,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": "91677031-87b7-41db-9e0b-aee0dc96b98f", "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": [ "itemtemplates" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "id,name,startdate" }, { "description": { "content": "Search by template name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Item Template ID or comma-separated list of IDs", "type": "text/plain" }, "disabled": true, "key": "id", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field (This can only be one of id,name,startdate,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": "3bfb68ae-f89c-40f3-8720-c130798dad45", "name": "/itemtemplates/:itemtemplateid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns full details of a single item template by ID.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/itemtemplates/:itemtemplateid", "url": { "host": [ "{{baseUrl}}" ], "path": [ "itemtemplates", ":itemtemplateid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item Template ID", "type": "text/plain" }, "disabled": false, "key": "itemtemplateid", "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 \"deleted\": \"\u003cboolean\u003e\",\n \"estGrossMargin\": \"\u003cnumber\u003e\",\n \"estInLabour\": \"\u003cnumber\u003e\",\n \"estInTotal\": \"\u003cnumber\u003e\",\n \"estOutLabour\": \"\u003cnumber\u003e\",\n \"estOutTotal\": \"\u003cnumber\u003e\",\n \"estOutTotalTax\": \"\u003cnumber\u003e\",\n \"estProfit\": \"\u003cnumber\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"inUnitTotal\": \"\u003cnumber\u003e\",\n \"itemDueDate\": \"\u003cstring\u003e\",\n \"itemStartDate\": \"\u003cstring\u003e\",\n \"itemsActive\": \"\u003cinteger\u003e\",\n \"itemsCompleted\": \"\u003cinteger\u003e\",\n \"itemsDiscount\": \"\u003cnumber\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"outUnitTotal\": \"\u003cnumber\u003e\",\n \"projectedProfit\": \"\u003cnumber\u003e\",\n \"sortorder\": \"\u003cstring\u003e\",\n \"startdate\": \"\u003cstring\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": "404722a7-a097-425f-91fe-1a729d085815", "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": [ "itemtemplates", ":itemtemplateid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item Template ID", "type": "text/plain" }, "disabled": false, "key": "itemtemplateid", "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": "0c7b6063-e209-4e7e-8877-4217155c1316", "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": [ "itemtemplates", ":itemtemplateid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item Template ID", "type": "text/plain" }, "disabled": false, "key": "itemtemplateid", "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": "62652df3-6aba-4905-871f-acf49dd0241c", "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": [ "itemtemplates", ":itemtemplateid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item Template ID", "type": "text/plain" }, "disabled": false, "key": "itemtemplateid", "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": "372cbe46-99ad-4608-a3ee-cce895ba0c23", "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": [ "itemtemplates", ":itemtemplateid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item Template ID", "type": "text/plain" }, "disabled": false, "key": "itemtemplateid", "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": "3dd20f62-6fa5-49f0-b5ad-a2970064c6b9", "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": [ "itemtemplates", ":itemtemplateid" ], "query": [], "variable": [ { "description": { "content": "(Required) Item Template ID", "type": "text/plain" }, "disabled": false, "key": "itemtemplateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "88207f2b-fb8e-4e61-ac8a-40ccc23ae3db", "name": "/itemtemplates/:itemtemplateid/items", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns the line items belonging to a single item template.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/itemtemplates/:itemtemplateid/items", "url": { "host": [ "{{baseUrl}}" ], "path": [ "itemtemplates", ":itemtemplateid", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by item name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "\u003cstring\u003e" }, { "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).", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Item Template ID", "type": "text/plain" }, "disabled": false, "key": "itemtemplateid", "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": "5011c3a5-59ff-42be-8652-b8d54d9d6612", "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": [ "itemtemplates", ":itemtemplateid", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by item name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "\u003cstring\u003e" }, { "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).", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Item Template ID", "type": "text/plain" }, "disabled": false, "key": "itemtemplateid", "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": "b5d27941-5012-40dd-b1ea-9df73f993721", "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": [ "itemtemplates", ":itemtemplateid", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by item name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "\u003cstring\u003e" }, { "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).", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Item Template ID", "type": "text/plain" }, "disabled": false, "key": "itemtemplateid", "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": "6130dc67-ab55-4f77-a117-ae6dfb0d11c0", "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": [ "itemtemplates", ":itemtemplateid", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by item name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "\u003cstring\u003e" }, { "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).", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Item Template ID", "type": "text/plain" }, "disabled": false, "key": "itemtemplateid", "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": "0f56c877-384c-458c-8c98-ce9c87c2569f", "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": [ "itemtemplates", ":itemtemplateid", "items" ], "query": [ { "description": { "content": "Comma-separated fields to return, or 'all'", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "\u003cstring\u003e" }, { "description": { "content": "Search by item name. Prefix with ! to negate.", "type": "text/plain" }, "disabled": true, "key": "search", "value": "\u003cstring\u003e" }, { "description": { "content": "Sort field", "type": "text/plain" }, "disabled": true, "key": "sortby", "value": "\u003cstring\u003e" }, { "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).", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Item Template ID", "type": "text/plain" }, "disabled": false, "key": "itemtemplateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] }, { "event": [], "id": "b85bf6b2-d938-461a-8f96-c112452b4902", "name": "/itemtemplates/:itemtemplateid/phases", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns the phases (item collections) belonging to a single item template.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/itemtemplates/:itemtemplateid/phases", "url": { "host": [ "{{baseUrl}}" ], "path": [ "itemtemplates", ":itemtemplateid", "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).", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Item Template ID", "type": "text/plain" }, "disabled": false, "key": "itemtemplateid", "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": "5d28fd5a-92b3-4f9f-8e9f-1cd888b0649c", "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": [ "itemtemplates", ":itemtemplateid", "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).", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Item Template ID", "type": "text/plain" }, "disabled": false, "key": "itemtemplateid", "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": "395ae8dc-ed51-40e9-945d-5a36a53380ad", "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": [ "itemtemplates", ":itemtemplateid", "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).", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Item Template ID", "type": "text/plain" }, "disabled": false, "key": "itemtemplateid", "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": "47bb543e-ec7f-41d2-a013-ce723013f62a", "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": [ "itemtemplates", ":itemtemplateid", "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).", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Item Template ID", "type": "text/plain" }, "disabled": false, "key": "itemtemplateid", "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": "31c93a21-4fb9-4d4a-a987-8a91f99ac4b2", "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": [ "itemtemplates", ":itemtemplateid", "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).", "type": "text/plain" }, "disabled": true, "key": "includetotalrows", "value": "false" } ], "variable": [ { "description": { "content": "(Required) Item Template ID", "type": "text/plain" }, "disabled": false, "key": "itemtemplateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Forbidden" } ] }, { "event": [], "id": "52b3b9e0-69cc-4e30-ad01-2f21885bc674", "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": "6fa16184-099d-4583-9da8-87501ec30227", "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": "d97c02dd-8b6d-48a8-9cd4-fe335152bbc1", "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": "4aed6f5a-e0e4-47be-859c-b00982fe5e66", "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": "815ce244-c6ba-468e-863b-804ad1cd1d60", "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": "08296e90-8ad1-42af-85de-b64039f6f910", "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": "9f88d9e4-6405-494a-9ba6-4bfe0f66dc87", "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": "730dcd26-1c34-4bc8-9d9e-e685346e812c", "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": "72c7ded2-c455-4132-bfc5-cb6e4e126b98", "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": "f6377dc0-7b10-43f6-bf74-dde17d471d05", "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": "fd362e4d-54cb-43cd-b0d2-cf65f1ffa205", "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": "7a080e02-47d0-41d0-b288-39f41d506222", "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": "34e0f232-f098-45fe-8fee-6dd575aeaedd", "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": "aa6845c7-ef0f-455c-a2d3-16428865e2c2", "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": "6d0b7afa-83eb-46bb-8766-90c604f78545", "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": "93cd97be-6328-4f9e-8458-dd7035e2c0d5", "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": "4b04b4f7-0d93-4597-966e-c08131b1630e", "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": "4b9d7a15-a2ee-4b3d-841e-0f9043836517", "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": "b737d4a8-a945-4c2f-b2ff-65b64aaf5e9b", "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": "55db8cd8-ac5f-4e10-a849-f6c572b75bee", "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": "dd7ab7c0-0bdf-493e-89c7-c3a4036bd403", "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": "d987d8aa-1ad1-45fa-b75c-061fd69f6a38", "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": "3a92b6ef-9a23-4c11-b435-65cdb5c1689c", "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": "cf350301-b378-4f3a-b344-5ab6a66e2754", "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": "7150f450-e98a-4bf6-88bb-34265aa37070", "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": "b2179d1c-593f-402f-a584-eabcd4223447", "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": "71ba08f1-5954-4952-92dc-2b0b3d8aeff4", "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": "6284d781-b1aa-4e85-a035-0f0937610da2", "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": "67077971-75ee-4055-86e3-3e6254efca20", "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": "451af699-239b-4479-bbf9-84b2b30e1dc9", "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": "322f2ecf-2366-4d14-b74a-4cc6ddfef9b3", "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": "140722b3-6896-4720-a553-8d17f5b3adb4", "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": "e52fee9f-bab8-45a3-a573-fd1eb8170475", "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": "60172b59-4120-4316-a0bd-e93b40ebfba6", "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": "86f26358-726c-4992-a894-33bc244b1d4f", "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": "04d3e4e0-75c4-41b5-b220-95037ca9635e", "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": "4925faac-0fc4-4b7b-b58d-5444342517c5", "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": "d59a3e7b-711d-44ad-9ad6-3db330ddfd46", "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": "e43999ba-4605-4620-a463-1f1c14242521", "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": "531c5228-57dc-4447-9c11-7e074c294adf", "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": "0158f554-2612-4c79-8a54-476fdcba583e", "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": "6c95932d-9403-439e-82bd-242d794c2d65", "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": "32157edd-3314-427e-8c6d-521b98bc5c23", "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": "80246acc-6d8b-42a6-984e-3ac5987d7353", "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": "430f5f8a-b0c9-4fb4-839f-a034ba14e1e5", "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": "e0ad4e4f-0c74-4485-8a2e-2b2e71c8602f", "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": "839b2d4d-51d4-45e5-b839-6f8690df13d7", "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": "53c38e74-1683-4cca-b32a-bd2e773c3a4b", "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": "a7afeb94-6533-4797-b94f-1c3353efa9d7", "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": "2d9db56d-2ffa-4c35-9dc0-2a4958be0887", "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": "ec371a99-722b-4dc9-b1cb-522310f89933", "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": "9d3a262c-c5d8-455d-a4fa-47817e0737c4", "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": "478415d1-b9c5-4f9f-9100-f8dbe669133c", "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": "7b5365f2-964b-443c-b70c-5a538a760810", "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": "12d2495b-0357-4105-a569-2f940a882ad4", "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": "67aeb0c8-1f9e-473d-8ce0-48171cbc51ec", "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": "21e84242-134d-4445-98d2-43570c4bce4a", "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": "13918527-292e-4d79-b3b9-793ce293e428", "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": "9ec23095-cb31-48c5-835f-aa285ea2fcf7", "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": "1e19d615-3d3d-4e4a-a111-d291062df22e", "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": "537421ea-ed83-4f4f-b259-a471215a94e4", "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": "a2278545-799f-4a92-9325-b48bc5a8cbd4", "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": "6bd3cfaa-5916-4118-b18e-97b6b63ce1b9", "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": "ca8c115b-fa11-4b65-9486-dbf23bee0e06", "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": "c6bcd8c0-2e80-4b0b-9a1a-3716f14b3756", "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": "db7b423d-b7c5-4717-9005-296bf4f030c8", "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": "d18e1383-dcfb-41dd-8b43-bb27d4a28927", "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": "b58035a2-5931-4735-a82c-71af98d86c03", "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": "4f2631b6-76c0-4b68-8597-05aa4574715f", "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": "c21aeb52-1f26-40be-ac98-b630dcb22ef6", "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": "021f461f-3a5b-49d0-8b24-67c550a4190b", "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": "51f13c5b-391b-4b9a-921c-34fdc1823f8a", "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": "be4485d4-7839-4237-a69f-39b985ee557a", "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": "1f6dead2-32f1-4b82-99b2-d92635ef1d12", "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": "efd135be-1b7b-4227-83cb-c495f96f6810", "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": "aa84dc3b-ef64-4d2c-acaa-28570c658c57", "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": "ad9fc459-a9d1-4cea-bfd0-e4480724a4ca", "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\": \"contractor\"\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": "a0aebcd1-5c50-4154-9919-91fa967ab0c6", "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\": \"contractor\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "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": "4da585ca-257c-4df6-bef4-60a55b207d23", "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\": \"contractor\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "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": "21e60fe0-c45c-4588-a695-c78d50609c4c", "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\": \"contractor\"\n}" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "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": "413ea896-78cb-44e3-8246-b0b0ae981181", "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": "27586c19-85c7-41ef-995d-a8f444fc2120", "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": "f454da57-92ef-4f8a-8b18-aaf7285c69cc", "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": "4edbed2b-7361-4a26-91f8-447f9394ba9c", "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": "7168ab70-3bda-4e0c-84a0-b3ef0afb821a", "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": "95a05aa3-6ae0-4012-97d2-ea632e9e66e8", "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": "064a25be-398d-45d9-8789-ad0af6be52bb", "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": "cda834ca-6b99-4886-be6d-6d68a501c16f", "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": "870b3181-752e-4d15-ab61-0e1f43cc0112", "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": "d44c601c-d132-4fd5-8ac7-3034a9d9e5b1", "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": "6c1ed222-122b-490b-858a-eaccc4dcbdca", "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": "cdb68ef5-6bd8-4198-8e74-bca3d9dd82e1", "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": "b7b2ee8e-d7bf-4610-9aa4-d0847385cd3a", "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": "effb6ea8-bcd2-44b6-babc-415d6c86d30d", "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": "cfc70aa1-41b1-41ca-a6a4-7c3e5d9aabf0", "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": "d441f468-93a3-472d-b615-bca387aea12d", "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": "cdebebe9-11a0-4cbe-92dd-0072555d4d72", "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": "9da7db6a-d284-408a-ad5c-f10d33818cd0", "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": "541baba2-ce44-491f-84a6-b589a28c59a7", "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": "50b737ac-0762-4357-9cc6-4e4e8a82f3f6", "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": "065d7514-3fe8-491e-a130-c53df226d05c", "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": "b27e8df7-8713-439e-afee-05bf4c0779bd", "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": "3079f244-8ebb-49ba-9311-791c98ff42a3", "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": "26f22655-3fc6-47b5-8c19-dd78e948aa66", "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": "64b8a2e9-847e-462a-9999-d2c812250b35", "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": "0630da1e-dcb1-4d47-accb-4266bd656ece", "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": "48d47971-6fbe-45b1-8524-66b6b9795001", "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": "6bf88f89-f8cb-4d2f-ad3a-55f6c5a91800", "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": "d5a235fb-ad39-4745-9f01-618e320aca92", "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": "11efd9ca-f1f2-476c-a79b-9896b22313d2", "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": "84352ab4-262f-463d-a631-49c88d519188", "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": "a94a594d-5fe9-4082-afa5-aa73814ddc57", "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": "89da6070-82f4-47d9-806e-9f771f495467", "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": "dba8c59d-ca1a-4c1c-923a-3dc0cac59680", "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": "7c1c4ddc-aeb0-49dc-a028-daa7d9d9002e", "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": "b825c648-6564-4534-8e6a-28535606450a", "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": "00e8e331-2096-4ba8-9813-9aea5c72d68f", "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": "16682a52-ff9d-405c-84ac-7707ce8f4be4", "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": "35923b8e-e6e0-48f9-9993-41568ed1378d", "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": "6c261f7b-cc2c-4ede-8c87-5b6a077a69f6", "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": "4e3c1ab3-8947-418b-a119-e0a099403565", "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": "484d89c8-147d-4ffa-8743-e39a89181447", "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": "b135142d-85dc-445d-8f41-d5571197bce2", "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": "2cb24277-4410-42b6-8f25-6f2e5854aba1", "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": "9430909e-6036-4495-a244-e94a153f0f49", "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": "ba410631-48c1-4f78-a0d7-ce67506d250d", "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": "d84e45d3-7857-4157-96f6-3aa856b5687b", "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": "291aaed4-5fdc-4bdc-ae15-ec34ed18e5db", "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": "5e50ab81-2341-465b-bec9-bff1fd61a7aa", "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": "53481b73-4244-4764-b951-56e8816a47c0", "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": "97343095-a7cd-41bb-8630-75d481bdb319", "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": "16352fad-8e2d-4271-bcb3-f68ef1988bbc", "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": "752db69d-8917-44b3-80b1-258805e6f436", "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": "63be5ea3-3e95-44f8-a193-4bcd7b845636", "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": "5a66546f-5d91-46c7-ba16-729699be477e", "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": "1f117e10-bd05-4ce6-abda-e5f080c9899f", "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": "e0d305ac-bca4-43d3-a930-70bf8747f936", "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": "115d75df-6a51-4b3e-ab84-79063b90e7d1", "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": "94343a90-4a69-45e6-85b6-6fa182e78224", "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": "0513c4fc-d0f0-4583-9c2a-27bde5a78bee", "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": "99a6e291-74b0-4014-b1d6-cc6685558f85", "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": "d0b9cd71-3b5f-486b-987c-534574cca22f", "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": "955a8842-3dd8-4180-8ff6-0a86dbc4793a", "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": "2081669a-2d94-4263-b90f-f60db44e18ad", "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": "44c8f435-dcb3-471c-9b37-b59dd6fa06fa", "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": "a8b1fb58-c702-48cf-99a5-5a0af7c4d91d", "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": "f2018bef-4439-4b84-82c1-f572421754ec", "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": "1aa4e989-9815-4359-a583-428e9ffb09f5", "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": "77d95d02-8ef1-421f-ba4c-c9120bad3d52", "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": "ab90aa69-a376-4c26-89ec-16c858835619", "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": "38e9e358-432f-46a1-b287-3013a1c29eff", "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": "21599409-703b-4fdf-8fb1-1e1e9bb624fc", "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": "1c9ae6ec-6af1-417f-bed5-8dbe3d622120", "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": "ba958539-a320-4768-8840-6c2ccc049bcc", "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": "269710a2-73de-48fb-9257-1bc03b0d7e6b", "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": "70ce0c6f-381a-45a6-8bcf-3c45a47eff3b", "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": "a3bb5709-8492-4915-a0b9-f98d6c250e7a", "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": "7a2d2e97-94c5-4b1b-b9de-a0334c6058fc", "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": "05df2949-fb7b-439a-ad22-ada32225ebbf", "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": "a01b2c95-10c6-4f78-bff5-0a54b5bd61d6", "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": "808d04de-b08f-4a0a-8ee8-6c52c0a7da74", "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": "ad72e437-8d29-4766-9e40-67bab0524bbb", "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": "5a2dff90-9754-4076-90c1-c1bfb3c11e3b", "name": "/settings/invoices/files", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Files attached to the account's Invoice Settings (a single settings row per division). 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": "/settings/invoices/files", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "invoices", "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: date, description, folder, link, name, owner, size", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,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": "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,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": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\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 \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"itemname\": \"\u003cstring\u003e\",\n \"link\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"pastedimage\": \"\u003cboolean\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\u003e\",\n \"size\": \"\u003cinteger\u003e\"\n },\n {\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\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 \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"itemname\": \"\u003cstring\u003e\",\n \"link\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"pastedimage\": \"\u003cboolean\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\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": "7f584236-5d68-47e2-b021-a78454b337aa", "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", "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: date, description, folder, link, name, owner, size", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,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": "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,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": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "91c99589-a2d3-42dd-8778-46f678d56664", "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", "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: date, description, folder, link, name, owner, size", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,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": "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,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": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "9c960ac2-417a-4db0-b6e3-89aad1eb7ba3", "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", "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: date, description, folder, link, name, owner, size", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,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": "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,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": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "72bae8e8-63c2-4a67-a142-e493b979526f", "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", "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: date, description, folder, link, name, owner, size", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,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": "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,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": [] } }, "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": "6fad42ee-c6b4-4953-8ae2-85e4c73a9fc0", "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", "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: date, description, folder, link, name, owner, size", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,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": "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,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": [] } }, "status": "Not Found" } ] }, { "event": [], "id": "7e306a9b-cc86-4682-b7e5-9033ad304a6e", "name": "/settings/invoices/files", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "mode": "formdata" }, "description": { "content": "Upload a file to the account's Invoice Settings root folder. Send a multipart/form-data request with the file in the \"file\" field. 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": "/settings/invoices/files", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "invoices", "files" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"fileid\": \"\u003cinteger\u003e\",\n \"filesize\": \"\u003cinteger\u003e\",\n \"folderid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"pastedimage\": \"\u003cboolean\u003e\",\n \"uniquetoken\": \"\u003cstring\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "d203e5ec-17f7-4df3-b2b0-55c659c48e90", "name": "Created", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "settings", "invoices", "files" ], "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": "f441d0a5-f5d1-4e62-8070-82b87076ebcd", "name": "Bad Request", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "settings", "invoices", "files" ], "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": "6f0fb620-05c9-4e44-9726-a42be4a5b3d8", "name": "Unauthorized", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "settings", "invoices", "files" ], "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": "94c1f1f4-f88b-4bde-b138-6fc764016445", "name": "Forbidden", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "settings", "invoices", "files" ], "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": "955df9e0-a2d4-4381-b049-08e96a5fe4fa", "name": "Not Found", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "settings", "invoices", "files" ], "query": [], "variable": [] } }, "status": "Not Found" } ] }, { "event": [], "id": "9d047ca3-dd80-445b-8941-7e9f71a245e3", "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": "3205157a-85ff-4a6a-9f25-36f6564734ae", "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": "3b31c8e7-0250-4239-9a3c-075366ff5397", "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": "90579d85-67d5-4feb-9caf-81f824e18e19", "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": "b0ef3786-fd33-446b-830f-7bfc6033d8ff", "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": "c5c2a5f7-286d-48f5-85d5-9347107155dd", "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": "678d69cf-cb14-4cda-a841-f974a92fcdaa", "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": "afea779e-6da6-4cc6-98c9-862da7b32183", "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": "d8f78439-246a-4c5d-8d83-ebfab9169513", "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": "35324f24-ef97-4a39-bc28-94c999299d9a", "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": "d033ecdb-d618-4d28-8eb6-a66e8716ae3c", "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": "e8df9396-6492-4bf5-8904-2f4679f879d4", "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": "18facea1-2f33-4795-9999-fc7f0274b42b", "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": "b8896651-d9b1-4100-b9d0-1f16dff53fe0", "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": "62b0c67e-8ebd-4089-b6db-db05a13ee376", "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": "fdfa770d-f4cd-4752-bbe2-0bd429562165", "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": "a88e3682-179f-4f7d-89c0-306bdae34a42", "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": "b5617a13-eee0-4aa2-ac8f-2ef5fc6f321f", "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": "e6e195f6-e964-447c-8de2-396f77c67b30", "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": "661c9fdf-12fe-4578-8c15-4ff775e8d356", "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": "ff3a5063-d7dc-45c1-82e6-5e188714be6c", "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": "78bacf49-401f-474d-9978-dd49929de584", "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": "f9399eb2-0bb6-41b2-83f4-1e5b2ab09f49", "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": "664c6291-e65a-40cb-abdf-f5e2bd8d3514", "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": "14732c7b-3852-4133-9503-3720def6f5d4", "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": "f5ac0234-1ce7-4e3b-8e02-b2268c9b1813", "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": "80a79210-084b-4f91-a8d3-2ae56a6c35d6", "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": "79ec7d2e-4fbb-4556-b8c9-1358ba0f0cde", "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": "686b21ba-d8e5-4883-8ded-75673e84f365", "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": "78903569-f078-4b8b-9688-f18ed11b84a8", "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": "c2955ec9-cd5d-44d2-b435-f7945aa8f54c", "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": "630edd1c-0255-4cd9-8ca7-a2c9d47db128", "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": "54307d0e-d250-4b93-b131-87c85016aa23", "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": "9674cbe1-102f-4ca6-b505-7d35a0e7cd21", "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": "5983e17b-4051-4a99-a554-fa617ef53512", "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": "304f8f0f-e013-4663-8f03-5ac1ee6295b5", "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": "b019c3ca-50fb-4f53-8100-0f139e0b2954", "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": "db7e345b-113a-4f5a-bee9-f8cb0e9c5924", "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": "1352a9f1-d481-40aa-9151-67b248bf9cf6", "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": "b70bb880-106b-412a-b1f9-dffbb23d6d91", "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": "372b06a8-b919-4b95-9aef-876f821179e4", "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": "46df42e8-94d8-4d18-989e-a7f24982503f", "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": "887e1ae1-47a6-4785-9a5f-6330725b8be0", "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": "2f3ae657-42dd-4e72-a461-f144cf471d20", "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": "45520f89-e672-4ede-b788-36d76a115d0a", "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": "96d80906-4f4f-4e46-b50a-e44e7896cfbd", "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": "610850d6-a920-458f-be1f-b23c616bbbc7", "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": "68790bf4-c857-4b0e-980c-367ed508e608", "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": "9e31d713-1cd3-4944-b6dc-18821584349a", "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": "a7cb3f9a-b761-4a11-b7a0-fa26c1243489", "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": "9f30bd40-3b07-4d75-be4e-9ee0f1e63ce5", "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": "64f174c4-6ae5-4c2f-9fab-061131e294e3", "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": "091e4267-3477-474b-87d2-5221a79a3d72", "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": "7692878e-66a2-49e6-a350-f359e57304de", "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": "f210c53b-02dd-4bf8-b2b1-4bb478115d8e", "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": "d31e822f-a699-4e53-a313-644559826e9c", "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": "44822488-7458-4b87-8912-dcd3ea74f1e2", "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": "2c288196-de68-45ec-9f2a-a52676cf27c0", "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": "3736b3e5-12ee-474b-b350-6de2961023cc", "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": "6a0298c9-05db-4361-98e3-94f81df87699", "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": "1a0161f1-8a3c-4510-9326-ba324654ea9a", "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": "c6ac7b43-10da-41eb-8598-82f9314e91af", "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": "0e9183b2-58c4-42e7-be7f-e954bbc5c51d", "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": "2ab5dc63-87f3-4300-b49c-58a9222b9f19", "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": "92f77e01-48e6-4c71-a679-8eb600a48393", "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": "5a072713-5156-4ee9-88e1-6bd9c899f36a", "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": "39acc2bc-15d2-45cb-8ed4-fe11c3f99534", "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": "c9cb2741-e13c-423e-880e-2a6a8d00764a", "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": "057b1f6d-8f89-4a3f-b6fd-afd1abe85063", "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": "c304ada6-cac5-47af-9699-ce08c4c7a75e", "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": "f76ca187-0fbe-4477-a795-f4263f6dc7ca", "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": "b308c611-5f6a-4560-b7c6-ba0b59e5fbab", "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": "8546e880-f014-476d-9e9d-d5e8039ec016", "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": "f7a01150-684d-4517-b236-a4fcb4974342", "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": "163346a0-00ed-46a9-95d1-eefc428f6ee2", "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": "9f4e0f29-7dda-408c-8979-b16398cabe76", "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": "c5edaa78-71ca-4ef5-8f74-357af35e311b", "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": "e764a3be-1c02-4ba8-927e-3d582a47bef3", "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": "880f2e5e-e8bc-431f-a517-3240013a4677", "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": "26015af3-fb8e-4bc0-aa11-18488fd9bdfa", "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": "c798f4a2-fb0a-419d-b707-edddc365e6eb", "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": "32d1485e-593b-46ba-8c87-9138195b89bb", "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": "107bff80-d901-40c2-88ab-f00ee65255c4", "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": "10aa2ce2-12d4-4795-8fc5-95e65c5de496", "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": "a1c00c4d-5899-496d-aed5-fde85a72dbb1", "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": "a3882a11-ece9-4a41-ac7f-17f39010f352", "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": "2c324e9c-b593-462f-9fca-b931aec50a32", "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": "e102f82a-3a8a-43ba-9d16-91a5fff640ef", "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": "4d1b9ba7-a87e-40a6-a735-7352244ce00b", "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": "3645ae65-9e4b-46bd-8e65-2c2149fd59e3", "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": "7aaf59aa-cf93-4653-955e-cc05458c9ab5", "name": "/settings/products/:productid/files", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Files for a Product (from any of the fixed-price, good/service, or hourly-service libraries — Products share a single ID space) based on the specified filters.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/products/:productid/files", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "products", ":productid", "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: date, description, folder, link, name, owner, size", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,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": "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,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) Product ID", "type": "text/plain" }, "disabled": false, "key": "productid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\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 \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"itemname\": \"\u003cstring\u003e\",\n \"link\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"pastedimage\": \"\u003cboolean\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\u003e\",\n \"size\": \"\u003cinteger\u003e\"\n },\n {\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\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 \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"itemname\": \"\u003cstring\u003e\",\n \"link\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"pastedimage\": \"\u003cboolean\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\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": "22abf021-e317-4f88-9ba1-199bcef5dd55", "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", "products", ":productid", "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: date, description, folder, link, name, owner, size", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,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": "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,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) Product ID", "type": "text/plain" }, "disabled": false, "key": "productid", "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": "870e2e47-670d-46c2-81c4-7a8a8ce0ec86", "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", "products", ":productid", "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: date, description, folder, link, name, owner, size", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,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": "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,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) Product ID", "type": "text/plain" }, "disabled": false, "key": "productid", "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": "025aef22-ca87-4c45-9da9-9db3748c6173", "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", "products", ":productid", "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: date, description, folder, link, name, owner, size", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,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": "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,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) Product ID", "type": "text/plain" }, "disabled": false, "key": "productid", "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": "f03fa6ce-6a4f-44d3-a263-ef56a61663ab", "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", "products", ":productid", "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: date, description, folder, link, name, owner, size", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,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": "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,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) Product ID", "type": "text/plain" }, "disabled": false, "key": "productid", "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": "bc2c8ed5-eb0f-4038-8152-e3a3b2f3f1ed", "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", "products", ":productid", "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: date, description, folder, link, name, owner, size", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,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": "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,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) Product ID", "type": "text/plain" }, "disabled": false, "key": "productid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "6fc20c9f-2e1b-4ff4-883d-f1d93e9d0684", "name": "/settings/products/:productid/files", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "mode": "formdata" }, "description": { "content": "Upload a file to a Product's root folder. Send a multipart/form-data request with the file in the \"file\" field. 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": "/settings/products/:productid/files", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "products", ":productid", "files" ], "query": [], "variable": [ { "description": { "content": "(Required) Product ID", "type": "text/plain" }, "disabled": false, "key": "productid", "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 \"pastedimage\": \"\u003cboolean\u003e\",\n \"uniquetoken\": \"\u003cstring\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "f0e7e5f4-6632-4937-9b38-efcface941c1", "name": "Created", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "settings", "products", ":productid", "files" ], "query": [], "variable": [ { "description": { "content": "(Required) Product ID", "type": "text/plain" }, "disabled": false, "key": "productid", "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": "d6d2930e-00cd-484e-9a25-da826772afb8", "name": "Bad Request", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "settings", "products", ":productid", "files" ], "query": [], "variable": [ { "description": { "content": "(Required) Product ID", "type": "text/plain" }, "disabled": false, "key": "productid", "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": "7b4053ba-52c5-4a22-925d-eee7e8999448", "name": "Unauthorized", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "settings", "products", ":productid", "files" ], "query": [], "variable": [ { "description": { "content": "(Required) Product ID", "type": "text/plain" }, "disabled": false, "key": "productid", "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": "d3995b29-777b-4688-94f6-9b16853c5b57", "name": "Forbidden", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "settings", "products", ":productid", "files" ], "query": [], "variable": [ { "description": { "content": "(Required) Product ID", "type": "text/plain" }, "disabled": false, "key": "productid", "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": "69810b70-e096-4c79-abc1-465ae06525dd", "name": "Not Found", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "settings", "products", ":productid", "files" ], "query": [], "variable": [ { "description": { "content": "(Required) Product ID", "type": "text/plain" }, "disabled": false, "key": "productid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "3b6a4284-5916-49ce-a70c-fd10709a6819", "name": "/settings/products/:productid/folders", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of custom Folders for a Product based on the specified filters.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/products/:productid/folders", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "products", ":productid", "folders" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: name, description, type, size, date, owner, contacts, 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) Product ID", "type": "text/plain" }, "disabled": false, "key": "productid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"contacts\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"contacts\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\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": "a7588965-8e55-4b3b-ae22-0c060e0071a8", "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", "products", ":productid", "folders" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: name, description, type, size, date, owner, contacts, 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) Product ID", "type": "text/plain" }, "disabled": false, "key": "productid", "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": "f404512a-04f2-47f7-a040-c83fc35585f7", "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", "products", ":productid", "folders" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: name, description, type, size, date, owner, contacts, 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) Product ID", "type": "text/plain" }, "disabled": false, "key": "productid", "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": "7f38e5cf-26f6-4143-a992-60b130f39576", "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", "products", ":productid", "folders" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: name, description, type, size, date, owner, contacts, 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) Product ID", "type": "text/plain" }, "disabled": false, "key": "productid", "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": "59417475-d82e-49e2-a8c2-7469e1aba2dd", "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", "products", ":productid", "folders" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: name, description, type, size, date, owner, contacts, 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) Product ID", "type": "text/plain" }, "disabled": false, "key": "productid", "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": "ff54b4a4-b5bf-4713-a14f-e505b1c76bba", "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", "products", ":productid", "folders" ], "query": [ { "description": { "content": "Comma-separated fields to return. Available: name, description, type, size, date, owner, contacts, 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) Product ID", "type": "text/plain" }, "disabled": false, "key": "productid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "cdbc1c4c-308e-4204-8def-9b55fde43938", "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": "c1e87f81-ae6d-4ec9-8fcc-dba0a12f24e7", "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": "9b3ccffc-d11d-44da-8276-f66ec7fce9cd", "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": "93564a49-659f-4387-8748-855b5dbecb6b", "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": "6fcf10e6-3038-4f90-b4c1-d92ace263130", "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": "e015128c-dcaf-43a1-844a-c65b7d68b1c3", "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": "6897710e-2666-41e6-bc34-c8e036f1bd1b", "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": "a6133b07-2d3e-4235-87a1-86f809a56c3b", "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": "155a5c36-5a79-4e96-8b9f-21785cfab161", "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": "f1364483-fc79-4db9-9d57-399d7a5bbefd", "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": "72212f6b-9620-4d13-a068-635a6d445e75", "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": "97d564f2-be36-493d-b7f8-96c4fd3ad47f", "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": "e99f5f8b-63a6-4ab7-8690-20f30adecb90", "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": "46fb980a-dce4-4e78-bbc9-eab5c1ad19fc", "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": "e501303a-23fe-4eee-9224-711577f11285", "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": "444cb516-fc3f-4d2d-936a-7e9c3f42f16a", "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": "65ca807b-11af-49dc-9dea-744590671605", "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": "b88fa01c-9af7-4d80-b066-c24b24fce134", "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": "9b81d10e-1247-412a-89bf-d8f6f29d86df", "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": "6ac9354c-1032-4a2f-8f57-dd5f0d9ca3a3", "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": "6d90f4e2-d5f2-4e67-8e7c-c5aaae4cf431", "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": "ea4d143c-cc47-4192-81c5-20f06c52da58", "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": "bd8b91ee-7a26-4304-874b-f248335f55eb", "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": "a3bbf2b7-41bb-4806-84e3-4043bc6ba48b", "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": "194aa3b7-8357-496b-87f9-73ba1182de38", "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": "fb08c91b-4189-438f-881c-4e2b15e5d17b", "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": "d088a99a-f548-4f9f-94cc-468803331173", "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": "f10fde1d-6976-43d2-85bb-0ef259ae7e48", "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": "3011e145-5af1-4f2e-a887-d86dea02c171", "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": "14c39417-c224-4141-94c1-d9581686d45d", "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": "324ef8b3-ddeb-4190-81c3-f42762f30ef3", "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": "3b8c02e0-77bf-4c58-8b88-c3072662566c", "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": "f17c3023-7fae-4f1b-8849-ec2a9b956aa0", "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": "9754dcf9-be40-4dc0-8cca-3487860c115e", "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": "e361d7d2-c14e-47f5-8bb0-f2e4cef556e8", "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": "9eb349cb-920d-4bef-8f09-0fc086d11f14", "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": "86663d6e-0d1a-4e39-9628-feafc11f970c", "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": "09ff48ec-d06e-4714-8946-71dbb7ea660e", "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": "4305e342-25d8-4ba4-b529-128a6f19bac6", "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": "de138d8e-257d-4d75-816c-f856935d7852", "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": "69d1dad8-d833-466b-a76f-52c3ab249e42", "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": "2599f40d-aa78-428c-b6a6-3682da54a113", "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": "7f4d94c8-7aca-4e2c-9e03-6c65219f9f8a", "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": "e8d8a8f8-ed2b-42f5-a68d-0679f7193697", "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": "3624bc53-b19b-4979-bc18-e7be20f705d5", "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": "7ca554bf-a894-43b7-9674-1ee57b0c762a", "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": "c127e03f-0f3c-4f24-ae5c-483f5d5fe2f7", "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": "71645317-493c-4e61-95c1-39f38f872169", "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": "935eee05-47f1-4961-810a-7bd47b0d3abb", "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": "e7cca81c-0aa0-4c7e-ba6f-b5cb62e93733", "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": "47ecdb4e-9f9b-439e-ba1f-9281be914bbe", "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": "f2a3d342-5881-4b18-91be-927911b1d72d", "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": "22f80692-5cb8-4b88-87c9-6674673a9861", "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": "4e359e64-1a8d-4119-b6ae-239f8a2ae455", "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": "c1d612f5-c9fb-4a04-adcf-254eb27904ec", "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": "4412e87a-0eab-4fb6-b5df-bdea719d5165", "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": "319c5b56-2c9d-4c93-a0e0-c75833ba3ec8", "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": "9969f98b-3cd6-4f51-b9b5-765362a050cc", "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": "939e495c-3402-44d5-a422-7369d51492c6", "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": "c296692d-cfe8-4d00-83ba-d4d432d780c7", "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": "3cb17e3c-d15f-4d68-b45e-2c5f6b023264", "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": "d4ffc0c5-a3eb-4dfa-b0d4-e16c6daa55e5", "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": "72288370-3b3a-440a-8d0a-eba8131ad6ca", "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": "2fc8895f-7ccb-4797-926b-c8e67781acb3", "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": "0f235275-a71b-4ce2-bb7d-53f46b7cc7ef", "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": "3f7d3a04-9d2b-4531-a367-92d60ba814e0", "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": "28e93bf1-223b-41d2-ad39-529509479bda", "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": "c64aa215-6b74-4e30-8e59-d44632ca449f", "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": "a79d73d8-6161-40eb-9361-c3283bd935d6", "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": "2461d62b-b982-453d-a1f7-f17c82b20f73", "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": "8dbc3dc6-80b3-44fa-b85d-bb8ccb23dcaa", "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": "3f421baf-691b-4568-ac04-89b4b4a16691", "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": "a02dec28-4fc0-4a86-999e-1d17333b04b7", "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": "d12eabca-f72d-4b39-88c9-0a60a48e886f", "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": "101bddaa-f8cd-4cbc-8f99-2c2eceb0455d", "name": "/settings/projects/templates/:projecttemplateid/files", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Files for an Item Collection Template 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": "/settings/projects/templates/:projecttemplateid/files", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates", ":projecttemplateid", "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": "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) Item Collection Template ID", "type": "text/plain" }, "disabled": false, "key": "projecttemplateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\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 \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"itemname\": \"\u003cstring\u003e\",\n \"link\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"pastedimage\": \"\u003cboolean\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\u003e\",\n \"size\": \"\u003cinteger\u003e\"\n },\n {\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\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 \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"itemname\": \"\u003cstring\u003e\",\n \"link\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"pastedimage\": \"\u003cboolean\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\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": "9bf2ab3b-3224-4a2b-b8e2-2ce5d8513701", "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", "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": "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) Item Collection 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": "ed9fc22c-13ee-40d2-b97e-973d02f40dc0", "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", "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": "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) Item Collection 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": "cd1a7cb6-4746-4810-a430-bfb5e0d33b22", "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", "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": "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) Item Collection 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": "a0c9bee8-b131-416c-9d83-f4d4b6d1abf0", "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", "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": "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) Item Collection 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": "5db5453c-b8e8-4257-b8bf-6336ec705163", "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", "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": "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) Item Collection Template ID", "type": "text/plain" }, "disabled": false, "key": "projecttemplateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "1fcba2e3-e5ba-4744-a9e9-5572ebe3c0ab", "name": "/settings/projects/templates/:projecttemplateid/files", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "mode": "formdata" }, "description": { "content": "Upload a file to an Item Collection Template's root folder. Send a multipart/form-data request with the file in the \"file\" field. To upload to an item folder use POST /templateitems/{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": "/settings/projects/templates/:projecttemplateid/files", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates", ":projecttemplateid", "files" ], "query": [], "variable": [ { "description": { "content": "(Required) Item Collection Template ID", "type": "text/plain" }, "disabled": false, "key": "projecttemplateid", "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 \"pastedimage\": \"\u003cboolean\u003e\",\n \"uniquetoken\": \"\u003cstring\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "68be481f-0682-48c5-b3dd-6e3732abf4d7", "name": "Created", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "settings", "projects", "templates", ":projecttemplateid", "files" ], "query": [], "variable": [ { "description": { "content": "(Required) Item Collection 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": "3b2c2da8-0a40-4eed-bfe5-91bab23b3ce1", "name": "Bad Request", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "settings", "projects", "templates", ":projecttemplateid", "files" ], "query": [], "variable": [ { "description": { "content": "(Required) Item Collection 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": "0915e014-6fd6-4e7e-a9ad-d3f33212206e", "name": "Unauthorized", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "settings", "projects", "templates", ":projecttemplateid", "files" ], "query": [], "variable": [ { "description": { "content": "(Required) Item Collection 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": "a36f9d53-a611-4f24-b145-525d38e79e48", "name": "Forbidden", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "settings", "projects", "templates", ":projecttemplateid", "files" ], "query": [], "variable": [ { "description": { "content": "(Required) Item Collection 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": "41dcf0c1-7851-4fa7-a1a5-39995596502d", "name": "Not Found", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "settings", "projects", "templates", ":projecttemplateid", "files" ], "query": [], "variable": [ { "description": { "content": "(Required) Item Collection Template ID", "type": "text/plain" }, "disabled": false, "key": "projecttemplateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "5fc13196-eb1c-4c83-8950-2f449c6c2696", "name": "/settings/projects/templates/:projecttemplateid/folders", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of custom Folders for an Item Collection Template based on the specified filters.", "type": "text/plain" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "name": "/settings/projects/templates/:projecttemplateid/folders", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "projects", "templates", ":projecttemplateid", "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) Item Collection Template ID", "type": "text/plain" }, "disabled": false, "key": "projecttemplateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"contacts\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\u003e\",\n \"size\": \"\u003cinteger\u003e\",\n \"type\": \"\u003cstring\u003e\"\n },\n {\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\n \"contacts\": \"\u003cstring\u003e\",\n \"date\": \"\u003cstring\u003e\",\n \"description\": \"\u003cstring\u003e\",\n \"id\": \"\u003cinteger\u003e\",\n \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"public\": \"\u003cboolean\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\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": "2f00cf59-6068-4d5b-b922-833e320665c0", "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", "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) Item Collection 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": "b95aacf0-eb3a-407d-97d9-4cf771727fa1", "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", "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) Item Collection 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": "18c117ce-2b54-449a-bbed-c07917a7bf5b", "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", "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) Item Collection 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": "d5bd9001-9219-42aa-93c4-1a0109160a89", "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", "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) Item Collection 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": "92266f59-8701-4cce-8b3a-f481346eb127", "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", "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) Item Collection Template ID", "type": "text/plain" }, "disabled": false, "key": "projecttemplateid", "type": "any", "value": "\u003cinteger\u003e" } ] } }, "status": "Not Found" } ] }, { "event": [], "id": "766028e0-7315-4878-81f6-c8ba4a54ca44", "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": "0869008b-396f-40d1-8b2e-80b33d768b8a", "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": "946467eb-2b72-47c9-b7b6-ab658c22a4e5", "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": "ed7c9a2b-75cf-4a0a-929e-4901f6cfecad", "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": "e95edc1b-16f4-4ca6-8798-a454d5de0e27", "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": "db82b6e0-8fa6-4b41-a717-1e8fdca019d1", "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": "3131e5ad-cbc3-4843-baf2-18725d6d7617", "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": "f1bf2368-b430-4e5f-a9a1-cccfc33e07f4", "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": "3ec2f85e-8f53-4745-917a-a93f7f4e9c6d", "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": "667773f1-064f-422d-af39-9c913e47ccf7", "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": "c052c4d6-a7bf-40b9-8123-56b3bf67c34f", "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": "91eb0736-2369-4fd0-9f15-134fe7239b08", "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": "b79f2b3f-cd5b-43c1-b1a4-26362ffc20f0", "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": "cb1d5338-a6ef-4ef9-b5a2-53d4d479826f", "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": "71e554dc-dabf-4932-8c03-c7c5effa4202", "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": "c54ccf05-4c49-4e26-8a2a-2ece64ae5d52", "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": "1321a466-93a4-437b-8833-5e68636fa82d", "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": "b5639ba8-75dc-4f0e-9928-7daafdb3d78e", "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": "7f34cd51-e1a2-4fdd-a3d6-d5e7f571924e", "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": "59c50d0b-018f-4499-90db-425fb8e14a5f", "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": "ad72a06f-411a-46ac-8f82-1450d77294d6", "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": "f623b370-261f-41eb-9123-e4c6e284b4da", "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": "17b0d97b-023d-4c6a-b19c-0256d52ca60a", "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": "f087cb12-5bf4-4186-b340-0799b020ac71", "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": "6dde2eba-0b14-475d-bb9a-c7e5e62183f1", "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": "91939693-d5ef-40a5-a257-cd751afac299", "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": "19f8f700-7675-40bc-bb6d-3c14f16a3416", "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": "2a8dd86d-b479-4342-858f-7de407256644", "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": "aad80574-ed58-4f22-85cd-879eb5514de0", "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": "3818e192-156e-4a9a-ac98-52a50dc0a45d", "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": "e3ec2c8c-d395-4550-8968-ecd1681f6df0", "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": "a8a835dd-013e-488c-b0df-9ac45bfcb13b", "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": "1dca034a-b16c-4340-8ec2-398cb2a80852", "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": "beb4a149-0ff2-4e2c-a355-b99da738ac6a", "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": "597da33f-cbd0-4acb-a6d8-c60167576f73", "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": "27dc8406-51ae-4b38-83bd-ed8975291695", "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": "4f14772d-922d-4975-b11f-a16363a73493", "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": "26b1c738-5421-402e-afea-2c53ed8e8e9b", "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": "51ef33e8-b5cc-4e6a-827e-c20df63b7ce6", "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": "46b8b83d-963d-4793-a6b8-335fd9906de5", "name": "/settings/quotes/files", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": {}, "description": { "content": "Returns a list of Files attached to the account's Quote Settings (a single settings row per division). 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": "/settings/quotes/files", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "quotes", "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: date, description, folder, link, name, owner, size", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,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": "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,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": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n {\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\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 \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"itemname\": \"\u003cstring\u003e\",\n \"link\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"pastedimage\": \"\u003cboolean\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\u003e\",\n \"size\": \"\u003cinteger\u003e\"\n },\n {\n \"companyid\": \"\u003cinteger\u003e\",\n \"contactid\": \"\u003cinteger\u003e\",\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 \"invoiceid\": \"\u003cinteger\u003e\",\n \"invoicesettingid\": \"\u003cinteger\u003e\",\n \"itemcollectiontemplateid\": \"\u003cinteger\u003e\",\n \"itemid\": \"\u003cinteger\u003e\",\n \"itemname\": \"\u003cstring\u003e\",\n \"link\": \"\u003cstring\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"ownerid\": \"\u003cinteger\u003e\",\n \"pastedimage\": \"\u003cboolean\u003e\",\n \"productid\": \"\u003cinteger\u003e\",\n \"projectid\": \"\u003cinteger\u003e\",\n \"projectnumber\": \"\u003cstring\u003e\",\n \"projecttitle\": \"\u003cstring\u003e\",\n \"quoteid\": \"\u003cinteger\u003e\",\n \"quotesettingid\": \"\u003cinteger\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": "b22f405e-df16-4bcf-a4f3-a543e828094e", "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", "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: date, description, folder, link, name, owner, size", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,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": "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,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": [] } }, "status": "OK" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 400, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "da9e807b-7e46-48a8-b34e-a807537c308e", "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", "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: date, description, folder, link, name, owner, size", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,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": "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,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": [] } }, "status": "Bad Request" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 401, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "32b6d872-97dd-4ab3-9a6f-706fcd648066", "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", "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: date, description, folder, link, name, owner, size", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,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": "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,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": [] } }, "status": "Unauthorized" }, { "_postman_previewlanguage": "json", "body": "{\n \"data\": [\n \"\u003cstring\u003e\",\n \"\u003cstring\u003e\"\n ],\n \"status\": \"\u003cstring\u003e\"\n}", "code": 403, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "bf4f9008-7261-4b00-acba-089c9d5b7b44", "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", "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: date, description, folder, link, name, owner, size", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,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": "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,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": [] } }, "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": "349fd7d8-86ff-44b4-a2e3-df3783eb7aee", "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", "files" ], "query": [ { "description": { "content": "Comma-separated list of fields to return. Available: date, description, folder, link, name, owner, size", "type": "text/plain" }, "disabled": true, "key": "fields", "value": "name,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": "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,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": [] } }, "status": "Not Found" } ] }, { "event": [], "id": "78d4e043-af08-47db-94ff-2c7ebd255944", "name": "/settings/quotes/files", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "mode": "formdata" }, "description": { "content": "Upload a file to the account's Quote Settings root folder. Send a multipart/form-data request with the file in the \"file\" field. 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": "/settings/quotes/files", "url": { "host": [ "{{baseUrl}}" ], "path": [ "settings", "quotes", "files" ], "query": [], "variable": [] } }, "response": [ { "_postman_previewlanguage": "json", "body": "{\n \"data\": {\n \"fileid\": \"\u003cinteger\u003e\",\n \"filesize\": \"\u003cinteger\u003e\",\n \"folderid\": \"\u003cinteger\u003e\",\n \"name\": \"\u003cstring\u003e\",\n \"pastedimage\": \"\u003cboolean\u003e\",\n \"uniquetoken\": \"\u003cstring\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "02ef02b9-9960-404c-889a-37ddbc4ed71f", "name": "Created", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "settings", "quotes", "files" ], "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": "8ab7f297-0d70-4f01-bdd3-afb2f6b2ef44", "name": "Bad Request", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "settings", "quotes", "files" ], "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": "e9690294-bb87-4b42-8760-0dab541033b2", "name": "Unauthorized", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "settings", "quotes", "files" ], "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": "a8998d03-22fd-4648-8a06-75fc45014309", "name": "Forbidden", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "settings", "quotes", "files" ], "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": "9772c433-d616-4392-ab38-d121bb790343", "name": "Not Found", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "settings", "quotes", "files" ], "query": [], "variable": [] } }, "status": "Not Found" } ] }, { "event": [], "id": "01531cee-8dae-4c2f-a792-c2e108fffe31", "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": "a6273797-cf0a-4bd6-ba2f-078034caeb97", "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": "972a1729-18a1-44a5-8439-6335ef3e9cad", "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": "6ac4b239-6e7e-4b86-87f5-33fec9d8ae33", "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": "fe147b61-ed76-44e9-951c-b2b0f80a5fa2", "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": "1ff10dc7-5563-465f-893d-0be5ecc11e0c", "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": "c66e6625-4d26-4584-84b4-93ed523ef223", "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": "59a7130d-b6e7-467e-8596-bb17f7a964c1", "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": "793f0d2f-88de-4f91-9472-54fe5aa7d269", "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": "ec5f5cbf-6a64-4f8a-b9ca-436660461e55", "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": "4b2e6c65-77c4-45df-9650-24de6ff1a816", "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": "83eac1be-4253-4a8d-b046-7bda5c8d7167", "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": "ff87d446-2b43-4196-8a09-cccdcaf61b90", "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": "0cef9d0d-e1f5-4caa-aceb-f1b1feaa4574", "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": "bb2e9070-ba7b-4cba-b7d0-fa057a9b293f", "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": "514b4aa9-2718-4893-bdde-d8b807821198", "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": "10ce6037-10cc-48c1-b9f1-7810d51bf28d", "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": "f527d0f2-8317-457b-8fc7-e55483631458", "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": "3e9191ec-d349-4b63-9a32-120df656ba7f", "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": "df85b41a-7422-469d-89aa-e06c55cbccaf", "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": "b6dbf0e5-1524-41d5-a65c-d8e71272eb33", "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": "c4e13d2c-32b1-4549-8700-37a19427eeed", "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": "31f6a1af-ef55-4094-973a-a521577c671b", "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": "51fd1c1f-3d5f-4e94-8184-f7e52437a30f", "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": "5959a1be-74c5-44e3-952a-306037bde8ef", "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": "a1f5ef14-350a-434b-8a45-8156e63662e7", "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": "61303edc-3e9b-40b3-b750-aae13435e942", "name": "/settings/webhooks", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"event\": \"editcontact\",\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": "22bf3a6f-bd17-4ccb-a79c-7229ef69b1ac", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"event\": \"editcontact\",\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": "c334845e-bbc2-4f03-a2e1-35c786a8b51a", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"event\": \"editcontact\",\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": "17d1a885-0fc6-4a07-b2b0-2276c8bd0588", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"event\": \"editcontact\",\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": "27405c8c-ba86-43fd-b2ef-a2257a7c7e5b", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"event\": \"editcontact\",\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": "f35717af-fb79-4633-8e7c-19b2ed97dafd", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"event\": \"editcontact\",\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": "68047f23-c325-40a6-8508-d91b545d3952", "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": "256a9759-9ba4-4af2-b4d4-a984a48d167f", "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": "da92989a-b1e9-48bd-84f5-695e0d0860f5", "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": "77b4e0ea-4431-4fe3-a4d9-775382fbda61", "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": "d17ae703-ecf7-4dc8-b978-94e7eeb3df89", "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": "c5736778-cb9d-4b54-9ffa-d1f7b5c47bd9", "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": "2bde5b74-3f10-4969-b29e-aceecf85b0ca", "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": "288cdd6f-c3f2-40bd-9a5c-970a2037ef27", "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": "f66f148e-6f74-4ba6-a60b-5bda98fdc414", "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": "54812ea2-a05c-47d7-b10f-96161cb50e08", "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": "101ff921-9cd3-492e-b6f1-818337ca8638", "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": "37c428dc-5f4d-485d-933d-ef9ace3c8f97", "name": "/settings/webhooks/:webhookid", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"divisionid\": \"\u003cinteger\u003e\",\n \"event\": \"deletetask\",\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": "5c95421b-2830-478d-9aba-73aa371111e4", "name": "OK", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"divisionid\": \"\u003cinteger\u003e\",\n \"event\": \"deletetask\",\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": "b582efde-39dc-4267-b6e7-5b16022bbcbc", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"divisionid\": \"\u003cinteger\u003e\",\n \"event\": \"deletetask\",\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": "2f50b7a3-2af6-4679-9dc4-552bd6324bdc", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"divisionid\": \"\u003cinteger\u003e\",\n \"event\": \"deletetask\",\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": "d0cc181a-7173-46a6-b13f-f08218a35b18", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"divisionid\": \"\u003cinteger\u003e\",\n \"event\": \"deletetask\",\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": "15944a09-4248-4347-a879-75286fdbfcfe", "name": "Not Found", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"divisionid\": \"\u003cinteger\u003e\",\n \"event\": \"deletetask\",\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": "f6e06fba-fd3c-4b6e-9b41-6faf17135c2f", "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": "db64e1d9-b6e3-4c52-9e90-e43ee4ea85db", "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": "abe64b30-95eb-4e62-8d9c-2ef47d76263e", "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": "b2206c29-371e-4c95-90be-f851d1475c2d", "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": "d9bc3f4d-7d0e-4ac1-9537-8c09029dc1d7", "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": "49fc26e3-15c5-4061-8d39-45014775ea84", "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": "c75b53d1-1c8a-4314-a18e-e4555daa9066", "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": "item" }, { "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": "efff351a-1166-42be-b547-53936171ca25", "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": "item" }, { "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": "efe28fbe-1768-4256-a584-46da23430ec3", "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": "item" }, { "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": "db515327-4c23-4417-ae97-252459735fd6", "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": "item" }, { "description": { "content": "Filter by work state (exact match)", "type": "text/plain" }, "disabled": true, "key": "workstate", "value": "\u003cstring\u003e" } ], "variable": [] } }, "status": "Unauthorized" } ] }, { "event": [], "id": "00fcc1fa-4e3f-4598-8341-1a036c8dd9f2", "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": "d4575361-4577-4e78-8dd3-7ec18fb743ae", "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": "ff99c4a1-3328-417d-98a6-43885527e9b0", "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": "0e12f3f2-6861-4ecc-a81e-5c0280e3e5f4", "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": "6cef6368-b4bb-4197-8ef3-0db28c724a6c", "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": "90798100-d7eb-462b-8099-e4db2dda7cd9", "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": "bc4427d8-3156-4163-a584-12eb05dc3678", "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": "9115791e-c76d-421b-9f11-4f8fb36de1c4", "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": "fe45f2d6-b0d1-41a5-a5cf-ea538fe700b5", "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": "3a775817-ff2b-4e60-bd45-4a1f2585b306", "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": "f7a0b980-151c-41b3-827e-f74eb48c5b49", "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": "a43a3cb0-83e3-46c7-ae76-d16e37ad8d01", "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": "71a32178-1ab1-4782-ad81-c0cd13a66d5c", "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": "752c5384-2029-43e0-b148-0b3a96d48c10", "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": "aefc8046-d5c7-47d3-8c42-d4a0f80abd5a", "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": "222db716-212b-49fd-a724-b47851db8a96", "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": "033445e5-4a22-40dd-b35d-14b84e4242f8", "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": "5f2d1641-e8e2-4a1e-8439-b41e33032b3e", "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": "97730c38-6f83-4a67-a033-0c0b1f4e8477", "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": "9ab32082-1881-4a89-9fb2-ca539a7c69cc", "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": "730c1ecc-43a3-4e75-8196-45d3ac5306b5", "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": "9ea4109a-4cc8-4ac7-94b0-2b55368d7f03", "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": "2d69a030-56a3-43ad-8361-d61778dfb1f5", "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": "44587097-1ff0-4a7a-98e9-85205a55515e", "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": "2e98e3a5-306e-4b87-98c9-4789f9f2d3dc", "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": "2141132b-e913-46fb-b89d-6f9a34b9b3c7", "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": "51c7ced5-2bc0-44e8-89c7-2fe9c6f3fafe", "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": "d50e00af-2d4c-4d9d-9eaf-4009b6dcc261", "name": "/templateitems/:itemid/files", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "mode": "formdata" }, "description": { "content": "Upload a file to a Template Item (item folder). Send a multipart/form-data request with the file in the \"file\" field. 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": "/templateitems/:itemid/files", "url": { "host": [ "{{baseUrl}}" ], "path": [ "templateitems", ":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 \"pastedimage\": \"\u003cboolean\u003e\",\n \"uniquetoken\": \"\u003cstring\u003e\"\n },\n \"status\": \"\u003cstring\u003e\"\n}", "code": 201, "cookie": [], "header": [ { "key": "Content-Type", "value": "application/json" } ], "id": "0ed0b341-1884-451f-9690-ccff52ca8439", "name": "Created", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "templateitems", ":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": "89aaaaed-87fd-47da-8759-c75b19c76ddb", "name": "Bad Request", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "templateitems", ":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": "03653d4b-52e0-4bb9-b908-6cb2c8a3afa0", "name": "Unauthorized", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "templateitems", ":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": "19ad5cca-d558-4f39-8a35-81b4b40614a6", "name": "Forbidden", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "templateitems", ":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": "f2f74690-fd25-4a05-a193-b861dbfa5199", "name": "Not Found", "originalRequest": { "body": { "formdata": [ { "description": { "content": "(Required) File to upload", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "Set true if this file is a pasted image (e.g. from clipboard)", "type": "text/plain" }, "key": "pastedimage", "type": "text", "value": "\u003cboolean\u003e" } ], "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": [ "templateitems", ":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": "575a0850-2a74-47cd-bba5-f3c0abe70bba", "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": "67530cf7-6ee9-4da3-834d-29774e977851", "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": "ed7e8fcc-8429-4375-9d16-cdaac278ad98", "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": "6c65fa89-a479-4dd5-b8e9-ed98b0f6c24a", "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": "990636e5-3f71-4101-9faf-a5355d681466", "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": "2c6557ac-cda1-440e-86f6-e1ad5a17359d", "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": "1192a61f-a5d5-479c-a9f2-c450870e7396", "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": "5abee94f-1d48-433b-9f13-01df2b0899c6", "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": "45effac4-ef78-45cc-9bf7-49ea12c39617", "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": "70452fbf-54d6-4428-8919-288edb8b1e45", "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": "9fd5150b-49af-4562-a138-7f7eccef02b3", "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": "e37d4f19-3beb-48c4-aa0b-88ec77ac925e", "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": "06bd8ceb-708a-4223-a663-4c17a70ba0a0", "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": "04f658e2-3c11-419d-a7ee-fe2d46c06be6", "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": "fbdf679d-a4bf-4c01-b1d1-c9f4f8f32439", "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": "32253d01-b9ab-4a96-8db5-889bc49bdd67", "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": "ab86d808-a35d-404d-88f2-c44e65c5f45d", "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": "f5ca59d3-0627-4515-9b23-739136ac65fa", "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": "23a0e6ba-3964-40b7-bef2-2d626a40c02c", "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": "f4c92062-6384-4cdb-b6f7-22c842cdbabb", "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": "ce786883-d786-485d-bded-61c6b893075d", "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": "4f231110-c989-4116-85ac-f2342d10dfa7", "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": "54298fad-b0e0-4220-bef6-966e468f146a", "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": "521e0bae-f487-47a1-8617-fa992e94ff47", "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": "8235e2e2-3219-4632-ae5b-31212b26a4c4", "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": "605d5c2f-6a68-4bfc-8def-a1b1bec83d87", "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": "b9d75781-9212-46d2-a07b-679fbe2a57ca", "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": "all" }, { "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": "dc0cb1f8-a42f-45d1-9ee7-78c158c83d9f", "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": "all" }, { "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": "2f5a5940-db9a-4c6f-84b0-c731ddbee683", "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": "all" }, { "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": "3115b0c5-099e-4342-b70d-560b03df4af7", "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": "all" }, { "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": "f9b57841-acae-4f5e-9cc2-e9db78580707", "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": "all" }, { "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": "896b19c2-7703-412d-9ded-31255fcada49", "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": "b1b612fe-bc7c-4239-9310-4b1011d0e94b", "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": "df72c8c3-c4fd-4773-a8f9-8f3aa7f3af37", "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": "ba7a2fa6-f5b4-4233-aa23-b97da08bd605", "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": "80a62fe4-ad95-4b27-8432-82954149d0d4", "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": "e76503f2-b43c-4c07-85de-37c1cd9ddec9", "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": "0b5e6929-3371-42f0-8f82-760884f7eb0a", "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": "b601e7b4-664a-4c19-8390-69ea2e9e8eef", "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": "bc0942e0-1c41-410e-bf93-c9c79c47ba02", "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": "a8fb3ef5-c9dc-4b18-8e48-d1e2b5966994", "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": "d721a0ea-3997-4fd4-90f1-d592461f9021", "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": "bcbb8343-3424-4500-b1e0-835eba2d42a8", "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": "487f3dd2-a07e-496c-b428-10ed10efb5fe", "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": "1c597e97-9dd1-4e13-bba4-1b8ff9885136", "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": "e3f90d05-3e9a-4b3c-a734-477f771870c9", "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": "6649965f-c25b-4161-aad5-301bb31e464c", "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": "46c637f7-955f-47cd-abed-6a3d32b69820", "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": "e99d2475-a252-41b8-9f1c-dab0986acadb", "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": "4d79c6fa-8731-4a50-a5ea-405b93ed532f", "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": "0c4e2600-74b9-4fd9-aa0b-7d2ad99cb190", "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": "956f5d7a-af85-4a4b-9efb-ec560a219b54", "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": "5bdca0c3-e55c-4105-a7a6-d0ec0fd5ebf0", "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": "5c462304-d0c4-463d-86ef-5b8a2714cc5f", "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": "b3b70366-30ee-44a0-87dc-e31b6112363e", "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": "61645e69-960d-4312-81c4-d803c5452726", "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": "746aec7f-2bd9-48a9-a75e-2641214fd194", "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": "dc0d4218-ddff-4f87-9ee6-b5b3753c7cbc", "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": "4245dea2-6aab-42a7-80c2-63a4ef7c1e20", "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": "046e108c-ebc2-4ece-99bb-9f52be56690b", "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": "77adc1ad-3a62-4592-aec1-fa1967501241", "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": "7b5f0b4e-5c02-41e4-986e-4db8472cccdc", "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": "180418eb-3a11-499d-825f-2a7f5af097c9", "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": "4597a8fb-9b4e-4bca-84df-424f1ab9d473", "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": "c4e61dde-adf5-4c48-ad6a-4c5162ba40fb", "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": "b3df98a8-aff7-4594-af30-330a9ddf475b", "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": "ad7efc06-34ef-4512-a903-3caf6d179633", "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": "76b1e7e3-f8d3-49d4-8436-7f88e9cbdd01", "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": "f696cd11-ccd7-4941-82bb-4760576fed38", "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": "0587aefa-3a35-4522-85fe-e35e86afc4bf", "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": "062beecb-8e81-4485-b751-1d91bbbde447", "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": "59387182-be51-4299-813f-a1fd46d9ed93", "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": "e843f12e-9f69-47a9-a60f-a42abd3fdf75", "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": "45c44482-f2bb-47a6-9fd1-f6074f781088", "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": "ea5f9b00-1b39-4cac-b80d-06f355aa257d", "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": "dfc13b0a-f6b3-4d98-852e-e98cff3a0c7c", "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": "718f9cb9-8973-405f-92d5-fb759f4ebcc4", "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": "f9e1161a-67ff-4b5b-89eb-613e2a06a688", "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": "9e98f6f4-46f2-433c-b423-4a5ecca8fd82", "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": "9f2fc5dc-d482-4612-87a6-4033265eb0d5", "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": "7e29dbfd-3031-48c8-84b8-3e664d7352a7", "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": "792fcf4e-edee-47fa-88c3-e5e17a1a1d35", "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": "1401e271-ad9d-4c77-ab7b-714993c7bb9e", "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": "9d1c1098-f5ea-45a1-bf8f-1d1d6590e364", "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": "08ff25d7-2e41-4d56-a52b-2f8825e8ae39", "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": "1c8bc2b6-ccec-49c0-a6f4-47529e0a1ae1", "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": "2b107360-7e21-4de7-9521-36b1f1bb1479", "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": "e3133093-635e-4e41-921f-69abfe043746", "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": "a683db6f-1a68-4fb8-b8c6-8a699aabed83", "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": "fdf33c6b-ae4b-482e-b64e-4ed599bdfc23", "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": "f8c25294-40dd-4ba8-aa6a-e99d48332b41", "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": "da6c1a56-a25d-46eb-b28a-918fda5baa09", "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": "57d68831-814d-4165-9f71-8389333f3ecc", "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": "a5ecdb07-778c-4851-8607-97579d5b3b7d", "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": "0793838f-a3b5-4c06-92ec-ec5744ff5f27", "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": "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": "Maximum results when using fuzzy search (q). Default 10, max 100", "type": "text/plain" }, "disabled": true, "key": "qlimit", "value": "10" }, { "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": "all" }, { "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 (must be used with pagesize). When q is present, this is always forced to 1.", "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": "d2beb88f-16ef-47bd-b8a4-2c907c85ca89", "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": "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": "Maximum results when using fuzzy search (q). Default 10, max 100", "type": "text/plain" }, "disabled": true, "key": "qlimit", "value": "10" }, { "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": "all" }, { "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 (must be used with pagesize). When q is present, this is always forced to 1.", "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": "4e230bd1-db00-40dc-ba87-2e69488634fc", "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": "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": "Maximum results when using fuzzy search (q). Default 10, max 100", "type": "text/plain" }, "disabled": true, "key": "qlimit", "value": "10" }, { "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": "all" }, { "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 (must be used with pagesize). When q is present, this is always forced to 1.", "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": "ff03f641-e5ec-4e68-b23f-3ee6dc812c37", "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": "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": "Maximum results when using fuzzy search (q). Default 10, max 100", "type": "text/plain" }, "disabled": true, "key": "qlimit", "value": "10" }, { "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": "all" }, { "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 (must be used with pagesize). When q is present, this is always forced to 1.", "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": "4d3df27d-e301-4f65-afa5-4430038781ff", "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": "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": "Maximum results when using fuzzy search (q). Default 10, max 100", "type": "text/plain" }, "disabled": true, "key": "qlimit", "value": "10" }, { "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": "all" }, { "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 (must be used with pagesize). When q is present, this is always forced to 1.", "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": "fabfb03e-df12-495c-a0a5-21ab1f82e21c", "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": "45f0596a-444f-4451-b16c-e73157935445", "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": "bcb862aa-744d-47e5-add0-c28c06eebbea", "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": "17121521-b9f0-473d-81ac-422d60563894", "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": "e43de099-89b9-4697-a910-1a4447811ee8", "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\": \"rating\",\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 \"icalcontactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"itemtemplate\": {\n \"dateSetting\": {\n \"shift\": \"\u003cdate\u003e\"\n },\n \"id\": \"\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": "ccc1436b-f215-470e-9fbe-49831c2b275c", "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\": \"rating\",\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 \"icalcontactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"itemtemplate\": {\n \"dateSetting\": {\n \"shift\": \"\u003cdate\u003e\"\n },\n \"id\": \"\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": "bcf6df13-f96a-4f9c-bbec-1c7711dcd183", "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\": \"rating\",\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 \"icalcontactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"itemtemplate\": {\n \"dateSetting\": {\n \"shift\": \"\u003cdate\u003e\"\n },\n \"id\": \"\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": "e3832d2b-780c-43b4-8a3e-860a5f2f806b", "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\": \"rating\",\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 \"icalcontactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"itemtemplate\": {\n \"dateSetting\": {\n \"shift\": \"\u003cdate\u003e\"\n },\n \"id\": \"\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": "f6d92c48-49c4-4623-9a48-0752627e8ddc", "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\": \"rating\",\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 \"icalcontactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"itemtemplate\": {\n \"dateSetting\": {\n \"shift\": \"\u003cdate\u003e\"\n },\n \"id\": \"\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": "4fbe4a1c-fe0d-41f2-9c29-e5702697a166", "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": "9fcab3cc-5375-4ab9-9443-d171d07b6d5c", "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": "a7b78d25-ed21-45e1-9b3c-3bd586676f3b", "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": "99529d21-a382-4e99-837c-06250a697f0d", "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": "9611b6ab-497b-46e4-94ab-a8627d5eb99f", "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": "ec703536-0b6c-467b-b4e1-a6e2efc51b90", "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": "cffbfe98-905a-4793-af50-b1590f53d7b6", "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": "f14127e4-66d0-4917-8985-f5285ea557a9", "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": "36d285d0-ea6b-47e8-9a5a-73ce07e6bfeb", "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": "6e31a791-967b-4b5a-932b-cf9de9625faa", "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": "6e61aad4-c1bf-451e-ac48-5e60acfc2fe6", "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": "1e7a2aea-8199-4901-9273-8c29b6f925e5", "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": "5f9ad426-72f4-4fbf-8401-8d303396dd69", "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": "f327cae5-d39b-43a7-abdd-148896c8525a", "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": "556235a1-b43d-4585-8560-ab5b94593561", "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": "6addf81b-63c9-4de0-9dad-064c4ac51dcf", "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": "55738106-8e9a-499a-b4f0-4d2e8a577a62", "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": "f19648c0-1047-4f32-9251-25fbf6ae4992", "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": "d3dd4360-9098-4b5a-a7be-26471ce9d9b8", "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\": \"rating\",\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 \"icalcontactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"itemtemplate\": {\n \"dateSetting\": {\n \"shift\": \"\u003cdate\u003e\"\n },\n \"id\": \"\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": "654964d3-43b5-4e30-852d-6b079bd49371", "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\": \"rating\",\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 \"icalcontactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"itemtemplate\": {\n \"dateSetting\": {\n \"shift\": \"\u003cdate\u003e\"\n },\n \"id\": \"\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": "f281c8f9-8201-4b20-8de8-234a70d4f10a", "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\": \"rating\",\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 \"icalcontactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"itemtemplate\": {\n \"dateSetting\": {\n \"shift\": \"\u003cdate\u003e\"\n },\n \"id\": \"\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": "ea803531-9d1d-4ea2-97dc-45c36c622a96", "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\": \"rating\",\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 \"icalcontactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"itemtemplate\": {\n \"dateSetting\": {\n \"shift\": \"\u003cdate\u003e\"\n },\n \"id\": \"\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": "e9815b7c-03d9-4078-b6c6-49de44d302b2", "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\": \"rating\",\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 \"icalcontactid\": [\n \"\u003cinteger\u003e\",\n \"\u003cinteger\u003e\"\n ],\n \"itemtemplate\": {\n \"dateSetting\": {\n \"shift\": \"\u003cdate\u003e\"\n },\n \"id\": \"\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": "9905d47b-4e6b-4d1a-b477-43cd74fb862f", "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\": \"date\",\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 \"itemtemplate\": {\n \"dateSetting\": {\n \"shift\": \"\u003cdate\u003e\"\n },\n \"id\": \"\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": "85e8b7a8-5e0f-448b-af66-a8eed496c6a0", "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\": \"date\",\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 \"itemtemplate\": {\n \"dateSetting\": {\n \"shift\": \"\u003cdate\u003e\"\n },\n \"id\": \"\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": "a0fedb6d-ad2c-4c70-bb1f-42719d70a024", "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\": \"date\",\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 \"itemtemplate\": {\n \"dateSetting\": {\n \"shift\": \"\u003cdate\u003e\"\n },\n \"id\": \"\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": "c19ac7b9-b298-47f1-bed8-d1c2b4586139", "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\": \"date\",\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 \"itemtemplate\": {\n \"dateSetting\": {\n \"shift\": \"\u003cdate\u003e\"\n },\n \"id\": \"\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": "1ce39b4c-01fc-4512-8058-80d42948f915", "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\": \"date\",\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 \"itemtemplate\": {\n \"dateSetting\": {\n \"shift\": \"\u003cdate\u003e\"\n },\n \"id\": \"\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": "5f092290-dfe1-4031-90ad-1f5f7276d0a4", "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\": \"project\",\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": "0d5fccc5-7804-484f-935d-01a85a0564d9", "name": "Created", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"groupby\": \"project\",\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": "d84e7f4d-6b70-46a2-9000-12723ac7d372", "name": "Bad Request", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"groupby\": \"project\",\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": "1a56886f-202f-4a95-bc73-7fc3862ff773", "name": "Unauthorized", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"groupby\": \"project\",\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": "dc84aecd-708b-4d39-bfde-26852f49aeee", "name": "Forbidden", "originalRequest": { "body": { "mode": "raw", "options": { "raw": { "headerFamily": "json", "language": "json" } }, "raw": "{\n \"companyid\": \"\u003cinteger\u003e\",\n \"duedate\": \"\u003cstring\u003e\",\n \"groupby\": \"project\",\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": "1281d825-9276-4146-b7eb-25048e45afc6", "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": "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": "Maximum results when using fuzzy search (q). Default 10, max 100", "type": "text/plain" }, "disabled": true, "key": "qlimit", "value": "10" }, { "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": "all" }, { "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 (must be used with pagesize). When q is present, this is always forced to 1.", "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": "1ea42326-f0b1-4d90-9d5c-610ba36c5413", "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": "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": "Maximum results when using fuzzy search (q). Default 10, max 100", "type": "text/plain" }, "disabled": true, "key": "qlimit", "value": "10" }, { "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": "all" }, { "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 (must be used with pagesize). When q is present, this is always forced to 1.", "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": "324bbe86-a3e6-48f0-a0ef-2ba16391bc50", "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": "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": "Maximum results when using fuzzy search (q). Default 10, max 100", "type": "text/plain" }, "disabled": true, "key": "qlimit", "value": "10" }, { "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": "all" }, { "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 (must be used with pagesize). When q is present, this is always forced to 1.", "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": "7a4221d1-2804-4d5f-8d0c-a38f53f08b67", "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": "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": "Maximum results when using fuzzy search (q). Default 10, max 100", "type": "text/plain" }, "disabled": true, "key": "qlimit", "value": "10" }, { "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": "all" }, { "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 (must be used with pagesize). When q is present, this is always forced to 1.", "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": "d3bfffc5-c29e-48e9-a132-2a4badab0489", "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": "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": "Maximum results when using fuzzy search (q). Default 10, max 100", "type": "text/plain" }, "disabled": true, "key": "qlimit", "value": "10" }, { "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": "all" }, { "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 (must be used with pagesize). When q is present, this is always forced to 1.", "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": "246522e4-f8a2-4970-a917-ce9d28c36f9e", "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": "10be659c-e056-465a-8f1a-3ae138c51e3d", "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": "2b86b78a-3ba6-43ab-a2f8-347cdf17b0ca", "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": "70ea23ba-d19c-404a-ac05-5676e33d9a22", "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": "0a9a535c-c2fa-41e9-8703-7d4bbb257c7b", "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": "4f61ea60-5fc8-481a-bbe6-f5b62a5e2b0a", "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": "0f79e20f-eb14-4da9-8dc8-43e1f6e92b53", "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": "7219bb78-308a-42a0-8c0c-c2664b75b7a8", "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": "54f9c5c1-45ac-4fd9-9fe1-dd821285689b", "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": "47bf63b4-dee7-4f3e-8d1e-59d5dbba278d", "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": "53f3b971-4b4a-4c9a-a522-dfec515b1225", "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": "8ddcae4c-d18b-4f89-b64d-e4c495396ec7", "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": "f1ba1bae-227e-43ac-ac2b-2a55cc7e13ba", "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": "e89faa58-3221-446e-8c51-76721f1db8aa", "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": "bdd511d3-7b1a-4e35-9de8-257ad85a60a5", "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": "b564db4f-688c-4c2b-b673-4d52e46d1cfa", "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": "b2b9e651-1d1f-4b03-9f0a-d247f140b8a5", "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": "387ad87e-5a51-4f6f-a3df-23ea54f5ae6e", "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": "a8f60724-cc40-43b8-bf98-cb276a8d54e1", "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": "664c5614-5711-404f-bee9-b1a20c83c607", "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": "c74c63b6-f4ce-433e-82eb-22d47ab648b9", "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": "164efce2-9e3b-481e-b8fc-20dfd1546363", "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": "81414a29-c7c2-4c20-a285-93bab859193d", "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": "2b7102bc-5441-4db0-9781-6e363c4bded8", "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": "fda41cbd-98a3-47ff-ab04-f3b525ef2a82", "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": "18058b66-7757-4d8c-87fa-2f8b76b1e90b", "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": "46edba9f-dd52-4aee-afa8-d159c4d6cea1", "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": "7f592a32-d75b-491c-9351-f103f52b87c2", "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": "0c25edcf-2df3-4176-a91b-d4fc4a2d3e85", "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": "b129a30f-17f8-41c2-921b-f0bd0ccda441", "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": "edd16f4f-b918-4712-873d-a53c4334b9fa", "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": "358093b3-6db9-4fc2-86dd-1b7f4bb7a355", "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": "4e675fca-d1ee-4919-8485-33f31a79c5d1", "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": "b882dff6-ade7-4f61-be05-51544c7516e9", "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": "8fe73a6b-9d7f-4ed1-a846-097dfad8a57a", "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": "03896cf3-240a-474d-a7e8-3f993c12692c", "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": "db61d368-c385-476a-a2fd-3b23c7dd2e06", "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": "c8d15bb5-d133-4b9b-b383-ae49244bd79e", "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": "33ee4144-2cfa-463e-9a23-3bfa21485908", "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": "8d44729e-cb9d-40e6-9398-39e024bd2f1c", "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": "648421c0-00fc-4dec-81e6-7d706608adb2", "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": "797232e0-953e-41bb-9aac-8bf7b9dd49a4", "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": "9fdf65ce-bec1-4dea-91fa-d7625a931706", "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": "cc9d1d55-875c-483d-8fee-bacfe75117d4", "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": "4ef740c7-58ea-48c0-bc91-7f9428aac7ce", "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": "cfdc731a-fa1a-434e-967a-f7fde1df9475", "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": "520c6c80-ff77-4564-b9b1-dc02225e61f6", "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": "4d726785-f87e-4934-bf61-482c7014b815", "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": "3b22106a-cc5b-4eda-a591-1eb14e6d8e94", "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": "1f937537-8568-494a-ad44-8134a3b82c12", "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": "12ae067a-3e0a-49ee-a3ca-e30db63e4117", "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": "59664bc6-a598-4a07-be62-1d7fdab1e33b", "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": "9bc54375-1dc6-4bda-9696-764bbfd85458", "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": "a7397272-e5a5-47dd-981e-08307b3518d6", "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": "bebc5313-1d33-478a-af03-a9bd6bda921d", "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": "365afbcd-be2a-425d-976f-9816e9c30790", "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": "82f3f686-e22a-49d3-a491-2a5af2203095", "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": "fc71781e-a1d2-4a67-8b0f-9a1ca281bda7", "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": "b136b705-8b99-4342-96a4-45afd95f1c08", "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": "8af7408d-2f9d-436e-bc6c-a291b26c3859", "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": "7adbf818-ff00-4579-a1b0-c283046f7617", "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": "75a5b844-8bb3-4d22-9991-3645deb142c8", "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": "ad8643f5-ac15-4245-ac47-167b8e78e7b0", "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": "b114a84b-6efc-4bc3-9b03-baf7740c2509", "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": "47c53088-4ba6-40a5-a3f3-930a6446dcdb", "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": "e0fc646c-1bc9-4e3b-9929-dc0d19c449b8", "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": "6f85a9d1-b992-4f29-a899-273589ff21d9", "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": "2872954f-a9c1-4221-880a-27e5f5f81b73", "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": "bb1e9c25-c884-4a5f-b39e-4c1f15de65f7", "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": "6c4580ab-48e8-422b-8df7-e3bba0c21753", "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": "b28e1cc5-9e2b-418d-8f09-9d67ffd421b6", "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": "26a6c263-431d-42ef-8b3c-b100c5cd8dd5", "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 \"da