{"items":[{"type":"link","label":"Parallax Api","link":"/api-documentation/swagger","routeSlug":"/api-documentation/swagger","content":{"contentType":"overview","meta":{"name":"Parallax Api"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"swagger.json","url":"/_bundle/API Documentation/swagger.json?download"},{"kind":"download","label":"swagger.yaml","url":"/_bundle/API Documentation/swagger.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Proprietary","url":"https://www.getparallax.com/terms-of-use"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Parallax Api (v1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[]}],"sectionId":"/api-documentation/swagger"}],"sectionId":"/api-documentation/swagger"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/overview"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overview"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access to the Parallax API is available exclusively to Parallax API customers. To learn more about becoming a Parallax API customer, please reach out to your Customer Success Manager."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All Parallax API calls are made under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.getparallax.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and all responses return standard JSON. The following HTTP methods are supported:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PATCH"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DELETE"},"children":[]}]}]}]}]}],"sectionId":"/api-documentation/swagger/section/overview"}]}]}},{"type":"link","label":"Overview","link":"/api-documentation/swagger/section/overview","routeSlug":"/api-documentation/swagger/section/overview","content":null},{"type":"separator","label":"Guides","content":null},{"type":"group","label":"Using Endpoints","link":"/api-documentation/swagger/using-endpoints","routeSlug":"/api-documentation/swagger/using-endpoints","items":[{"type":"link","label":"Authentication","link":"/api-documentation/swagger/using-endpoints/authentication","routeSlug":"/api-documentation/swagger/using-endpoints/authentication","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Authentication"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"using-endpoints/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API can be accessed by creating a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://app.getparallax.com/settings/personal-access-tokens"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Parallax application."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal Access Tokens, once generated, will need to be copied and saved somewhere safe. You will not be able to see the Personal Access Token again after generating. In the event you forget to copy/lose the token, you'll need to create a new one."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once generated, Personal Access Tokens can be sent in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-API-KEY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Each request will require the Personal Access Token to access the API."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We had formerly documented "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here, but we will reserve that for future use with OAuth/JWTs. Please use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-API-KEY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for Personal Access Tokens."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Authentication Example","link":"/api-documentation/swagger/using-endpoints/authentication-example","routeSlug":"/api-documentation/swagger/using-endpoints/authentication-example","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Authentication Example"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"using-endpoints/authentication-example"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication Example"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -H \"X-API-KEY: $ACCESS_TOKEN\" \\\n     https://api.getparallax.com/v1/projects\n","language":"curl"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -H \"X-API-KEY: $ACCESS_TOKEN\" \\\n     https://api.getparallax.com/v1/projects\n"},"children":[]}]}]}],"panels":[]}]}},{"type":"link","label":"Rate Limiting","link":"/api-documentation/swagger/using-endpoints/rate-limiting","routeSlug":"/api-documentation/swagger/using-endpoints/rate-limiting","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Rate Limiting"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"using-endpoints/rate-limiting"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Limiting"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parallax enforces rate limits to ensure reliability and fair usage. We maintain the flexibility to adjust the limitations as needed, ensuring they are always set high enough to support the proper functioning of a well-behaved interactive program."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parallax API uses a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fixed Window strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", allowing a limited number of requests within a defined time window "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"per user"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If this limit is exceeded, the API will return a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429 Too Many Requests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response, along with a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header indicating when it's safe to retry."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Limit set to 100 requests within a 60 second window"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We recommend clients respect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and implement exponential backoff or retry logic accordingly."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Pagination","link":"/api-documentation/swagger/using-endpoints/pagination","routeSlug":"/api-documentation/swagger/using-endpoints/pagination","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Pagination"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"using-endpoints/pagination"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To standardize and simplify data retrieval across listing endpoints, we implement a consistent pagination strategy that includes request parameters, response structure, and default behavior."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Request Parameters","link":"/api-documentation/swagger/using-endpoints/request-parameters","routeSlug":"/api-documentation/swagger/using-endpoints/request-parameters","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Request Parameters"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"using-endpoints/request-parameters"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request Parameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All list endpoints accept the following "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"query parameters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Constraints"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page number to retrieve"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be ≥ 1"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of items per page"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be ≥ 1 and ≤ 500"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default values:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"GET /v1/clients?page=2&pageSize=10\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GET /v1/clients?page=2&pageSize=10\n"},"children":[]}]}]}],"panels":[]}]}},{"type":"link","label":"Response Structure","link":"/api-documentation/swagger/using-endpoints/response-structure","routeSlug":"/api-documentation/swagger/using-endpoints/response-structure","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Response Structure"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"using-endpoints/response-structure"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Structure"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Responses from paginated endpoints include a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paging"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object with metadata, and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array with the items for the current page."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Example JSON Response","link":"/api-documentation/swagger/using-endpoints/example-json-response","routeSlug":"/api-documentation/swagger/using-endpoints/example-json-response","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Example JSON Response"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"using-endpoints/example-json-response"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example JSON Response"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"count\": 1,\n  \"total\": 151,\n  \"page\": 16,\n  \"total_pages\": 16,\n  \"page_size\": 10,\n  \"results\": [\n    {\n      \"id\": \"497f6eca-6276-4993-bfeb-53cbbbba6f08\",\n      \"name\": \"string\",\n      \"is_archived\": true,\n      \"created_date\": \"2019-08-24T14:15:22Z\",\n      \"modified_date\": \"2019-08-24T14:15:22Z\"\n    }\n  ]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"count\": 1,\n  \"total\": 151,\n  \"page\": 16,\n  \"total_pages\": 16,\n  \"page_size\": 10,\n  \"results\": [\n    {\n      \"id\": \"497f6eca-6276-4993-bfeb-53cbbbba6f08\",\n      \"name\": \"string\",\n      \"is_archived\": true,\n      \"created_date\": \"2019-08-24T14:15:22Z\",\n      \"modified_date\": \"2019-08-24T14:15:22Z\"\n    }\n  ]\n}\n"},"children":[]}]}]}],"panels":[]}]}},{"type":"link","label":"Response Properties","link":"/api-documentation/swagger/using-endpoints/response-properties","routeSlug":"/api-documentation/swagger/using-endpoints/response-properties","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Response Properties"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"using-endpoints/response-properties"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Properties"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Property"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"count"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of elements returned on the current page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total number of elements across all pages"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current page number"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page_size"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of elements per page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total_pages"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total number of pages available based on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array<T>"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of paged results of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"T"},"children":[]}]}]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"URL Encoding","link":"/api-documentation/swagger/using-endpoints/url-encoding","routeSlug":"/api-documentation/swagger/using-endpoints/url-encoding","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"URL Encoding"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"using-endpoints/url-encoding"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL Encoding"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When an external ID is used as a path parameter (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE /v1/projects/{id}/external-ids/{externalId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the value must be "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"percent-encoded"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Most HTTP clients handle this automatically."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"DELETE /v1/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/external-ids/hubspot%3A12345\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELETE /v1/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/external-ids/hubspot%3A12345\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" External IDs containing a forward slash ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") are not supported, as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%2F"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in URL path segments is rejected by the server."},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Error Codes","link":"/api-documentation/swagger/using-endpoints/error-codes","routeSlug":"/api-documentation/swagger/using-endpoints/error-codes","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Error Codes"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"using-endpoints/error-codes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error Codes"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unless otherwise specified, endpoints follow these standard error responses:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status Code"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request (validation errors)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Found"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conflict (business rule failed)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable Entity (process validation)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal Server Error"},"children":[]}]}]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Error Response Examples","link":"/api-documentation/swagger/using-endpoints/error-response-examples","routeSlug":"/api-documentation/swagger/using-endpoints/error-response-examples","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Error Response Examples"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"using-endpoints/error-response-examples"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error Response Examples"},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"400 Bad Request","link":"/api-documentation/swagger/using-endpoints/400-bad-request","routeSlug":"/api-documentation/swagger/using-endpoints/400-bad-request","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"400 Bad Request"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":5,"id":"using-endpoints/400-bad-request"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400 Bad Request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — validation failure"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"HTTP/1.1 400 Bad Request\nContent-Type: application/json\n\n{\n  \"errors\": {\n     \"Name\": [\n        \"The 'name' field is required.\",\n     ]\n  },\n  \"type\": \"https://tools.ietf.org/html/rfc9110#section-15.5.1\",\n  \"title\": \"One or more validation errors occurred.\",\n  \"status\": 400\n}\n","language":"http"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"HTTP/1.1 400 Bad Request\nContent-Type: application/json\n\n{\n  \"errors\": {\n     \"Name\": [\n        \"The 'name' field is required.\",\n     ]\n  },\n  \"type\": \"https://tools.ietf.org/html/rfc9110#section-15.5.1\",\n  \"title\": \"One or more validation errors occurred.\",\n  \"status\": 400\n}\n"},"children":[]}]}]}],"panels":[]}]}},{"type":"link","label":"409 Conflict","link":"/api-documentation/swagger/using-endpoints/409-conflict","routeSlug":"/api-documentation/swagger/using-endpoints/409-conflict","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"409 Conflict"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":5,"id":"using-endpoints/409-conflict"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409 Conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — business rule violation"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"HTTP/1.1 409 Conflict\nContent-Type: application/json\n\n{\n  \"type\": \"https://url-to-error/type/description\",\n  \"title\": \"Conflict\",\n  \"status\": 409,\n  \"detail\": \"something exists with this name\"\n}\n","language":"http"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"HTTP/1.1 409 Conflict\nContent-Type: application/json\n\n{\n  \"type\": \"https://url-to-error/type/description\",\n  \"title\": \"Conflict\",\n  \"status\": 409,\n  \"detail\": \"something exists with this name\"\n}\n"},"children":[]}]}]}],"panels":[]}]}},{"type":"link","label":"422 Unprocessable Entity","link":"/api-documentation/swagger/using-endpoints/422-unprocessable-entity","routeSlug":"/api-documentation/swagger/using-endpoints/422-unprocessable-entity","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"422 Unprocessable Entity"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":5,"id":"using-endpoints/422-unprocessable-entity"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422 Unprocessable Entity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — business process failure"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"HTTP/1.1 422 Unprocessable Entity\nContent-Type: application/json\n\n{\n  \"type\": \"https://url-to-error/type/description\",\n  \"title\": \"Unprocessable Entity\",\n  \"status\": 422,\n  \"detail\": \"Unable to assign a user to a role that does not exist for this organization.\"\n}\n","language":"http"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"HTTP/1.1 422 Unprocessable Entity\nContent-Type: application/json\n\n{\n  \"type\": \"https://url-to-error/type/description\",\n  \"title\": \"Unprocessable Entity\",\n  \"status\": 422,\n  \"detail\": \"Unable to assign a user to a role that does not exist for this organization.\"\n}\n"},"children":[]}]}]}],"panels":[]}]}},{"type":"link","label":"429 Too Many Requests","link":"/api-documentation/swagger/using-endpoints/429-too-many-requests","routeSlug":"/api-documentation/swagger/using-endpoints/429-too-many-requests","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"429 Too Many Requests"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":5,"id":"using-endpoints/429-too-many-requests"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429 Too Many Requests"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — rate limit error"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"HTTP/1.1 429 Too Many Requests\nRetry-After: 60\nContent-Type: application/json\n\n{\n  \"error\": \"Rate limit exceeded. Please try again in 60 seconds.\"\n}\n","language":"http"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"HTTP/1.1 429 Too Many Requests\nRetry-After: 60\nContent-Type: application/json\n\n{\n  \"error\": \"Rate limit exceeded. Please try again in 60 seconds.\"\n}\n"},"children":[]}]}]}],"panels":[]}]}},{"type":"link","label":"500 Internal Server Error","link":"/api-documentation/swagger/using-endpoints/500-internal-server-error","routeSlug":"/api-documentation/swagger/using-endpoints/500-internal-server-error","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"500 Internal Server Error"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":5,"id":"using-endpoints/500-internal-server-error"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500 Internal Server Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — unexpected crash"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"HTTP/1.1 500 Internal Server Error\nContent-Type: application/json\n\n{\n  \"title\": \"Internal Server Error\",\n  \"status\": 500,\n  \"detail\": \"An unexpected error occurred. Please try again later.\"\n}\n","language":"http"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"HTTP/1.1 500 Internal Server Error\nContent-Type: application/json\n\n{\n  \"title\": \"Internal Server Error\",\n  \"status\": 500,\n  \"detail\": \"An unexpected error occurred. Please try again later.\"\n}\n"},"children":[]}]}]}],"panels":[]}]}}],"content":{"contentType":"group","meta":{"name":"Using Endpoints"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Using Endpoints","showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/using-endpoints"}],"panels":[]}]}},{"type":"group","label":"Webhooks","link":"/api-documentation/swagger/webhooks","routeSlug":"/api-documentation/swagger/webhooks","items":[{"type":"link","label":"Overview","link":"/api-documentation/swagger/webhooks/overview","routeSlug":"/api-documentation/swagger/webhooks/overview","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Overview"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks/overview"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overview"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks allow your application to receive real-time HTTP notifications when events occur in Parallax. Instead of polling the API for changes, webhooks push"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data to your endpoint as soon as events happen."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you subscribe to a webhook topic, Parallax sends an HTTP POST request to your configured callback URL whenever a matching event occurs. Each request"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"includes a cryptographic signature so you can verify it originated from Parallax."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Setting Up Webhooks","link":"/api-documentation/swagger/webhooks/setting-up-webhooks","routeSlug":"/api-documentation/swagger/webhooks/setting-up-webhooks","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Setting Up Webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks/setting-up-webhooks"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Setting Up Webhooks"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To receive webhooks, you need to create a webhook subscriber and subscribe to the topics you're interested in. See"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/v1/webhook-subscribers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook Subscribers API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for complete endpoint documentation."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Step 1: Create a Webhook Subscriber","link":"/api-documentation/swagger/webhooks/step-1:-create-a-webhook-subscriber","routeSlug":"/api-documentation/swagger/webhooks/step-1:-create-a-webhook-subscriber","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Step 1: Create a Webhook Subscriber"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"webhooks/step-1:-create-a-webhook-subscriber"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step 1: Create a Webhook Subscriber"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send a POST request to create your webhook configuration:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"POST /v1/webhook-subscribers\nContent-Type: application/json\nX-API-KEY: your-api-key\n\n{\n  \"callbackUrl\": \"https://your-server.com/webhooks/parallax\",\n  \"active\": true\n}\n","language":"http"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST /v1/webhook-subscribers\nContent-Type: application/json\nX-API-KEY: your-api-key\n\n{\n  \"callbackUrl\": \"https://your-server.com/webhooks/parallax\",\n  \"active\": true\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response includes a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"secret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that you'll use to verify webhook signatures. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Store this secret securely"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"—it won't be shown again."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n    \"id\": \"497f6eca-6276-4993-bfeb-53cbbbba6f08\",\n    \"callbackUrl\": \"https://your-server.com/webhooks/parallax\",\n    \"secret\": \"your-webhook-secret\",\n    \"active\": true,\n    \"createdDate\": \"2025-01-01T00:00:00Z\",\n    \"modifiedDate\": \"2025-01-01T00:00:00Z\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n    \"id\": \"497f6eca-6276-4993-bfeb-53cbbbba6f08\",\n    \"callbackUrl\": \"https://your-server.com/webhooks/parallax\",\n    \"secret\": \"your-webhook-secret\",\n    \"active\": true,\n    \"createdDate\": \"2025-01-01T00:00:00Z\",\n    \"modifiedDate\": \"2025-01-01T00:00:00Z\"\n}\n"},"children":[]}]}]}],"panels":[]}]}},{"type":"link","label":"Step 2: Subscribe to Topics","link":"/api-documentation/swagger/webhooks/step-2:-subscribe-to-topics","routeSlug":"/api-documentation/swagger/webhooks/step-2:-subscribe-to-topics","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Step 2: Subscribe to Topics"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"webhooks/step-2:-subscribe-to-topics"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step 2: Subscribe to Topics"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscribe to the event topics you want to receive:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"POST /v1/webhook-subscribers/{id}/subscriptions\nContent-Type: application/json\nX-API-KEY: your-api-key\n\n{\n  \"topic\": \"project.created\"\n}\n","language":"http"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST /v1/webhook-subscribers/{id}/subscriptions\nContent-Type: application/json\nX-API-KEY: your-api-key\n\n{\n  \"topic\": \"project.created\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Repeat this for each topic you want to monitor."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Verifying Webhook Signatures","link":"/api-documentation/swagger/webhooks/verifying-webhook-signatures","routeSlug":"/api-documentation/swagger/webhooks/verifying-webhook-signatures","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Verifying Webhook Signatures"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks/verifying-webhook-signatures"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verifying Webhook Signatures"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every webhook request includes cryptographic headers that let you verify the request came from Parallax and hasn't been tampered with."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Headers","link":"/api-documentation/swagger/webhooks/headers","routeSlug":"/api-documentation/swagger/webhooks/headers","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Headers"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"webhooks/headers"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Headers"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Header"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Parallax-Signature"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HMAC-SHA256 signature of the payload, prefixed with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sha256="},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Parallax-Timestamp"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unix timestamp (seconds) when the signature was computed"},"children":[]}]}]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Verification Steps","link":"/api-documentation/swagger/webhooks/verification-steps","routeSlug":"/api-documentation/swagger/webhooks/verification-steps","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Verification Steps"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"webhooks/verification-steps"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verification Steps"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Extract the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Parallax-Signature"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Parallax-Timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read the raw request body (the JSON payload)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Concatenate the timestamp and body: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{timestamp}.{body}"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Compute HMAC-SHA256 of this string using your webhook secret"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Compare your computed signature to the received signature"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify the timestamp is recent (within ~10 minutes) to prevent replay attacks"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Regarding replay attacks: Parallax signs the request payload once. The same signature will be used in retries, if applicable."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Webhook Payload Format","link":"/api-documentation/swagger/webhooks/webhook-payload-format","routeSlug":"/api-documentation/swagger/webhooks/webhook-payload-format","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Webhook Payload Format"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks/webhook-payload-format"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook Payload Format"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All webhooks use a consistent envelope structure:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n    \"Payload\": {\n        \"Id\": \"497f6eca-6276-4993-bfeb-53cbbbba6f08\"\n    },\n    \"Topic\": \"project.created\",\n    \"CorrelationId\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n    \"EventOccurredOn\": \"2025-01-01T12:00:00Z\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n    \"Payload\": {\n        \"Id\": \"497f6eca-6276-4993-bfeb-53cbbbba6f08\"\n    },\n    \"Topic\": \"project.created\",\n    \"CorrelationId\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n    \"EventOccurredOn\": \"2025-01-01T12:00:00Z\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payload"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event-specific data (varies by topic)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Topic"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The event type (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"project.created"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CorrelationId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier for this event delivery"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EventOccurredOn"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8601 timestamp when the event occurred"},"children":[]}]}]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Available Webhook Events","link":"/api-documentation/swagger/webhooks/available-webhook-events","routeSlug":"/api-documentation/swagger/webhooks/available-webhook-events","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Available Webhook Events"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks/available-webhook-events"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available Webhook Events"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Topic"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payload Fields"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ModifiedProperties Values"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A person was created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"—"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person.modified"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A person was modified"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ModifiedProperties"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"given_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"family_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email_address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"capacity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"role_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billable_utilization_target"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"worker_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"project.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A project was created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"—"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"project.modified"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A project was modified"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ModifiedProperties"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_included"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"project_model"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"target_budget"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"target_margin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stage_id"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"projectoffering.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A project offering was created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProjectId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"—"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"projectoffering.modified"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A project offering was modified"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProjectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ModifiedProperties"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_card_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billing_model"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fee_schedule"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"projectoffering.deleted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A project offering was deleted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProjectId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"—"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"projectofferingrole.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A project offering role was created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProjectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProjectOfferingId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"—"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"projectofferingrole.modified"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A project offering role was modified"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProjectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProjectOfferingId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ModifiedProperties"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"role_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"assignment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tags"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"projectofferingrole.deleted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A project offering role was deleted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProjectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProjectOfferingId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"—"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".modified"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" events, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ModifiedProperties"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array indicates which fields changed. Use this to understand what data elements changed, and whether you wish"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to call the API to retrieve the updated values.."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Best Practices","link":"/api-documentation/swagger/webhooks/best-practices","routeSlug":"/api-documentation/swagger/webhooks/best-practices","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Best Practices"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks/best-practices"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Best Practices"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always verify signatures"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before processing webhook data to ensure requests are authentic"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Implement replay protection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by checking that the timestamp is recent"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use constant-time comparison"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when comparing signatures to prevent timing attacks"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Respond quickly"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a 2xx status code, then process the webhook asynchronously if needed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Handle retries idempotently"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CorrelationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to detect duplicate deliveries"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use HTTPS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for your callback URL to protect webhook data in transit"},"children":[]}]}]}]}]}],"panels":[]}]}}],"content":{"contentType":"group","meta":{"name":"Webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhooks","showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks"}],"panels":[]}]}},{"type":"separator","label":"Endpoints","content":null},{"type":"group","label":"ActualTime","link":"/api-documentation/swagger/actualtime","routeSlug":"/api-documentation/swagger/actualtime","items":[{"label":"List Actual Time","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/actualtime/listactualtime","routeSlug":"/api-documentation/swagger/actualtime/listactualtime","metadata":{"seo":{"title":"List Actual Time","description":"Gets a paginated list of actual time entries with optional filtering by date range, project offering, and person. When no start or end date filters are provided, returns entries from the last 7 days (7 days ago through today)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListActualTime","name":"List Actual Time","isWebhook":false,"pointer":"/paths/~1v1~1actual-time/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Actual Time","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a paginated list of actual time entries with optional filtering by date range, project offering, and person. When no start or end date filters are provided, returns entries from the last 7 days (7 days ago through today)."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_66","description":"The specific page of results requested."},{"name":"page_size","in":"query","schemaId":"schema_67","description":"The number of results in each page."},{"name":"start_date","in":"query","schemaId":"schema_68","description":"Filter by entries recorded on or after this date. When not provided, defaults to 7 days ago from today. ISO date formatting expected (yyyy-MM-dd)"},{"name":"end_date","in":"query","schemaId":"schema_69","description":"Filter by entries recorded on or before this date. When not provided, defaults to today. ISO date formatting expected (yyyy-MM-dd)"},{"name":"project_offering_id","in":"query","schemaId":"schema_70","description":"The id of the project offering in which the actual time entry belongs to."},{"name":"person_id","in":"query","schemaId":"schema_71","description":"The id of the Person to which the actual time entry belongs."}],"pointer":"/paths/~1v1~1actual-time/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/actual-time","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"schema_66"},{"name":"page_size","in":"query","schemaId":"schema_67"},{"name":"start_date","in":"query","schemaId":"schema_68"},{"name":"end_date","in":"query","schemaId":"schema_69"},{"name":"project_offering_id","in":"query","schemaId":"schema_70"},{"name":"person_id","in":"query","schemaId":"schema_71"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/actual-time","href":"actualtime/listactualtime","openApiOperationId":"ListActualTime","summary":"List Actual Time"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActualTimeDtoPagedResultsDto"}},"schemaId":"components/schemas/ActualTimeDtoPagedResultsDto"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1actual-time/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ActualTimeDtoPagedResultsDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActualTimeDtoPagedResultsDto"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/actualtime/listactualtime"}],"panels":[]}]},"httpPath":"/v1/actual-time"},{"label":"Create Actual Time","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/actualtime/createactualtime","routeSlug":"/api-documentation/swagger/actualtime/createactualtime","metadata":{"seo":{"title":"Create Actual Time","description":"Creates a new record representing hours a person has logged to a project, typically synced from the Timesheet System for tracking actuals against planned work. Parallax only allows a person to have a single role on a project offering, which means that the role is inferred by project_offering_id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateActualTime","name":"Create Actual Time","isWebhook":false,"pointer":"/paths/~1v1~1actual-time/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Actual Time","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new record representing hours a person has logged to a project, typically synced from the Timesheet System for tracking actuals against planned work. Parallax only allows a person to have a single role on a project offering, which means that the role is inferred by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"project_offering_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_72"},"application/json":{"schemaId":"schema_72"}},"schemaId":"schema_72","pointer":"/paths/~1v1~1actual-time/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/actual-time","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"schema_72"},"application/json":{"schemaId":"schema_72"}},"responseCodes":["201","400"],"pointer":"/v1/actual-time","href":"actualtime/createactualtime","openApiOperationId":"CreateActualTime","summary":"Create Actual Time"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"schemaId":"schema_72","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_72"},"application/json":{"schemaId":"schema_72"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActualTime"}},"schemaId":"components/schemas/ActualTime"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1actual-time/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/ActualTime","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActualTime"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/actualtime/createactualtime"}],"panels":[]}]},"httpPath":"/v1/actual-time"},{"label":"Delete Actual Time","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/actualtime/deleteactualtime","routeSlug":"/api-documentation/swagger/actualtime/deleteactualtime","metadata":{"seo":{"title":"Delete Actual Time","description":"Removes a recorded entry of hours worked from the system, typically used for error correction or cleanup."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteActualTime","name":"Delete Actual Time","isWebhook":false,"pointer":"/paths/~1v1~1actual-time~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Actual Time","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Removes a recorded entry of hours worked from the system, typically used for error correction or cleanup."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_73","description":"ID of the resource","required":true}],"pointer":"/paths/~1v1~1actual-time~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/actual-time/{id}","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_73"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204","400"],"pointer":"/v1/actual-time/{id}","href":"actualtime/deleteactualtime","openApiOperationId":"DeleteActualTime","summary":"Delete Actual Time"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1actual-time~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/actualtime/deleteactualtime"}],"panels":[]}]},"httpPath":"/v1/actual-time/{id}"},{"label":"Get Actual Time","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/actualtime/getactualtime","routeSlug":"/api-documentation/swagger/actualtime/getactualtime","metadata":{"seo":{"title":"Get Actual Time","description":"Fetches specified actual time details by id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetActualTime","name":"Get Actual Time","isWebhook":false,"pointer":"/paths/~1v1~1actual-time~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Actual Time","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches specified actual time details by id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_73","description":"ID of the resource","required":true}],"pointer":"/paths/~1v1~1actual-time~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/actual-time/{id}","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_73"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/actual-time/{id}","href":"actualtime/getactualtime","openApiOperationId":"GetActualTime","summary":"Get Actual Time"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActualTime"}},"schemaId":"components/schemas/ActualTime"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1actual-time~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ActualTime","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActualTime"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/actualtime/getactualtime"}],"panels":[]}]},"httpPath":"/v1/actual-time/{id}"},{"label":"Update Actual Time","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/actualtime/updateactualtime","routeSlug":"/api-documentation/swagger/actualtime/updateactualtime","metadata":{"seo":{"title":"Update Actual Time","description":"Updates an existing Actual Hours record, used to correct or adjust time entries for accuracy in utilization and variance tracking."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateActualTime","name":"Update Actual Time","isWebhook":false,"pointer":"/paths/~1v1~1actual-time~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Actual Time","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing Actual Hours record, used to correct or adjust time entries for accuracy in utilization and variance tracking."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_73","description":"ID of the resource","required":true}],"pointer":"/paths/~1v1~1actual-time~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_74"},"application/json":{"schemaId":"schema_74"}},"schemaId":"schema_74","pointer":"/paths/~1v1~1actual-time~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/actual-time/{id}","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_73"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"schema_74"},"application/json":{"schemaId":"schema_74"}},"responseCodes":["200","400"],"pointer":"/v1/actual-time/{id}","href":"actualtime/updateactualtime","openApiOperationId":"UpdateActualTime","summary":"Update Actual Time"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"schemaId":"schema_74","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_74"},"application/json":{"schemaId":"schema_74"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1actual-time~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/actualtime/updateactualtime"}],"panels":[]}]},"httpPath":"/v1/actual-time/{id}"}],"content":{"contentType":"group","meta":{"name":"ActualTime"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ActualTime","showPageActions":true},{"nodeType":"markdoc","content":"Actual Time represents the timesheet data capturing the work performed by employees and logged against assigned Project Offerings. Actual Time is used to compare planned vs. actual effort, drive utilization reporting, support variance analysis, and inform project health and forecasting across the platform."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/actual-time","summary":"List Actual Time","prefix":{"name":"get","color":"get"},"badges":[],"link":"/actualtime/listactualtime","deprecated":false},{"title":"/v1/actual-time","summary":"Create Actual Time","prefix":{"name":"post","color":"post"},"badges":[],"link":"/actualtime/createactualtime","deprecated":false},{"title":"/v1/actual-time/{id}","summary":"Delete Actual Time","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/actualtime/deleteactualtime","deprecated":false},{"title":"/v1/actual-time/{id}","summary":"Get Actual Time","prefix":{"name":"get","color":"get"},"badges":[],"link":"/actualtime/getactualtime","deprecated":false},{"title":"/v1/actual-time/{id}","summary":"Update Actual Time","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/actualtime/updateactualtime","deprecated":false}]}]}]}]}},{"type":"group","label":"ActualTimeOff","link":"/api-documentation/swagger/actualtimeoff","routeSlug":"/api-documentation/swagger/actualtimeoff","items":[{"label":"List Actual Time Off","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/actualtimeoff/listactualtimeoff","routeSlug":"/api-documentation/swagger/actualtimeoff/listactualtimeoff","metadata":{"seo":{"title":"List Actual Time Off","description":"Gets a paginated list of actual time off entries with optional filtering by date range and person. When no start or end date filters are provided, returns entries from the last 7 days (7 days ago through today)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListActualTimeOff","name":"List Actual Time Off","isWebhook":false,"pointer":"/paths/~1v1~1actual-time-off/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Actual Time Off","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a paginated list of actual time off entries with optional filtering by date range and person. When no start or end date filters are provided, returns entries from the last 7 days (7 days ago through today)."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_66","description":"The specific page of results requested."},{"name":"page_size","in":"query","schemaId":"schema_67","description":"The number of results in each page."},{"name":"person_id","in":"query","schemaId":"schema_75","description":"Filter results to a specific person."},{"name":"start_date","in":"query","schemaId":"schema_68","description":"Filter by entries recorded on or after this date. When not provided, defaults to 7 days ago from today. ISO date formatting expected (yyyy-MM-dd)"},{"name":"end_date","in":"query","schemaId":"schema_69","description":"Filter by entries recorded on or before this date. When not provided, defaults to today. ISO date formatting expected (yyyy-MM-dd)"}],"pointer":"/paths/~1v1~1actual-time-off/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/actual-time-off","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"schema_66"},{"name":"page_size","in":"query","schemaId":"schema_67"},{"name":"person_id","in":"query","schemaId":"schema_75"},{"name":"start_date","in":"query","schemaId":"schema_68"},{"name":"end_date","in":"query","schemaId":"schema_69"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/actual-time-off","href":"actualtimeoff/listactualtimeoff","openApiOperationId":"ListActualTimeOff","summary":"List Actual Time Off"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActualTimeOffDtoPagedResultsDto"}},"schemaId":"components/schemas/ActualTimeOffDtoPagedResultsDto"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1actual-time-off/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ActualTimeOffDtoPagedResultsDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActualTimeOffDtoPagedResultsDto"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/actualtimeoff/listactualtimeoff"}],"panels":[]}]},"httpPath":"/v1/actual-time-off"},{"label":"Create Actual Time Off","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/actualtimeoff/createactualtimeoff","routeSlug":"/api-documentation/swagger/actualtimeoff/createactualtimeoff","metadata":{"seo":{"title":"Create Actual Time Off","description":"Creates a new actual time off record for an employee. Multiple entries for the same person on the same date are permitted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateActualTimeOff","name":"Create Actual Time Off","isWebhook":false,"pointer":"/paths/~1v1~1actual-time-off/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Actual Time Off","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new actual time off record for an employee. Multiple entries for the same person on the same date are permitted."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_76"},"application/json":{"schemaId":"schema_76"}},"schemaId":"schema_76","pointer":"/paths/~1v1~1actual-time-off/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/actual-time-off","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"schema_76"},"application/json":{"schemaId":"schema_76"}},"responseCodes":["201","400"],"pointer":"/v1/actual-time-off","href":"actualtimeoff/createactualtimeoff","openApiOperationId":"CreateActualTimeOff","summary":"Create Actual Time Off"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"schemaId":"schema_76","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_76"},"application/json":{"schemaId":"schema_76"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActualTimeOff"}},"schemaId":"components/schemas/ActualTimeOff"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1actual-time-off/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/ActualTimeOff","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActualTimeOff"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/actualtimeoff/createactualtimeoff"}],"panels":[]}]},"httpPath":"/v1/actual-time-off"},{"label":"Delete Actual Time Off","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/actualtimeoff/deleteactualtimeoff","routeSlug":"/api-documentation/swagger/actualtimeoff/deleteactualtimeoff","metadata":{"seo":{"title":"Delete Actual Time Off","description":"Deletes an actual time off record by id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteActualTimeOff","name":"Delete Actual Time Off","isWebhook":false,"pointer":"/paths/~1v1~1actual-time-off~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Actual Time Off","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes an actual time off record by id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_73","description":"ID of the resource","required":true}],"pointer":"/paths/~1v1~1actual-time-off~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/actual-time-off/{id}","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_73"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204","400"],"pointer":"/v1/actual-time-off/{id}","href":"actualtimeoff/deleteactualtimeoff","openApiOperationId":"DeleteActualTimeOff","summary":"Delete Actual Time Off"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1actual-time-off~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/actualtimeoff/deleteactualtimeoff"}],"panels":[]}]},"httpPath":"/v1/actual-time-off/{id}"},{"label":"Get Actual Time Off","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/actualtimeoff/getactualtimeoff","routeSlug":"/api-documentation/swagger/actualtimeoff/getactualtimeoff","metadata":{"seo":{"title":"Get Actual Time Off","description":"Fetches an actual time off record by id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetActualTimeOff","name":"Get Actual Time Off","isWebhook":false,"pointer":"/paths/~1v1~1actual-time-off~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Actual Time Off","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches an actual time off record by id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_73","description":"ID of the resource","required":true}],"pointer":"/paths/~1v1~1actual-time-off~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/actual-time-off/{id}","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_73"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/actual-time-off/{id}","href":"actualtimeoff/getactualtimeoff","openApiOperationId":"GetActualTimeOff","summary":"Get Actual Time Off"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActualTimeOff"}},"schemaId":"components/schemas/ActualTimeOff"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1actual-time-off~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ActualTimeOff","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActualTimeOff"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/actualtimeoff/getactualtimeoff"}],"panels":[]}]},"httpPath":"/v1/actual-time-off/{id}"},{"label":"Update Actual Time Off","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/actualtimeoff/updateactualtimeoff","routeSlug":"/api-documentation/swagger/actualtimeoff/updateactualtimeoff","metadata":{"seo":{"title":"Update Actual Time Off","description":"Updates an existing actual time off record. Only supplied fields are changed. Sending null for description clears the value; omitting description leaves it unchanged."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateActualTimeOff","name":"Update Actual Time Off","isWebhook":false,"pointer":"/paths/~1v1~1actual-time-off~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Actual Time Off","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing actual time off record. Only supplied fields are changed. Sending null for description clears the value; omitting description leaves it unchanged."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_73","description":"ID of the resource","required":true}],"pointer":"/paths/~1v1~1actual-time-off~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_77"},"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77","pointer":"/paths/~1v1~1actual-time-off~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/actual-time-off/{id}","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_73"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"schema_77"},"application/json":{"schemaId":"schema_77"}},"responseCodes":["200","400"],"pointer":"/v1/actual-time-off/{id}","href":"actualtimeoff/updateactualtimeoff","openApiOperationId":"UpdateActualTimeOff","summary":"Update Actual Time Off"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"schemaId":"schema_77","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_77"},"application/json":{"schemaId":"schema_77"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1actual-time-off~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/actualtimeoff/updateactualtimeoff"}],"panels":[]}]},"httpPath":"/v1/actual-time-off/{id}"}],"content":{"contentType":"group","meta":{"name":"ActualTimeOff"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ActualTimeOff","showPageActions":true},{"nodeType":"markdoc","content":"Actual Time Off represents recorded time off entries for employees, capturing the date, duration, and category of time off taken. Use these endpoints to create, retrieve, update, and delete actual time off records."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/actual-time-off","summary":"List Actual Time Off","prefix":{"name":"get","color":"get"},"badges":[],"link":"/actualtimeoff/listactualtimeoff","deprecated":false},{"title":"/v1/actual-time-off","summary":"Create Actual Time Off","prefix":{"name":"post","color":"post"},"badges":[],"link":"/actualtimeoff/createactualtimeoff","deprecated":false},{"title":"/v1/actual-time-off/{id}","summary":"Delete Actual Time Off","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/actualtimeoff/deleteactualtimeoff","deprecated":false},{"title":"/v1/actual-time-off/{id}","summary":"Get Actual Time Off","prefix":{"name":"get","color":"get"},"badges":[],"link":"/actualtimeoff/getactualtimeoff","deprecated":false},{"title":"/v1/actual-time-off/{id}","summary":"Update Actual Time Off","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/actualtimeoff/updateactualtimeoff","deprecated":false}]}]}]}]}},{"type":"group","label":"Clients","link":"/api-documentation/swagger/clients","routeSlug":"/api-documentation/swagger/clients","items":[{"label":"List Clients","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/clients/listclients","routeSlug":"/api-documentation/swagger/clients/listclients","metadata":{"seo":{"title":"List Clients","description":"Gets a paginated list of client organizations tracked in the system, supporting filtering and searching for project association and reporting."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListClients","name":"List Clients","isWebhook":false,"pointer":"/paths/~1v1~1clients/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Clients","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a paginated list of client organizations tracked in the system, supporting filtering and searching for project association and reporting."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_66","description":"The specific page of results requested."},{"name":"page_size","in":"query","schemaId":"schema_67","description":"The number of results in each page."},{"name":"archived","in":"query","schemaId":"schema_78","description":"Indicates if results should be filtered by their archived status."}],"pointer":"/paths/~1v1~1clients/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clients","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"schema_66"},{"name":"page_size","in":"query","schemaId":"schema_67"},{"name":"archived","in":"query","schemaId":"schema_78"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/clients","href":"clients/listclients","openApiOperationId":"ListClients","summary":"List Clients"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientDtoPagedResultsDto"}},"schemaId":"components/schemas/ClientDtoPagedResultsDto"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1clients/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ClientDtoPagedResultsDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientDtoPagedResultsDto"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clients/listclients"}],"panels":[]}]},"httpPath":"/v1/clients"},{"label":"Create Client","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/clients/createclient","routeSlug":"/api-documentation/swagger/clients/createclient","metadata":{"seo":{"title":"Create Client","description":"Creates a new client representing an organization that projects and revenue are associated with."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateClient","name":"Create Client","isWebhook":false,"pointer":"/paths/~1v1~1clients/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Client","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new client representing an organization that projects and revenue are associated with."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_79"},"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79","pointer":"/paths/~1v1~1clients/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clients","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"schema_79"},"application/json":{"schemaId":"schema_79"}},"responseCodes":["201","400"],"pointer":"/v1/clients","href":"clients/createclient","openApiOperationId":"CreateClient","summary":"Create Client"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"schemaId":"schema_79","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_79"},"application/json":{"schemaId":"schema_79"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Client"}},"schemaId":"components/schemas/Client"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1clients/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Client","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Client"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clients/createclient"}],"panels":[]}]},"httpPath":"/v1/clients"},{"label":"Get Client","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/clients/getclient","routeSlug":"/api-documentation/swagger/clients/getclient","metadata":{"seo":{"title":"Get Client","description":"Gets a specific client details by id, useful for project association and sales pipeline reporting."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetClient","name":"Get Client","isWebhook":false,"pointer":"/paths/~1v1~1clients~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Client","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a specific client details by id, useful for project association and sales pipeline reporting."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_73","description":"ID of the resource","required":true}],"pointer":"/paths/~1v1~1clients~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clients/{id}","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_73"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/clients/{id}","href":"clients/getclient","openApiOperationId":"GetClient","summary":"Get Client"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Client"}},"schemaId":"components/schemas/Client"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1clients~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Client","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Client"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clients/getclient"}],"panels":[]}]},"httpPath":"/v1/clients/{id}"},{"label":"Update Client","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/clients/updateclient","routeSlug":"/api-documentation/swagger/clients/updateclient","metadata":{"seo":{"title":"Update Client","description":"Modifies an existing client, updating details like name, account manager, or CRM identifiers."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateClient","name":"Update Client","isWebhook":false,"pointer":"/paths/~1v1~1clients~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Client","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Modifies an existing client, updating details like name, account manager, or CRM identifiers."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_73","description":"ID of the resource","required":true}],"pointer":"/paths/~1v1~1clients~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_80"},"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80","pointer":"/paths/~1v1~1clients~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/clients/{id}","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_73"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"schema_80"},"application/json":{"schemaId":"schema_80"}},"responseCodes":["200","400"],"pointer":"/v1/clients/{id}","href":"clients/updateclient","openApiOperationId":"UpdateClient","summary":"Update Client"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"schemaId":"schema_80","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_80"},"application/json":{"schemaId":"schema_80"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1clients~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clients/updateclient"}],"panels":[]}]},"httpPath":"/v1/clients/{id}"}],"content":{"contentType":"group","meta":{"name":"Clients"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Clients","showPageActions":true},{"nodeType":"markdoc","content":"A client represents the customer organization associated with one or more projects. Clients serve as the primary entity used to group projects, service offerings, and resource plans, allowing for aggregated reporting on revenue, margin, utilization, and forecasting. Each project is tied to a client, enabling organizations to track work and financial performance at both the individual project and client account levels."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/clients","summary":"List Clients","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clients/listclients","deprecated":false},{"title":"/v1/clients","summary":"Create Client","prefix":{"name":"post","color":"post"},"badges":[],"link":"/clients/createclient","deprecated":false},{"title":"/v1/clients/{id}","summary":"Get Client","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clients/getclient","deprecated":false},{"title":"/v1/clients/{id}","summary":"Update Client","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/clients/updateclient","deprecated":false}]}]}]}]}},{"type":"group","label":"Departments","link":"/api-documentation/swagger/departments","routeSlug":"/api-documentation/swagger/departments","items":[{"label":"List Departments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/departments/listdepartments","routeSlug":"/api-documentation/swagger/departments/listdepartments","metadata":{"seo":{"title":"List Departments","description":"Returns a paginated list of departments configured in the system, used to categorize people and roles for filtering and resourcing."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListDepartments","name":"List Departments","isWebhook":false,"pointer":"/paths/~1v1~1departments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Departments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of departments configured in the system, used to categorize people and roles for filtering and resourcing."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_66","description":"The specific page of results requested."},{"name":"page_size","in":"query","schemaId":"schema_67","description":"The number of results in each page."},{"name":"archived","in":"query","schemaId":"schema_78","description":"Indicates if results should be filtered by their archived status."}],"pointer":"/paths/~1v1~1departments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/departments","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"schema_66"},{"name":"page_size","in":"query","schemaId":"schema_67"},{"name":"archived","in":"query","schemaId":"schema_78"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/departments","href":"departments/listdepartments","openApiOperationId":"ListDepartments","summary":"List Departments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DepartmentDtoPagedResultsDto"}},"schemaId":"components/schemas/DepartmentDtoPagedResultsDto"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1departments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DepartmentDtoPagedResultsDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DepartmentDtoPagedResultsDto"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/departments/listdepartments"}],"panels":[]}]},"httpPath":"/v1/departments"},{"label":"Create Department","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/departments/createdepartment","routeSlug":"/api-documentation/swagger/departments/createdepartment","metadata":{"seo":{"title":"Create Department","description":"Creates a new Department to categorize roles within the organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateDepartment","name":"Create Department","isWebhook":false,"pointer":"/paths/~1v1~1departments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Department","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new Department to categorize roles within the organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_81"},"application/json":{"schemaId":"schema_81"}},"schemaId":"schema_81","pointer":"/paths/~1v1~1departments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/departments","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"schema_81"},"application/json":{"schemaId":"schema_81"}},"responseCodes":["201","400"],"pointer":"/v1/departments","href":"departments/createdepartment","openApiOperationId":"CreateDepartment","summary":"Create Department"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"schemaId":"schema_81","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_81"},"application/json":{"schemaId":"schema_81"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Department"}},"schemaId":"components/schemas/Department"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1departments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Department","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Department"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/departments/createdepartment"}],"panels":[]}]},"httpPath":"/v1/departments"},{"label":"Update Department","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/departments/updatedepartment","routeSlug":"/api-documentation/swagger/departments/updatedepartment","metadata":{"seo":{"title":"Update Department","description":"Updates an existing department's name or archived status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateDepartment","name":"Update Department","isWebhook":false,"pointer":"/paths/~1v1~1departments~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Department","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing department's name or archived status."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_73","description":"ID of the resource","required":true}],"pointer":"/paths/~1v1~1departments~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_82"},"application/json":{"schemaId":"schema_82"}},"schemaId":"schema_82","pointer":"/paths/~1v1~1departments~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/departments/{id}","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_73"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"schema_82"},"application/json":{"schemaId":"schema_82"}},"responseCodes":["200","400"],"pointer":"/v1/departments/{id}","href":"departments/updatedepartment","openApiOperationId":"UpdateDepartment","summary":"Update Department"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"schemaId":"schema_82","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_82"},"application/json":{"schemaId":"schema_82"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1departments~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/departments/updatedepartment"}],"panels":[]}]},"httpPath":"/v1/departments/{id}"}],"content":{"contentType":"group","meta":{"name":"Departments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Departments","showPageActions":true},{"nodeType":"markdoc","content":"A department is used to categorize and group roles within the organization based on functional teams or disciplines. Departments help segment resource capacity, manage utilization targets, and support filtering within reporting and planning workflows. Each role in Parallax belongs to a department for organizational clarity and capacity planning."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/departments","summary":"List Departments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/departments/listdepartments","deprecated":false},{"title":"/v1/departments","summary":"Create Department","prefix":{"name":"post","color":"post"},"badges":[],"link":"/departments/createdepartment","deprecated":false},{"title":"/v1/departments/{id}","summary":"Update Department","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/departments/updatedepartment","deprecated":false}]}]}]}]}},{"type":"group","label":"People","link":"/api-documentation/swagger/people","routeSlug":"/api-documentation/swagger/people","items":[{"label":"List People","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/people/listpeople","routeSlug":"/api-documentation/swagger/people/listpeople","metadata":{"seo":{"title":"List People","description":"Returns a paginated list of individuals in the system."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListPeople","name":"List People","isWebhook":false,"pointer":"/paths/~1v1~1people/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List People","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of individuals in the system."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"external_id","in":"query","schemaId":"schema_83","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by external ID. For Parallax-managed integrations, use the format 'px_provider:id' (e.g., 'px_hubspot:12345'). For custom integrations, use the string format appropriate for that integration."},"children":[]}]}]}]},{"name":"page","in":"query","schemaId":"schema_66","description":"The specific page of results requested."},{"name":"page_size","in":"query","schemaId":"schema_67","description":"The number of results in each page."},{"name":"archived","in":"query","schemaId":"schema_78","description":"Indicates if results should be filtered by their archived status."}],"pointer":"/paths/~1v1~1people/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/people","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[],"query":[{"name":"external_id","in":"query","schemaId":"schema_83"},{"name":"page","in":"query","schemaId":"schema_66"},{"name":"page_size","in":"query","schemaId":"schema_67"},{"name":"archived","in":"query","schemaId":"schema_78"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/people","href":"people/listpeople","openApiOperationId":"ListPeople","summary":"List People"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PersonDtoPagedResultsDto"}},"schemaId":"components/schemas/PersonDtoPagedResultsDto"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1people/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PersonDtoPagedResultsDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PersonDtoPagedResultsDto"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/people/listpeople"}],"panels":[]}]},"httpPath":"/v1/people"},{"label":"Create Person","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/people/createperson","routeSlug":"/api-documentation/swagger/people/createperson","metadata":{"seo":{"title":"Create Person","description":"Creates a profile for an individual within the organization, defining capacity, roles, and billable status for resourcing and forecasting."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreatePerson","name":"Create Person","isWebhook":false,"pointer":"/paths/~1v1~1people/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Person","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a profile for an individual within the organization, defining capacity, roles, and billable status for resourcing and forecasting."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_84"},"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84","pointer":"/paths/~1v1~1people/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/people","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"schema_84"},"application/json":{"schemaId":"schema_84"}},"responseCodes":["201","400"],"pointer":"/v1/people","href":"people/createperson","openApiOperationId":"CreatePerson","summary":"Create Person"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"schemaId":"schema_84","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_84"},"application/json":{"schemaId":"schema_84"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Person"}},"schemaId":"components/schemas/Person"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1people/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Person","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Person"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/people/createperson"}],"panels":[]}]},"httpPath":"/v1/people"},{"label":"Get Person","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/people/getperson","routeSlug":"/api-documentation/swagger/people/getperson","metadata":{"seo":{"title":"Get Person","description":"Fetches specified person's profile details by id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetPerson","name":"Get Person","isWebhook":false,"pointer":"/paths/~1v1~1people~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Person","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches specified person's profile details by id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_73","description":"ID of the resource","required":true}],"pointer":"/paths/~1v1~1people~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/people/{id}","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_73"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/people/{id}","href":"people/getperson","openApiOperationId":"GetPerson","summary":"Get Person"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Person"}},"schemaId":"components/schemas/Person"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1people~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Person","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Person"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/people/getperson"}],"panels":[]}]},"httpPath":"/v1/people/{id}"},{"label":"Update Person","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/people/updateperson","routeSlug":"/api-documentation/swagger/people/updateperson","metadata":{"seo":{"title":"Update Person","description":"Updates a person’s profile details such as capacity, cost rate, billing type, or termination date."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdatePerson","name":"Update Person","isWebhook":false,"pointer":"/paths/~1v1~1people~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Person","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates a person’s profile details such as capacity, cost rate, billing type, or termination date."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_73","description":"ID of the resource","required":true}],"pointer":"/paths/~1v1~1people~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_85"},"application/json":{"schemaId":"schema_85"}},"schemaId":"schema_85","pointer":"/paths/~1v1~1people~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/people/{id}","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_73"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"schema_85"},"application/json":{"schemaId":"schema_85"}},"responseCodes":["200","400"],"pointer":"/v1/people/{id}","href":"people/updateperson","openApiOperationId":"UpdatePerson","summary":"Update Person"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"schemaId":"schema_85","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_85"},"application/json":{"schemaId":"schema_85"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1people~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/people/updateperson"}],"panels":[]}]},"httpPath":"/v1/people/{id}"},{"label":"Add External ID","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/people/addpersonexternalid","routeSlug":"/api-documentation/swagger/people/addpersonexternalid","metadata":{"seo":{"title":"Add External ID","description":"Adds a custom integration external identifier to a Person. This can be any opaque string used to correlate the Person with a record in an external system. Strings starting with a reserved 'px_' provider prefix (e.g., 'px_hubspot:') are reserved for use by Parallax integrations and not allowed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AddPersonExternalId","name":"Add External ID","isWebhook":false,"pointer":"/paths/~1v1~1people~1{id}~1external-ids/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add External ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds a custom integration external identifier to a Person. This can be any opaque string used to correlate the Person with a record in an external system. Strings starting with a reserved 'px_' provider prefix (e.g., 'px_hubspot:') are reserved for use by Parallax integrations and not allowed."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_73","description":"ID of the resource","required":true}],"pointer":"/paths/~1v1~1people~1{id}~1external-ids/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_86"},"application/json":{"schemaId":"schema_86"}},"schemaId":"schema_86","pointer":"/paths/~1v1~1people~1{id}~1external-ids/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/people/{id}/external-ids","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_73"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"schema_86"},"application/json":{"schemaId":"schema_86"}},"responseCodes":["201","400"],"pointer":"/v1/people/{id}/external-ids","href":"people/addpersonexternalid","openApiOperationId":"AddPersonExternalId","summary":"Add External ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"schemaId":"schema_86","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_86"},"application/json":{"schemaId":"schema_86"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1people~1{id}~1external-ids/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/people/addpersonexternalid"}],"panels":[]}]},"httpPath":"/v1/people/{id}/external-ids"},{"label":"Remove External ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/people/removepersonexternalid","routeSlug":"/api-documentation/swagger/people/removepersonexternalid","metadata":{"seo":{"title":"Remove External ID","description":"Removes a custom integration external identifier from a Person."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RemovePersonExternalId","name":"Remove External ID","isWebhook":false,"pointer":"/paths/~1v1~1people~1{id}~1external-ids~1{external_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove External ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Removes a custom integration external identifier from a Person."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_73","description":"ID of the resource","required":true},{"name":"external_id","in":"path","schemaId":"schema_87","required":true}],"pointer":"/paths/~1v1~1people~1{id}~1external-ids~1{external_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/people/{id}/external-ids/{external_id}","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_73"},{"name":"external_id","in":"path","required":true,"schemaId":"schema_87"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204","400"],"pointer":"/v1/people/{id}/external-ids/{external_id}","href":"people/removepersonexternalid","openApiOperationId":"RemovePersonExternalId","summary":"Remove External ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1people~1{id}~1external-ids~1{external_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/people/removepersonexternalid"}],"panels":[]}]},"httpPath":"/v1/people/{id}/external-ids/{external_id}"}],"content":{"contentType":"group","meta":{"name":"People"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"People","showPageActions":true},{"nodeType":"markdoc","content":"People represent the individual resources available for assignment to projects. People are assigned roles, billable capacity, and utilization targets, and can be categorized by worker type, billing type, and department. A Persons record is central to capacity planning, resource allocation, forecasting, and reporting across the platform."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/people","summary":"List People","prefix":{"name":"get","color":"get"},"badges":[],"link":"/people/listpeople","deprecated":false},{"title":"/v1/people","summary":"Create Person","prefix":{"name":"post","color":"post"},"badges":[],"link":"/people/createperson","deprecated":false},{"title":"/v1/people/{id}","summary":"Get Person","prefix":{"name":"get","color":"get"},"badges":[],"link":"/people/getperson","deprecated":false},{"title":"/v1/people/{id}","summary":"Update Person","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/people/updateperson","deprecated":false},{"title":"/v1/people/{id}/external-ids","summary":"Add External ID","prefix":{"name":"post","color":"post"},"badges":[],"link":"/people/addpersonexternalid","deprecated":false},{"title":"/v1/people/{id}/external-ids/{external_id}","summary":"Remove External ID","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/people/removepersonexternalid","deprecated":false}]}]}]}]}},{"type":"group","label":"Pipelines","link":"/api-documentation/swagger/pipelines","routeSlug":"/api-documentation/swagger/pipelines","items":[{"label":"List Pipelines","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/pipelines/listpipelines","routeSlug":"/api-documentation/swagger/pipelines/listpipelines","metadata":{"seo":{"title":"List Pipelines","description":"Fetches a paginated list of sales pipelines"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListPipelines","name":"List Pipelines","isWebhook":false,"pointer":"/paths/~1v1~1pipelines/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Pipelines","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches a paginated list of sales pipelines"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_66","description":"The specific page of results requested."},{"name":"page_size","in":"query","schemaId":"schema_67","description":"The number of results in each page."},{"name":"archived","in":"query","schemaId":"schema_78","description":"Indicates if results should be filtered by their archived status."}],"pointer":"/paths/~1v1~1pipelines/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/pipelines","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"schema_66"},{"name":"page_size","in":"query","schemaId":"schema_67"},{"name":"archived","in":"query","schemaId":"schema_78"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/pipelines","href":"pipelines/listpipelines","openApiOperationId":"ListPipelines","summary":"List Pipelines"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PipelineDtoPagedResultsDto"}},"schemaId":"components/schemas/PipelineDtoPagedResultsDto"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1pipelines/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PipelineDtoPagedResultsDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PipelineDtoPagedResultsDto"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pipelines/listpipelines"}],"panels":[]}]},"httpPath":"/v1/pipelines"},{"label":"Create Pipeline","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/pipelines/createpipeline","routeSlug":"/api-documentation/swagger/pipelines/createpipeline","metadata":{"seo":{"title":"Create Pipeline","description":"Creates a new pipeline in the system to create pipeline stages for, unlocking the ability to track a deal's progress through the sale cycle."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreatePipeline","name":"Create Pipeline","isWebhook":false,"pointer":"/paths/~1v1~1pipelines/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Pipeline","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new pipeline in the system to create pipeline stages for, unlocking the ability to track a deal's progress through the sale cycle."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_88"},"application/json":{"schemaId":"schema_88"}},"schemaId":"schema_88","pointer":"/paths/~1v1~1pipelines/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/pipelines","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"schema_88"},"application/json":{"schemaId":"schema_88"}},"responseCodes":["201","400"],"pointer":"/v1/pipelines","href":"pipelines/createpipeline","openApiOperationId":"CreatePipeline","summary":"Create Pipeline"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"schemaId":"schema_88","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_88"},"application/json":{"schemaId":"schema_88"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Pipeline"}},"schemaId":"components/schemas/Pipeline"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1pipelines/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Pipeline","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Pipeline"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pipelines/createpipeline"}],"panels":[]}]},"httpPath":"/v1/pipelines"},{"label":"Get Pipeline by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/pipelines/getpipeline","routeSlug":"/api-documentation/swagger/pipelines/getpipeline","metadata":{"seo":{"title":"Get Pipeline by id","description":"Fetches pipeline by id to support sales forecasting and resource planning."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetPipeline","name":"Get Pipeline by id","isWebhook":false,"pointer":"/paths/~1v1~1pipelines~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Pipeline by id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetches pipeline by id to support sales forecasting and resource planning."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_73","description":"ID of the resource","required":true}],"pointer":"/paths/~1v1~1pipelines~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/pipelines/{id}","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_73"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/pipelines/{id}","href":"pipelines/getpipeline","openApiOperationId":"GetPipeline","summary":"Get Pipeline by id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Pipeline"}},"schemaId":"components/schemas/Pipeline"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1pipelines~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Pipeline","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Pipeline"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pipelines/getpipeline"}],"panels":[]}]},"httpPath":"/v1/pipelines/{id}"},{"label":"Update Pipeline","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/pipelines/updatepipeline","routeSlug":"/api-documentation/swagger/pipelines/updatepipeline","metadata":{"seo":{"title":"Update Pipeline","description":"Updates an existing pipeline entry to reflect stage changes, budget adjustments, or anticipated start dates."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdatePipeline","name":"Update Pipeline","isWebhook":false,"pointer":"/paths/~1v1~1pipelines~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Pipeline","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing pipeline entry to reflect stage changes, budget adjustments, or anticipated start dates."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_73","description":"ID of the resource","required":true}],"pointer":"/paths/~1v1~1pipelines~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_89"},"application/json":{"schemaId":"schema_89"}},"schemaId":"schema_89","pointer":"/paths/~1v1~1pipelines~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/pipelines/{id}","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_73"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"schema_89"},"application/json":{"schemaId":"schema_89"}},"responseCodes":["200","400"],"pointer":"/v1/pipelines/{id}","href":"pipelines/updatepipeline","openApiOperationId":"UpdatePipeline","summary":"Update Pipeline"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"schemaId":"schema_89","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_89"},"application/json":{"schemaId":"schema_89"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1pipelines~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pipelines/updatepipeline"}],"panels":[]}]},"httpPath":"/v1/pipelines/{id}"}],"content":{"contentType":"group","meta":{"name":"Pipelines"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pipelines","showPageActions":true},{"nodeType":"markdoc","content":"A Pipeline mirrors the sales opportunity stages configured in the integrated CRM system. The Pipeline allows Parallax to track deal progression, forecast demand, and convert opportunities into projects once deals are closed-won."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/pipelines","summary":"List Pipelines","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pipelines/listpipelines","deprecated":false},{"title":"/v1/pipelines","summary":"Create Pipeline","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pipelines/createpipeline","deprecated":false},{"title":"/v1/pipelines/{id}","summary":"Get Pipeline by id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pipelines/getpipeline","deprecated":false},{"title":"/v1/pipelines/{id}","summary":"Update Pipeline","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/pipelines/updatepipeline","deprecated":false}]}]}]}]}},{"type":"group","label":"PlannedTimeOff","link":"/api-documentation/swagger/plannedtimeoff","routeSlug":"/api-documentation/swagger/plannedtimeoff","items":[{"label":"List Planned Time Off","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/plannedtimeoff/listplannedtimeoff","routeSlug":"/api-documentation/swagger/plannedtimeoff/listplannedtimeoff","metadata":{"seo":{"title":"List Planned Time Off","description":"Returns a paged list of planned time off filtered by date range. Optionally filtered to a single person."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListPlannedTimeOff","name":"List Planned Time Off","isWebhook":false,"pointer":"/paths/~1v1~1planned-time-off/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Planned Time Off","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paged list of planned time off filtered by date range. Optionally filtered to a single person."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_66","description":"The specific page of results requested."},{"name":"page_size","in":"query","schemaId":"schema_67","description":"The number of results in each page."},{"name":"start_date","in":"query","schemaId":"schema_68","description":"Filter by entries recorded on or after this date. When not provided, defaults to 7 days ago from today. ISO date formatting expected (yyyy-MM-dd)"},{"name":"end_date","in":"query","schemaId":"schema_69","description":"Filter by entries recorded on or before this date. When not provided, defaults to today. ISO date formatting expected (yyyy-MM-dd)"},{"name":"person_id","in":"query","schemaId":"schema_90","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by entries recorded for the Person associated with this person_id."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1planned-time-off/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/planned-time-off","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"schema_66"},{"name":"page_size","in":"query","schemaId":"schema_67"},{"name":"start_date","in":"query","schemaId":"schema_68"},{"name":"end_date","in":"query","schemaId":"schema_69"},{"name":"person_id","in":"query","schemaId":"schema_90"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/planned-time-off","href":"plannedtimeoff/listplannedtimeoff","openApiOperationId":"ListPlannedTimeOff","summary":"List Planned Time Off"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlannedTimeOffDtoPagedResultsDto"}},"schemaId":"components/schemas/PlannedTimeOffDtoPagedResultsDto"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1planned-time-off/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PlannedTimeOffDtoPagedResultsDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlannedTimeOffDtoPagedResultsDto"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/plannedtimeoff/listplannedtimeoff"}],"panels":[]}]},"httpPath":"/v1/planned-time-off"},{"label":"Create Planned Time Off","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/plannedtimeoff/createplannedtimeoff","routeSlug":"/api-documentation/swagger/plannedtimeoff/createplannedtimeoff","metadata":{"seo":{"title":"Create Planned Time Off","description":"Creates a new planned time off entry for a person with one or more date allocations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreatePlannedTimeOff","name":"Create Planned Time Off","isWebhook":false,"pointer":"/paths/~1v1~1planned-time-off/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Planned Time Off","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new planned time off entry for a person with one or more date allocations."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_91"},"application/json":{"schemaId":"schema_91"}},"schemaId":"schema_91","pointer":"/paths/~1v1~1planned-time-off/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/planned-time-off","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"schema_91"},"application/json":{"schemaId":"schema_91"}},"responseCodes":["201","400"],"pointer":"/v1/planned-time-off","href":"plannedtimeoff/createplannedtimeoff","openApiOperationId":"CreatePlannedTimeOff","summary":"Create Planned Time Off"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"schemaId":"schema_91","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_91"},"application/json":{"schemaId":"schema_91"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlannedTimeOff"}},"schemaId":"components/schemas/PlannedTimeOff"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1planned-time-off/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/PlannedTimeOff","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlannedTimeOff"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/plannedtimeoff/createplannedtimeoff"}],"panels":[]}]},"httpPath":"/v1/planned-time-off"},{"label":"Delete Planned Time Off","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/plannedtimeoff/deleteplannedtimeoff","routeSlug":"/api-documentation/swagger/plannedtimeoff/deleteplannedtimeoff","metadata":{"seo":{"title":"Delete Planned Time Off","description":"Permanently removes a planned time off entry."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeletePlannedTimeOff","name":"Delete Planned Time Off","isWebhook":false,"pointer":"/paths/~1v1~1planned-time-off~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Planned Time Off","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Permanently removes a planned time off entry."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_73","description":"ID of the resource","required":true}],"pointer":"/paths/~1v1~1planned-time-off~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/planned-time-off/{id}","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_73"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204","400"],"pointer":"/v1/planned-time-off/{id}","href":"plannedtimeoff/deleteplannedtimeoff","openApiOperationId":"DeletePlannedTimeOff","summary":"Delete Planned Time Off"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1planned-time-off~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/plannedtimeoff/deleteplannedtimeoff"}],"panels":[]}]},"httpPath":"/v1/planned-time-off/{id}"},{"label":"Get Planned Time Off","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/plannedtimeoff/getplannedtimeoff","routeSlug":"/api-documentation/swagger/plannedtimeoff/getplannedtimeoff","metadata":{"seo":{"title":"Get Planned Time Off","description":"Returns a single planned time off entry by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetPlannedTimeOff","name":"Get Planned Time Off","isWebhook":false,"pointer":"/paths/~1v1~1planned-time-off~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Planned Time Off","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a single planned time off entry by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_73","description":"ID of the resource","required":true}],"pointer":"/paths/~1v1~1planned-time-off~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/planned-time-off/{id}","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_73"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/planned-time-off/{id}","href":"plannedtimeoff/getplannedtimeoff","openApiOperationId":"GetPlannedTimeOff","summary":"Get Planned Time Off"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlannedTimeOff"}},"schemaId":"components/schemas/PlannedTimeOff"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1planned-time-off~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PlannedTimeOff","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlannedTimeOff"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/plannedtimeoff/getplannedtimeoff"}],"panels":[]}]},"httpPath":"/v1/planned-time-off/{id}"},{"label":"Update Planned Time Off","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/plannedtimeoff/updateplannedtimeoff","routeSlug":"/api-documentation/swagger/plannedtimeoff/updateplannedtimeoff","metadata":{"seo":{"title":"Update Planned Time Off","description":"Replaces the allocations on an existing planned time off entry."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdatePlannedTimeOff","name":"Update Planned Time Off","isWebhook":false,"pointer":"/paths/~1v1~1planned-time-off~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Planned Time Off","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Replaces the allocations on an existing planned time off entry."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_73","description":"ID of the resource","required":true}],"pointer":"/paths/~1v1~1planned-time-off~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_92"},"application/json":{"schemaId":"schema_92"}},"schemaId":"schema_92","pointer":"/paths/~1v1~1planned-time-off~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/planned-time-off/{id}","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_73"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"schema_92"},"application/json":{"schemaId":"schema_92"}},"responseCodes":["200","400"],"pointer":"/v1/planned-time-off/{id}","href":"plannedtimeoff/updateplannedtimeoff","openApiOperationId":"UpdatePlannedTimeOff","summary":"Update Planned Time Off"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"schemaId":"schema_92","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_92"},"application/json":{"schemaId":"schema_92"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1planned-time-off~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/plannedtimeoff/updateplannedtimeoff"}],"panels":[]}]},"httpPath":"/v1/planned-time-off/{id}"}],"content":{"contentType":"group","meta":{"name":"PlannedTimeOff"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"PlannedTimeOff","showPageActions":true},{"nodeType":"markdoc","content":"Planned Time Off represents approved time off requests for employees, each entry capturing the date range and category of planned time away from work. Each entry has a start and end date, and is intended to capture a contiguous period of absense. Use these endpoints to create, retrieve, update, and delete planned time off, allowing resource capacity to remain accurate for planning purposes."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/planned-time-off","summary":"List Planned Time Off","prefix":{"name":"get","color":"get"},"badges":[],"link":"/plannedtimeoff/listplannedtimeoff","deprecated":false},{"title":"/v1/planned-time-off","summary":"Create Planned Time Off","prefix":{"name":"post","color":"post"},"badges":[],"link":"/plannedtimeoff/createplannedtimeoff","deprecated":false},{"title":"/v1/planned-time-off/{id}","summary":"Delete Planned Time Off","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/plannedtimeoff/deleteplannedtimeoff","deprecated":false},{"title":"/v1/planned-time-off/{id}","summary":"Get Planned Time Off","prefix":{"name":"get","color":"get"},"badges":[],"link":"/plannedtimeoff/getplannedtimeoff","deprecated":false},{"title":"/v1/planned-time-off/{id}","summary":"Update Planned Time Off","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/plannedtimeoff/updateplannedtimeoff","deprecated":false}]}]}]}]}},{"type":"group","label":"ProjectOfferingRoles","link":"/api-documentation/swagger/projectofferingroles","routeSlug":"/api-documentation/swagger/projectofferingroles","items":[{"label":"List Project Offering Roles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/projectofferingroles/listprojectofferingroles","routeSlug":"/api-documentation/swagger/projectofferingroles/listprojectofferingroles","metadata":{"seo":{"title":"List Project Offering Roles","description":"Lists paginated project offering roles currently planned or used within a project offering."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListProjectOfferingRoles","name":"List Project Offering Roles","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{project_offering_id}~1roles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Project Offering Roles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists paginated project offering roles currently planned or used within a project offering."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"project_id","in":"path","schemaId":"schema_73","required":true},{"name":"project_offering_id","in":"path","schemaId":"schema_73","required":true}],"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{project_offering_id}~1roles/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_66","description":"The specific page of results requested."},{"name":"page_size","in":"query","schemaId":"schema_67","description":"The number of results in each page."},{"name":"terms","in":"query","schemaId":"schema_87"}],"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{project_offering_id}~1roles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{project_id}/offerings/{project_offering_id}/roles","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"project_id","in":"path","required":true,"schemaId":"schema_73"},{"name":"project_offering_id","in":"path","required":true,"schemaId":"schema_73"}],"query":[{"name":"page","in":"query","schemaId":"schema_66"},{"name":"page_size","in":"query","schemaId":"schema_67"},{"name":"terms","in":"query","schemaId":"schema_87"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/projects/{project_id}/offerings/{project_offering_id}/roles","href":"projectofferingroles/listprojectofferingroles","openApiOperationId":"ListProjectOfferingRoles","summary":"List Project Offering Roles"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectOfferingRoleDtoPagedResultsDto"}},"schemaId":"components/schemas/ProjectOfferingRoleDtoPagedResultsDto"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{project_offering_id}~1roles/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProjectOfferingRoleDtoPagedResultsDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectOfferingRoleDtoPagedResultsDto"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projectofferingroles/listprojectofferingroles"}],"panels":[]}]},"httpPath":"/v1/projects/{project_id}/offerings/{project_offering_id}/roles"},{"label":"Create Project Offering Role","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/projectofferingroles/createprojectofferingrole","routeSlug":"/api-documentation/swagger/projectofferingroles/createprojectofferingrole","metadata":{"seo":{"title":"Create Project Offering Role","description":"Creates a Project Offering Role."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateProjectOfferingRole","name":"Create Project Offering Role","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{project_offering_id}~1roles/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Project Offering Role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a Project Offering Role."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"project_id","in":"path","schemaId":"schema_73","required":true},{"name":"project_offering_id","in":"path","schemaId":"schema_73","required":true}],"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{project_offering_id}~1roles/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_93"},"application/json":{"schemaId":"schema_93"}},"schemaId":"schema_93","pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{project_offering_id}~1roles/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{project_id}/offerings/{project_offering_id}/roles","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"project_id","in":"path","required":true,"schemaId":"schema_73"},{"name":"project_offering_id","in":"path","required":true,"schemaId":"schema_73"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"schema_93"},"application/json":{"schemaId":"schema_93"}},"responseCodes":["201","400"],"pointer":"/v1/projects/{project_id}/offerings/{project_offering_id}/roles","href":"projectofferingroles/createprojectofferingrole","openApiOperationId":"CreateProjectOfferingRole","summary":"Create Project Offering Role"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"schemaId":"schema_93","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_93"},"application/json":{"schemaId":"schema_93"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectOfferingRole"}},"schemaId":"components/schemas/ProjectOfferingRole"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{project_offering_id}~1roles/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/ProjectOfferingRole","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectOfferingRole"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projectofferingroles/createprojectofferingrole"}],"panels":[]}]},"httpPath":"/v1/projects/{project_id}/offerings/{project_offering_id}/roles"},{"label":"Delete Project Offering Role","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/projectofferingroles/deleteprojectofferingrole","routeSlug":"/api-documentation/swagger/projectofferingroles/deleteprojectofferingrole","metadata":{"seo":{"title":"Delete Project Offering Role","description":"Deletes a Project Offering Role. The role must not have any assignments or planned time."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteProjectOfferingRole","name":"Delete Project Offering Role","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{project_offering_id}~1roles~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Project Offering Role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a Project Offering Role. The role must not have any assignments or planned time."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_73","description":"ID of the resource","required":true},{"name":"project_id","in":"path","schemaId":"schema_73","required":true},{"name":"project_offering_id","in":"path","schemaId":"schema_73","required":true}],"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{project_offering_id}~1roles~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/projects/{project_id}/offerings/{project_offering_id}/roles/{id}","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_73"},{"name":"project_id","in":"path","required":true,"schemaId":"schema_73"},{"name":"project_offering_id","in":"path","required":true,"schemaId":"schema_73"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204","400"],"pointer":"/v1/projects/{project_id}/offerings/{project_offering_id}/roles/{id}","href":"projectofferingroles/deleteprojectofferingrole","openApiOperationId":"DeleteProjectOfferingRole","summary":"Delete Project Offering Role"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{project_offering_id}~1roles~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projectofferingroles/deleteprojectofferingrole"}],"panels":[]}]},"httpPath":"/v1/projects/{project_id}/offerings/{project_offering_id}/roles/{id}"},{"label":"Get Project Offering Role","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/projectofferingroles/getprojectofferingrole","routeSlug":"/api-documentation/swagger/projectofferingroles/getprojectofferingrole","metadata":{"seo":{"title":"Get Project Offering Role","description":"Gets details of a specific role within a Project Offering, including assignment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetProjectOfferingRole","name":"Get Project Offering Role","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{project_offering_id}~1roles~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Project Offering Role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets details of a specific role within a Project Offering, including assignment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_73","description":"ID of the resource","required":true},{"name":"project_id","in":"path","schemaId":"schema_73","required":true},{"name":"project_offering_id","in":"path","schemaId":"schema_73","required":true}],"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{project_offering_id}~1roles~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{project_id}/offerings/{project_offering_id}/roles/{id}","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_73"},{"name":"project_id","in":"path","required":true,"schemaId":"schema_73"},{"name":"project_offering_id","in":"path","required":true,"schemaId":"schema_73"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/projects/{project_id}/offerings/{project_offering_id}/roles/{id}","href":"projectofferingroles/getprojectofferingrole","openApiOperationId":"GetProjectOfferingRole","summary":"Get Project Offering Role"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectOfferingRole"}},"schemaId":"components/schemas/ProjectOfferingRole"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{project_offering_id}~1roles~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProjectOfferingRole","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectOfferingRole"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projectofferingroles/getprojectofferingrole"}],"panels":[]}]},"httpPath":"/v1/projects/{project_id}/offerings/{project_offering_id}/roles/{id}"},{"label":"Update Project Offering Role","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/projectofferingroles/updateprojectofferingrole","routeSlug":"/api-documentation/swagger/projectofferingroles/updateprojectofferingrole","metadata":{"seo":{"title":"Update Project Offering Role","description":"Updates a Project Offering Role. This includes assigning a specific Person or Requisition. Removing or replacing an assignment where the current person has actuals will return a 409 Conflict."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateProjectOfferingRole","name":"Update Project Offering Role","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{project_offering_id}~1roles~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Project Offering Role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates a Project Offering Role. This includes assigning a specific "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Person"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Requisition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Removing or replacing an assignment where the current person has actuals will return a 409 Conflict."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_73","description":"ID of the resource","required":true},{"name":"project_id","in":"path","schemaId":"schema_73","required":true},{"name":"project_offering_id","in":"path","schemaId":"schema_73","required":true}],"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{project_offering_id}~1roles~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_94"},"application/json":{"schemaId":"schema_94"}},"schemaId":"schema_94","pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{project_offering_id}~1roles~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/projects/{project_id}/offerings/{project_offering_id}/roles/{id}","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_73"},{"name":"project_id","in":"path","required":true,"schemaId":"schema_73"},{"name":"project_offering_id","in":"path","required":true,"schemaId":"schema_73"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"schema_94"},"application/json":{"schemaId":"schema_94"}},"responseCodes":["200","400"],"pointer":"/v1/projects/{project_id}/offerings/{project_offering_id}/roles/{id}","href":"projectofferingroles/updateprojectofferingrole","openApiOperationId":"UpdateProjectOfferingRole","summary":"Update Project Offering Role"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"schemaId":"schema_94","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_94"},"application/json":{"schemaId":"schema_94"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{project_offering_id}~1roles~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projectofferingroles/updateprojectofferingrole"}],"panels":[]}]},"httpPath":"/v1/projects/{project_id}/offerings/{project_offering_id}/roles/{id}"},{"label":"List Project Offering Role Plans","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/projectofferingroles/listprojectofferingroleplans","routeSlug":"/api-documentation/swagger/projectofferingroles/listprojectofferingroleplans","metadata":{"seo":{"title":"List Project Offering Role Plans","description":"Lists paginated planned time entries for a Project Offering Role with filtering by date range. Days with no planned hours are not returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListProjectOfferingRolePlans","name":"List Project Offering Role Plans","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{project_offering_id}~1roles~1{id}~1planned-time/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Project Offering Role Plans","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists paginated planned time entries for a Project Offering Role with filtering by date range. Days with no planned hours are not returned."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_73","description":"ID of the resource","required":true},{"name":"project_id","in":"path","schemaId":"schema_73","required":true},{"name":"project_offering_id","in":"path","schemaId":"schema_73","required":true}],"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{project_offering_id}~1roles~1{id}~1planned-time/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_66","description":"The specific page of results requested."},{"name":"page_size","in":"query","schemaId":"schema_67","description":"The number of results in each page."},{"name":"start_date","in":"query","schemaId":"schema_95","description":"Filter by entries recorded on or after this date. ISO date formatting expected (yyyy-MM-dd)"},{"name":"end_date","in":"query","schemaId":"schema_96","description":"Filter by entries recorded on or before this date. ISO date formatting expected (yyyy-MM-dd)"}],"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{project_offering_id}~1roles~1{id}~1planned-time/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{project_id}/offerings/{project_offering_id}/roles/{id}/planned-time","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_73"},{"name":"project_id","in":"path","required":true,"schemaId":"schema_73"},{"name":"project_offering_id","in":"path","required":true,"schemaId":"schema_73"}],"query":[{"name":"page","in":"query","schemaId":"schema_66"},{"name":"page_size","in":"query","schemaId":"schema_67"},{"name":"start_date","in":"query","schemaId":"schema_95"},{"name":"end_date","in":"query","schemaId":"schema_96"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/projects/{project_id}/offerings/{project_offering_id}/roles/{id}/planned-time","href":"projectofferingroles/listprojectofferingroleplans","openApiOperationId":"ListProjectOfferingRolePlans","summary":"List Project Offering Role Plans"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectOfferingRolePlannedTimeDtoPagedResultsDto"}},"schemaId":"components/schemas/ProjectOfferingRolePlannedTimeDtoPagedResultsDto"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{project_offering_id}~1roles~1{id}~1planned-time/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProjectOfferingRolePlannedTimeDtoPagedResultsDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectOfferingRolePlannedTimeDtoPagedResultsDto"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projectofferingroles/listprojectofferingroleplans"}],"panels":[]}]},"httpPath":"/v1/projects/{project_id}/offerings/{project_offering_id}/roles/{id}/planned-time"},{"label":"Update Project Offering Role Plans","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/projectofferingroles/updateprojectofferingroleplans","routeSlug":"/api-documentation/swagger/projectofferingroles/updateprojectofferingroleplans","metadata":{"seo":{"title":"Update Project Offering Role Plans","description":"Updates a Project Offering Role's Plans. Takes an array of ProjectOfferingRolePlannedTime entries and applies them to the specified Project Offering Role. Up to 100 entries can be sent at a time. To clear plans for a given day, send 0 hours. Dates omitted from the request will not be altered."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateProjectOfferingRolePlans","name":"Update Project Offering Role Plans","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{project_offering_id}~1roles~1{id}~1planned-time/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Project Offering Role Plans","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a Project Offering Role's Plans. Takes an array of ProjectOfferingRolePlannedTime entries and applies them to the specified Project Offering Role. Up to 100 entries can be sent at a time. To clear plans for a given day, send 0 hours. Dates omitted from the request will not be altered."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_73","description":"ID of the resource","required":true},{"name":"project_id","in":"path","schemaId":"schema_73","required":true},{"name":"project_offering_id","in":"path","schemaId":"schema_73","required":true}],"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{project_offering_id}~1roles~1{id}~1planned-time/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_97"},"application/json":{"schemaId":"schema_97"}},"schemaId":"schema_97","pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{project_offering_id}~1roles~1{id}~1planned-time/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{project_id}/offerings/{project_offering_id}/roles/{id}/planned-time","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_73"},{"name":"project_id","in":"path","required":true,"schemaId":"schema_73"},{"name":"project_offering_id","in":"path","required":true,"schemaId":"schema_73"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"schema_97"},"application/json":{"schemaId":"schema_97"}},"responseCodes":["204","400"],"pointer":"/v1/projects/{project_id}/offerings/{project_offering_id}/roles/{id}/planned-time","href":"projectofferingroles/updateprojectofferingroleplans","openApiOperationId":"UpdateProjectOfferingRolePlans","summary":"Update Project Offering Role Plans"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"schemaId":"schema_97","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_97"},"application/json":{"schemaId":"schema_97"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{project_offering_id}~1roles~1{id}~1planned-time/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projectofferingroles/updateprojectofferingroleplans"}],"panels":[]}]},"httpPath":"/v1/projects/{project_id}/offerings/{project_offering_id}/roles/{id}/planned-time"}],"content":{"contentType":"group","meta":{"name":"ProjectOfferingRoles"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ProjectOfferingRoles","showPageActions":true},{"nodeType":"markdoc","content":"A Project Offering Role defines the specific role, resource allocation, and scheduled hours needed within a Project Offering. These roles form the basis of the resource plan by identifying the skill sets, timelines, and capacity requirements for successful delivery of the scoped work."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/projects/{project_id}/offerings/{project_offering_id}/roles","summary":"List Project Offering Roles","prefix":{"name":"get","color":"get"},"badges":[],"link":"/projectofferingroles/listprojectofferingroles","deprecated":false},{"title":"/v1/projects/{project_id}/offerings/{project_offering_id}/roles","summary":"Create Project Offering Role","prefix":{"name":"post","color":"post"},"badges":[],"link":"/projectofferingroles/createprojectofferingrole","deprecated":false},{"title":"/v1/projects/{project_id}/offerings/{project_offering_id}/roles/{id}","summary":"Delete Project Offering Role","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/projectofferingroles/deleteprojectofferingrole","deprecated":false},{"title":"/v1/projects/{project_id}/offerings/{project_offering_id}/roles/{id}","summary":"Get Project Offering Role","prefix":{"name":"get","color":"get"},"badges":[],"link":"/projectofferingroles/getprojectofferingrole","deprecated":false},{"title":"/v1/projects/{project_id}/offerings/{project_offering_id}/roles/{id}","summary":"Update Project Offering Role","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/projectofferingroles/updateprojectofferingrole","deprecated":false},{"title":"/v1/projects/{project_id}/offerings/{project_offering_id}/roles/{id}/planned-time","summary":"List Project Offering Role Plans","prefix":{"name":"get","color":"get"},"badges":[],"link":"/projectofferingroles/listprojectofferingroleplans","deprecated":false},{"title":"/v1/projects/{project_id}/offerings/{project_offering_id}/roles/{id}/planned-time","summary":"Update Project Offering Role Plans","prefix":{"name":"post","color":"post"},"badges":[],"link":"/projectofferingroles/updateprojectofferingroleplans","deprecated":false}]}]}]}]}},{"type":"group","label":"ProjectOfferings","link":"/api-documentation/swagger/projectofferings","routeSlug":"/api-documentation/swagger/projectofferings","items":[{"label":"List Project Offerings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/projectofferings/listprojectofferings","routeSlug":"/api-documentation/swagger/projectofferings/listprojectofferings","metadata":{"seo":{"title":"List Project Offerings","description":"Gets a paginated list of Project Offerings for a specified project, which serve as containers for resource plans, budgets, and financial models."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListProjectOfferings","name":"List Project Offerings","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Project Offerings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a paginated list of Project Offerings for a specified project, which serve as containers for resource plans, budgets, and financial models."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"project_id","in":"path","schemaId":"schema_98","description":"The ID of the Project, to which this Project Offering belongs.","required":true}],"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_66","description":"The specific page of results requested."},{"name":"page_size","in":"query","schemaId":"schema_67","description":"The number of results in each page."},{"name":"terms","in":"query","schemaId":"schema_87"},{"name":"external_id","in":"query","schemaId":"schema_99","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by external ID. For Parallax-managed integrations, use the format 'px_provider:id' (e.g., 'px_harvest:12345'). For custom integrations, use the string format appropriate for that integration."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{project_id}/offerings","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"project_id","in":"path","required":true,"schemaId":"schema_98"}],"query":[{"name":"page","in":"query","schemaId":"schema_66"},{"name":"page_size","in":"query","schemaId":"schema_67"},{"name":"terms","in":"query","schemaId":"schema_87"},{"name":"external_id","in":"query","schemaId":"schema_99"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/projects/{project_id}/offerings","href":"projectofferings/listprojectofferings","openApiOperationId":"ListProjectOfferings","summary":"List Project Offerings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectOfferingDtoPagedResultsDto"}},"schemaId":"components/schemas/ProjectOfferingDtoPagedResultsDto"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProjectOfferingDtoPagedResultsDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectOfferingDtoPagedResultsDto"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projectofferings/listprojectofferings"}],"panels":[]}]},"httpPath":"/v1/projects/{project_id}/offerings"},{"label":"Create Project Offering","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/projectofferings/createprojectoffering","routeSlug":"/api-documentation/swagger/projectofferings/createprojectoffering","metadata":{"seo":{"title":"Create Project Offering","description":"Creates a new Project Offering for the specified Project. Additional configuration for certain Billing Models are optional."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateProjectOffering","name":"Create Project Offering","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Project Offering","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new Project Offering for the specified Project. Additional configuration for certain Billing Models are optional."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"project_id","in":"path","schemaId":"schema_98","description":"The ID of the Project, to which this Project Offering belongs.","required":true}],"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_100"},"application/json":{"schemaId":"schema_100"}},"schemaId":"schema_100","pointer":"/paths/~1v1~1projects~1{project_id}~1offerings/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{project_id}/offerings","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"project_id","in":"path","required":true,"schemaId":"schema_98"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"schema_100"},"application/json":{"schemaId":"schema_100"}},"responseCodes":["201","400"],"pointer":"/v1/projects/{project_id}/offerings","href":"projectofferings/createprojectoffering","openApiOperationId":"CreateProjectOffering","summary":"Create Project Offering"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"schemaId":"schema_100","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_100"},"application/json":{"schemaId":"schema_100"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectOffering"}},"schemaId":"components/schemas/ProjectOffering"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/ProjectOffering","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectOffering"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projectofferings/createprojectoffering"}],"panels":[]}]},"httpPath":"/v1/projects/{project_id}/offerings"},{"label":"Get Project Offering","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/projectofferings/getprojectoffering","routeSlug":"/api-documentation/swagger/projectofferings/getprojectoffering","metadata":{"seo":{"title":"Get Project Offering","description":"Gets details of a specific Project Offering, including financial settings, planned roles, and associated timesheet project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetProjectOffering","name":"Get Project Offering","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Project Offering","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets details of a specific Project Offering, including financial settings, planned roles, and associated timesheet project."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_73","description":"ID of the resource","required":true},{"name":"project_id","in":"path","schemaId":"schema_98","description":"The ID of the Project, to which this Project Offering belongs.","required":true}],"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{project_id}/offerings/{id}","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_73"},{"name":"project_id","in":"path","required":true,"schemaId":"schema_98"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/projects/{project_id}/offerings/{id}","href":"projectofferings/getprojectoffering","openApiOperationId":"GetProjectOffering","summary":"Get Project Offering"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectOffering"}},"schemaId":"components/schemas/ProjectOffering"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProjectOffering","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectOffering"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projectofferings/getprojectoffering"}],"panels":[]}]},"httpPath":"/v1/projects/{project_id}/offerings/{id}"},{"label":"Update Project Offering","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/projectofferings/updateprojectoffering","routeSlug":"/api-documentation/swagger/projectofferings/updateprojectoffering","metadata":{"seo":{"title":"Update Project Offering","description":"Updates a Project Offering's name and billing model, if provided. The ability to modify a Project Offering is limited, once the parent Project status has been moved beyond Awaiting Start."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateProjectOffering","name":"Update Project Offering","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Project Offering","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a Project Offering's name and billing model, if provided. The ability to modify a Project Offering is limited, once the parent Project status has been moved beyond Awaiting Start."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_101","description":"ID of the Project Offering.","required":true},{"name":"project_id","in":"path","schemaId":"schema_98","description":"The ID of the Project, to which this Project Offering belongs.","required":true}],"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_102"},"application/json":{"schemaId":"schema_102"}},"schemaId":"schema_102","pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/projects/{project_id}/offerings/{id}","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_101"},{"name":"project_id","in":"path","required":true,"schemaId":"schema_98"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"schema_102"},"application/json":{"schemaId":"schema_102"}},"responseCodes":["200","400"],"pointer":"/v1/projects/{project_id}/offerings/{id}","href":"projectofferings/updateprojectoffering","openApiOperationId":"UpdateProjectOffering","summary":"Update Project Offering"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"schemaId":"schema_102","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_102"},"application/json":{"schemaId":"schema_102"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projectofferings/updateprojectoffering"}],"panels":[]}]},"httpPath":"/v1/projects/{project_id}/offerings/{id}"},{"label":"Get Project Offering Metrics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/projectofferings/getprojectofferingmetricsbyid","routeSlug":"/api-documentation/swagger/projectofferings/getprojectofferingmetricsbyid","metadata":{"seo":{"title":"Get Project Offering Metrics","description":"Labor and financial metrics for this Project Offering. All calculations involving Actual Time entries are subject to the Calculation Threshold organization setting."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetProjectOfferingMetricsById","name":"Get Project Offering Metrics","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{id}~1metrics/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Project Offering Metrics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Labor and financial metrics for this Project Offering. All calculations involving Actual Time entries are subject to the Calculation Threshold organization setting."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_73","description":"ID of the resource","required":true},{"name":"project_id","in":"path","schemaId":"schema_98","description":"The ID of the Project, to which this Project Offering belongs.","required":true}],"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{id}~1metrics/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{project_id}/offerings/{id}/metrics","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_73"},{"name":"project_id","in":"path","required":true,"schemaId":"schema_98"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/projects/{project_id}/offerings/{id}/metrics","href":"projectofferings/getprojectofferingmetricsbyid","openApiOperationId":"GetProjectOfferingMetricsById","summary":"Get Project Offering Metrics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectOfferingMetrics"}},"schemaId":"components/schemas/ProjectOfferingMetrics"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{id}~1metrics/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProjectOfferingMetrics","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectOfferingMetrics"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projectofferings/getprojectofferingmetricsbyid"}],"panels":[]}]},"httpPath":"/v1/projects/{project_id}/offerings/{id}/metrics"},{"label":"Add External ID","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/projectofferings/addofferingexternalid","routeSlug":"/api-documentation/swagger/projectofferings/addofferingexternalid","metadata":{"seo":{"title":"Add External ID","description":"Adds a custom integration external identifier to a Project Offering. This can be any opaque string used to correlate the Project Offering with a record in an external system. Strings starting with a reserved 'px_' provider prefix (e.g., 'px_harvest:') are reserved for use by Parallax integrations and not allowed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AddOfferingExternalId","name":"Add External ID","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{offering_id}~1external-ids/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add External ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds a custom integration external identifier to a Project Offering. This can be any opaque string used to correlate the Project Offering with a record in an external system. Strings starting with a reserved 'px_' provider prefix (e.g., 'px_harvest:') are reserved for use by Parallax integrations and not allowed."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"offering_id","in":"path","schemaId":"schema_73","required":true},{"name":"project_id","in":"path","schemaId":"schema_98","description":"The ID of the Project, to which this Project Offering belongs.","required":true}],"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{offering_id}~1external-ids/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_103"},"application/json":{"schemaId":"schema_103"}},"schemaId":"schema_103","pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{offering_id}~1external-ids/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{project_id}/offerings/{offering_id}/external-ids","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"offering_id","in":"path","required":true,"schemaId":"schema_73"},{"name":"project_id","in":"path","required":true,"schemaId":"schema_98"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"schema_103"},"application/json":{"schemaId":"schema_103"}},"responseCodes":["201","400"],"pointer":"/v1/projects/{project_id}/offerings/{offering_id}/external-ids","href":"projectofferings/addofferingexternalid","openApiOperationId":"AddOfferingExternalId","summary":"Add External ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"schemaId":"schema_103","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_103"},"application/json":{"schemaId":"schema_103"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{offering_id}~1external-ids/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projectofferings/addofferingexternalid"}],"panels":[]}]},"httpPath":"/v1/projects/{project_id}/offerings/{offering_id}/external-ids"},{"label":"Remove External ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/projectofferings/removeofferingexternalid","routeSlug":"/api-documentation/swagger/projectofferings/removeofferingexternalid","metadata":{"seo":{"title":"Remove External ID","description":"Removes a custom integration external identifier from a Project Offering."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RemoveOfferingExternalId","name":"Remove External ID","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{offering_id}~1external-ids~1{external_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove External ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Removes a custom integration external identifier from a Project Offering."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"offering_id","in":"path","schemaId":"schema_73","required":true},{"name":"project_id","in":"path","schemaId":"schema_98","description":"The ID of the Project, to which this Project Offering belongs.","required":true},{"name":"external_id","in":"path","schemaId":"schema_87","required":true}],"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{offering_id}~1external-ids~1{external_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/projects/{project_id}/offerings/{offering_id}/external-ids/{external_id}","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"offering_id","in":"path","required":true,"schemaId":"schema_73"},{"name":"project_id","in":"path","required":true,"schemaId":"schema_98"},{"name":"external_id","in":"path","required":true,"schemaId":"schema_87"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204","400"],"pointer":"/v1/projects/{project_id}/offerings/{offering_id}/external-ids/{external_id}","href":"projectofferings/removeofferingexternalid","openApiOperationId":"RemoveOfferingExternalId","summary":"Remove External ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{project_id}~1offerings~1{offering_id}~1external-ids~1{external_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projectofferings/removeofferingexternalid"}],"panels":[]}]},"httpPath":"/v1/projects/{project_id}/offerings/{offering_id}/external-ids/{external_id}"}],"content":{"contentType":"group","meta":{"name":"ProjectOfferings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ProjectOfferings","showPageActions":true},{"nodeType":"markdoc","content":"A Project Offering represents a distinct scope or phase of work within a Project. Each Project Offering contains resource plans, financial models, and revenue data, allowing organizations to model different work types and billing structures within a single project. Offerings help align sales, delivery, and operations teams around specific scopes of work and resourcing needs."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/projects/{project_id}/offerings","summary":"List Project Offerings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/projectofferings/listprojectofferings","deprecated":false},{"title":"/v1/projects/{project_id}/offerings","summary":"Create Project Offering","prefix":{"name":"post","color":"post"},"badges":[],"link":"/projectofferings/createprojectoffering","deprecated":false},{"title":"/v1/projects/{project_id}/offerings/{id}","summary":"Get Project Offering","prefix":{"name":"get","color":"get"},"badges":[],"link":"/projectofferings/getprojectoffering","deprecated":false},{"title":"/v1/projects/{project_id}/offerings/{id}","summary":"Update Project Offering","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/projectofferings/updateprojectoffering","deprecated":false},{"title":"/v1/projects/{project_id}/offerings/{id}/metrics","summary":"Get Project Offering Metrics","prefix":{"name":"get","color":"get"},"badges":[],"link":"/projectofferings/getprojectofferingmetricsbyid","deprecated":false},{"title":"/v1/projects/{project_id}/offerings/{offering_id}/external-ids","summary":"Add External ID","prefix":{"name":"post","color":"post"},"badges":[],"link":"/projectofferings/addofferingexternalid","deprecated":false},{"title":"/v1/projects/{project_id}/offerings/{offering_id}/external-ids/{external_id}","summary":"Remove External ID","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/projectofferings/removeofferingexternalid","deprecated":false}]}]}]}]}},{"type":"group","label":"ProjectOtherCostsAndRevenue","link":"/api-documentation/swagger/projectothercostsandrevenue","routeSlug":"/api-documentation/swagger/projectothercostsandrevenue","items":[{"label":"List Other Costs and Revenue","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/projectothercostsandrevenue/listothercostsandrevenue","routeSlug":"/api-documentation/swagger/projectothercostsandrevenue/listothercostsandrevenue","metadata":{"seo":{"title":"List Other Costs and Revenue","description":"Returns a paginated list of one-time cost and revenue entries for the specified Project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListOtherCostsAndRevenue","name":"List Other Costs and Revenue","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{project_id}~1other-costs-and-revenue/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Other Costs and Revenue","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of one-time cost and revenue entries for the specified Project."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"project_id","in":"path","schemaId":"schema_104","description":"The unique identifier for the Project.","required":true}],"pointer":"/paths/~1v1~1projects~1{project_id}~1other-costs-and-revenue/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_66","description":"The specific page of results requested."},{"name":"page_size","in":"query","schemaId":"schema_67","description":"The number of results in each page."},{"name":"type","in":"query","schemaId":"schema_105","description":"Filter entries by type: \"cost\" or \"revenue\"."},{"name":"project_offering_id","in":"query","schemaId":"schema_106","description":"Filter entries by Project Offering ID."}],"pointer":"/paths/~1v1~1projects~1{project_id}~1other-costs-and-revenue/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{project_id}/other-costs-and-revenue","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"project_id","in":"path","required":true,"schemaId":"schema_104"}],"query":[{"name":"page","in":"query","schemaId":"schema_66"},{"name":"page_size","in":"query","schemaId":"schema_67"},{"name":"type","in":"query","schemaId":"schema_105"},{"name":"project_offering_id","in":"query","schemaId":"schema_106"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/projects/{project_id}/other-costs-and-revenue","href":"projectothercostsandrevenue/listothercostsandrevenue","openApiOperationId":"ListOtherCostsAndRevenue","summary":"List Other Costs and Revenue"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OtherCostAndRevenueDtoPagedResultsDto"}},"schemaId":"components/schemas/OtherCostAndRevenueDtoPagedResultsDto"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{project_id}~1other-costs-and-revenue/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OtherCostAndRevenueDtoPagedResultsDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OtherCostAndRevenueDtoPagedResultsDto"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projectothercostsandrevenue/listothercostsandrevenue"}],"panels":[]}]},"httpPath":"/v1/projects/{project_id}/other-costs-and-revenue"},{"label":"Create Other Cost or Revenue Entry","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/projectothercostsandrevenue/createothercostandrevenue","routeSlug":"/api-documentation/swagger/projectothercostsandrevenue/createothercostandrevenue","metadata":{"seo":{"title":"Create Other Cost or Revenue Entry","description":"Creates a new one-time cost or revenue entry for the specified Project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateOtherCostAndRevenue","name":"Create Other Cost or Revenue Entry","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{project_id}~1other-costs-and-revenue/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Other Cost or Revenue Entry","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new one-time cost or revenue entry for the specified Project."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"project_id","in":"path","schemaId":"schema_104","description":"The unique identifier for the Project.","required":true}],"pointer":"/paths/~1v1~1projects~1{project_id}~1other-costs-and-revenue/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_107"},"application/json":{"schemaId":"schema_107"}},"schemaId":"schema_107","pointer":"/paths/~1v1~1projects~1{project_id}~1other-costs-and-revenue/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{project_id}/other-costs-and-revenue","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"project_id","in":"path","required":true,"schemaId":"schema_104"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"schema_107"},"application/json":{"schemaId":"schema_107"}},"responseCodes":["201","400"],"pointer":"/v1/projects/{project_id}/other-costs-and-revenue","href":"projectothercostsandrevenue/createothercostandrevenue","openApiOperationId":"CreateOtherCostAndRevenue","summary":"Create Other Cost or Revenue Entry"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"schemaId":"schema_107","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_107"},"application/json":{"schemaId":"schema_107"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OtherCostAndRevenue"}},"schemaId":"components/schemas/OtherCostAndRevenue"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{project_id}~1other-costs-and-revenue/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/OtherCostAndRevenue","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OtherCostAndRevenue"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projectothercostsandrevenue/createothercostandrevenue"}],"panels":[]}]},"httpPath":"/v1/projects/{project_id}/other-costs-and-revenue"},{"label":"Delete Other Cost or Revenue Entry","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/projectothercostsandrevenue/deleteothercostandrevenue","routeSlug":"/api-documentation/swagger/projectothercostsandrevenue/deleteothercostandrevenue","metadata":{"seo":{"title":"Delete Other Cost or Revenue Entry","description":"Permanently removes a one-time cost or revenue entry from the Project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteOtherCostAndRevenue","name":"Delete Other Cost or Revenue Entry","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{project_id}~1other-costs-and-revenue~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Other Cost or Revenue Entry","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Permanently removes a one-time cost or revenue entry from the Project."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_108","description":"The unique identifier for the cost or revenue entry.","required":true},{"name":"project_id","in":"path","schemaId":"schema_104","description":"The unique identifier for the Project.","required":true}],"pointer":"/paths/~1v1~1projects~1{project_id}~1other-costs-and-revenue~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/projects/{project_id}/other-costs-and-revenue/{id}","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_108"},{"name":"project_id","in":"path","required":true,"schemaId":"schema_104"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204","400"],"pointer":"/v1/projects/{project_id}/other-costs-and-revenue/{id}","href":"projectothercostsandrevenue/deleteothercostandrevenue","openApiOperationId":"DeleteOtherCostAndRevenue","summary":"Delete Other Cost or Revenue Entry"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{project_id}~1other-costs-and-revenue~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projectothercostsandrevenue/deleteothercostandrevenue"}],"panels":[]}]},"httpPath":"/v1/projects/{project_id}/other-costs-and-revenue/{id}"},{"label":"Get Other Cost or Revenue Entry","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/projectothercostsandrevenue/getothercostandrevenuebyid","routeSlug":"/api-documentation/swagger/projectothercostsandrevenue/getothercostandrevenuebyid","metadata":{"seo":{"title":"Get Other Cost or Revenue Entry","description":"Returns a single one-time cost or revenue entry by its unique identifier."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetOtherCostAndRevenueById","name":"Get Other Cost or Revenue Entry","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{project_id}~1other-costs-and-revenue~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Other Cost or Revenue Entry","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a single one-time cost or revenue entry by its unique identifier."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_108","description":"The unique identifier for the cost or revenue entry.","required":true},{"name":"project_id","in":"path","schemaId":"schema_104","description":"The unique identifier for the Project.","required":true}],"pointer":"/paths/~1v1~1projects~1{project_id}~1other-costs-and-revenue~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{project_id}/other-costs-and-revenue/{id}","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_108"},{"name":"project_id","in":"path","required":true,"schemaId":"schema_104"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/projects/{project_id}/other-costs-and-revenue/{id}","href":"projectothercostsandrevenue/getothercostandrevenuebyid","openApiOperationId":"GetOtherCostAndRevenueById","summary":"Get Other Cost or Revenue Entry"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OtherCostAndRevenue"}},"schemaId":"components/schemas/OtherCostAndRevenue"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{project_id}~1other-costs-and-revenue~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OtherCostAndRevenue","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OtherCostAndRevenue"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projectothercostsandrevenue/getothercostandrevenuebyid"}],"panels":[]}]},"httpPath":"/v1/projects/{project_id}/other-costs-and-revenue/{id}"},{"label":"Update Other Cost or Revenue Entry","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/projectothercostsandrevenue/updateothercostandrevenue","routeSlug":"/api-documentation/swagger/projectothercostsandrevenue/updateothercostandrevenue","metadata":{"seo":{"title":"Update Other Cost or Revenue Entry","description":"Updates an existing one-time cost or revenue entry. Only the fields provided will be modified."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateOtherCostAndRevenue","name":"Update Other Cost or Revenue Entry","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{project_id}~1other-costs-and-revenue~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Other Cost or Revenue Entry","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing one-time cost or revenue entry. Only the fields provided will be modified."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_108","description":"The unique identifier for the cost or revenue entry.","required":true},{"name":"project_id","in":"path","schemaId":"schema_104","description":"The unique identifier for the Project.","required":true}],"pointer":"/paths/~1v1~1projects~1{project_id}~1other-costs-and-revenue~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_109"},"application/json":{"schemaId":"schema_109"}},"schemaId":"schema_109","pointer":"/paths/~1v1~1projects~1{project_id}~1other-costs-and-revenue~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/projects/{project_id}/other-costs-and-revenue/{id}","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_108"},{"name":"project_id","in":"path","required":true,"schemaId":"schema_104"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"schema_109"},"application/json":{"schemaId":"schema_109"}},"responseCodes":["200","400"],"pointer":"/v1/projects/{project_id}/other-costs-and-revenue/{id}","href":"projectothercostsandrevenue/updateothercostandrevenue","openApiOperationId":"UpdateOtherCostAndRevenue","summary":"Update Other Cost or Revenue Entry"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"schemaId":"schema_109","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_109"},"application/json":{"schemaId":"schema_109"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{project_id}~1other-costs-and-revenue~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projectothercostsandrevenue/updateothercostandrevenue"}],"panels":[]}]},"httpPath":"/v1/projects/{project_id}/other-costs-and-revenue/{id}"}],"content":{"contentType":"group","meta":{"name":"ProjectOtherCostsAndRevenue"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ProjectOtherCostsAndRevenue","showPageActions":true},{"nodeType":"markdoc","content":"Manage one-time (non-scheduled) cost and revenue entries for a Project."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/projects/{project_id}/other-costs-and-revenue","summary":"List Other Costs and Revenue","prefix":{"name":"get","color":"get"},"badges":[],"link":"/projectothercostsandrevenue/listothercostsandrevenue","deprecated":false},{"title":"/v1/projects/{project_id}/other-costs-and-revenue","summary":"Create Other Cost or Revenue Entry","prefix":{"name":"post","color":"post"},"badges":[],"link":"/projectothercostsandrevenue/createothercostandrevenue","deprecated":false},{"title":"/v1/projects/{project_id}/other-costs-and-revenue/{id}","summary":"Delete Other Cost or Revenue Entry","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/projectothercostsandrevenue/deleteothercostandrevenue","deprecated":false},{"title":"/v1/projects/{project_id}/other-costs-and-revenue/{id}","summary":"Get Other Cost or Revenue Entry","prefix":{"name":"get","color":"get"},"badges":[],"link":"/projectothercostsandrevenue/getothercostandrevenuebyid","deprecated":false},{"title":"/v1/projects/{project_id}/other-costs-and-revenue/{id}","summary":"Update Other Cost or Revenue Entry","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/projectothercostsandrevenue/updateothercostandrevenue","deprecated":false}]}]}]}]}},{"type":"group","label":"Projects","link":"/api-documentation/swagger/projects","routeSlug":"/api-documentation/swagger/projects","items":[{"label":"List Projects","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/projects/listprojects","routeSlug":"/api-documentation/swagger/projects/listprojects","metadata":{"seo":{"title":"List Projects","description":"Gets a paginated list of Projects in the system, including client and internal projects, for comprehensive visibility across your portfolio."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListProjects","name":"List Projects","isWebhook":false,"pointer":"/paths/~1v1~1projects/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Projects","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a paginated list of Projects in the system, including client and internal projects, for comprehensive visibility across your portfolio."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"external_id","in":"query","schemaId":"schema_83","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by external ID. For Parallax-managed integrations, use the format 'px_provider:id' (e.g., 'px_hubspot:12345'). For custom integrations, use the string format appropriate for that integration."},"children":[]}]}]}]},{"name":"sales_owner_id","in":"query","schemaId":"schema_110","description":"Filter by the Id of the Person who owns the sale of the Project."},{"name":"project_owner_id","in":"query","schemaId":"schema_111","description":"Filter by the Id of the Person who owns the Project."},{"name":"page","in":"query","schemaId":"schema_66","description":"The specific page of results requested."},{"name":"page_size","in":"query","schemaId":"schema_67","description":"The number of results in each page."},{"name":"archived","in":"query","schemaId":"schema_78","description":"Indicates if results should be filtered by their archived status."}],"pointer":"/paths/~1v1~1projects/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[],"query":[{"name":"external_id","in":"query","schemaId":"schema_83"},{"name":"sales_owner_id","in":"query","schemaId":"schema_110"},{"name":"project_owner_id","in":"query","schemaId":"schema_111"},{"name":"page","in":"query","schemaId":"schema_66"},{"name":"page_size","in":"query","schemaId":"schema_67"},{"name":"archived","in":"query","schemaId":"schema_78"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/projects","href":"projects/listprojects","openApiOperationId":"ListProjects","summary":"List Projects"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectDtoPagedResultsDto"}},"schemaId":"components/schemas/ProjectDtoPagedResultsDto"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1projects/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProjectDtoPagedResultsDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectDtoPagedResultsDto"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projects/listprojects"}],"panels":[]}]},"httpPath":"/v1/projects"},{"label":"Create Project","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/projects/createproject","routeSlug":"/api-documentation/swagger/projects/createproject","metadata":{"seo":{"title":"Create Project","description":"Creates a new Project entity, serving as the main container for Project Offerings."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateProject","name":"Create Project","isWebhook":false,"pointer":"/paths/~1v1~1projects/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Project","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new Project entity, serving as the main container for Project Offerings."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_112"},"application/json":{"schemaId":"schema_112"}},"schemaId":"schema_112","pointer":"/paths/~1v1~1projects/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"schema_112"},"application/json":{"schemaId":"schema_112"}},"responseCodes":["201","400"],"pointer":"/v1/projects","href":"projects/createproject","openApiOperationId":"CreateProject","summary":"Create Project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"schemaId":"schema_112","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_112"},"application/json":{"schemaId":"schema_112"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Project"}},"schemaId":"components/schemas/Project"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1projects/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Project","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Project"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projects/createproject"}],"panels":[]}]},"httpPath":"/v1/projects"},{"label":"Get Project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/projects/getproject","routeSlug":"/api-documentation/swagger/projects/getproject","metadata":{"seo":{"title":"Get Project","description":"Gets a specific project's full details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetProject","name":"Get Project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Project","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a specific project's full details."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_73","description":"ID of the resource","required":true}],"pointer":"/paths/~1v1~1projects~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/projects/{id}","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_73"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/projects/{id}","href":"projects/getproject","openApiOperationId":"GetProject","summary":"Get Project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Project"}},"schemaId":"components/schemas/Project"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Project","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Project"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projects/getproject"}],"panels":[]}]},"httpPath":"/v1/projects/{id}"},{"label":"Update Project","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/projects/updateproject","routeSlug":"/api-documentation/swagger/projects/updateproject","metadata":{"seo":{"title":"Update Project","description":"Updates project-level details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateProject","name":"Update Project","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Project","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates project-level details."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_73","description":"ID of the resource","required":true}],"pointer":"/paths/~1v1~1projects~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_113"},"application/json":{"schemaId":"schema_113"}},"schemaId":"schema_113","pointer":"/paths/~1v1~1projects~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/projects/{id}","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_73"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"schema_113"},"application/json":{"schemaId":"schema_113"}},"responseCodes":["200","400"],"pointer":"/v1/projects/{id}","href":"projects/updateproject","openApiOperationId":"UpdateProject","summary":"Update Project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"schemaId":"schema_113","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_113"},"application/json":{"schemaId":"schema_113"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projects/updateproject"}],"panels":[]}]},"httpPath":"/v1/projects/{id}"},{"label":"Add External ID","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/projects/addexternalid","routeSlug":"/api-documentation/swagger/projects/addexternalid","metadata":{"seo":{"title":"Add External ID","description":"Adds a custom integration external identifier to a Project. This can be any opaque string used to correlate the Project with a record in an external system. Strings starting with a reserved 'px_' provider prefix (e.g., 'px_hubspot:') are reserved for use by Parallax integrations and not allowed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AddExternalId","name":"Add External ID","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{id}~1external-ids/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add External ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds a custom integration external identifier to a Project. This can be any opaque string used to correlate the Project with a record in an external system. Strings starting with a reserved 'px_' provider prefix (e.g., 'px_hubspot:') are reserved for use by Parallax integrations and not allowed."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_73","description":"ID of the resource","required":true}],"pointer":"/paths/~1v1~1projects~1{id}~1external-ids/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_114"},"application/json":{"schemaId":"schema_114"}},"schemaId":"schema_114","pointer":"/paths/~1v1~1projects~1{id}~1external-ids/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{id}/external-ids","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_73"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"schema_114"},"application/json":{"schemaId":"schema_114"}},"responseCodes":["201","400"],"pointer":"/v1/projects/{id}/external-ids","href":"projects/addexternalid","openApiOperationId":"AddExternalId","summary":"Add External ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"schemaId":"schema_114","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_114"},"application/json":{"schemaId":"schema_114"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{id}~1external-ids/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projects/addexternalid"}],"panels":[]}]},"httpPath":"/v1/projects/{id}/external-ids"},{"label":"Remove External ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/projects/removeexternalid","routeSlug":"/api-documentation/swagger/projects/removeexternalid","metadata":{"seo":{"title":"Remove External ID","description":"Removes a custom integration external identifier from a Project."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RemoveExternalId","name":"Remove External ID","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{id}~1external-ids~1{external_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove External ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Removes a custom integration external identifier from a Project."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_73","description":"ID of the resource","required":true},{"name":"external_id","in":"path","schemaId":"schema_87","required":true}],"pointer":"/paths/~1v1~1projects~1{id}~1external-ids~1{external_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/projects/{id}/external-ids/{external_id}","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_73"},{"name":"external_id","in":"path","required":true,"schemaId":"schema_87"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204","400"],"pointer":"/v1/projects/{id}/external-ids/{external_id}","href":"projects/removeexternalid","openApiOperationId":"RemoveExternalId","summary":"Remove External ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{id}~1external-ids~1{external_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projects/removeexternalid"}],"panels":[]}]},"httpPath":"/v1/projects/{id}/external-ids/{external_id}"},{"label":"Merge Projects","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/projects/mergeprojects","routeSlug":"/api-documentation/swagger/projects/mergeprojects","metadata":{"seo":{"title":"Merge Projects","description":"Merges a source project into a target project, consolidating all project offerings, roles, and associated data from the source into the target. This operation cannot be undone. Projects with actual time on them cannot be the source of a merge."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"MergeProjects","name":"Merge Projects","isWebhook":false,"pointer":"/paths/~1v1~1projects~1{target_id}~1merge~1{source_id}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Merge Projects","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Merges a source project into a target project, consolidating all project offerings, roles, and associated data from the source into the target. This operation cannot be undone. Projects with actual time on them cannot be the source of a merge."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"target_id","in":"path","schemaId":"schema_73","required":true},{"name":"source_id","in":"path","schemaId":"schema_73","required":true}],"pointer":"/paths/~1v1~1projects~1{target_id}~1merge~1{source_id}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/projects/{target_id}/merge/{source_id}","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"target_id","in":"path","required":true,"schemaId":"schema_73"},{"name":"source_id","in":"path","required":true,"schemaId":"schema_73"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204","400"],"pointer":"/v1/projects/{target_id}/merge/{source_id}","href":"projects/mergeprojects","openApiOperationId":"MergeProjects","summary":"Merge Projects"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1projects~1{target_id}~1merge~1{source_id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projects/mergeprojects"}],"panels":[]}]},"httpPath":"/v1/projects/{target_id}/merge/{source_id}"}],"content":{"contentType":"group","meta":{"name":"Projects"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Projects","showPageActions":true},{"nodeType":"markdoc","content":"A Project represents a distinct engagement or scope of work that the organization is delivering for a Client. Projects serve as containers for Project Offerings."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/projects","summary":"List Projects","prefix":{"name":"get","color":"get"},"badges":[],"link":"/projects/listprojects","deprecated":false},{"title":"/v1/projects","summary":"Create Project","prefix":{"name":"post","color":"post"},"badges":[],"link":"/projects/createproject","deprecated":false},{"title":"/v1/projects/{id}","summary":"Get Project","prefix":{"name":"get","color":"get"},"badges":[],"link":"/projects/getproject","deprecated":false},{"title":"/v1/projects/{id}","summary":"Update Project","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/projects/updateproject","deprecated":false},{"title":"/v1/projects/{id}/external-ids","summary":"Add External ID","prefix":{"name":"post","color":"post"},"badges":[],"link":"/projects/addexternalid","deprecated":false},{"title":"/v1/projects/{id}/external-ids/{external_id}","summary":"Remove External ID","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/projects/removeexternalid","deprecated":false},{"title":"/v1/projects/{target_id}/merge/{source_id}","summary":"Merge Projects","prefix":{"name":"post","color":"post"},"badges":[],"link":"/projects/mergeprojects","deprecated":false}]}]}]}]}},{"type":"group","label":"RateCardRates","link":"/api-documentation/swagger/ratecardrates","routeSlug":"/api-documentation/swagger/ratecardrates","items":[{"label":"List Rate Card Rates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/ratecardrates/listratecardrates","routeSlug":"/api-documentation/swagger/ratecardrates/listratecardrates","metadata":{"seo":{"title":"List Rate Card Rates","description":"Gets a paginated list of rates for all roles on a specific rate card."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListRateCardRates","name":"List Rate Card Rates","isWebhook":false,"pointer":"/paths/~1v1~1rate-cards~1{rate_card_id}~1rates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Rate Card Rates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a paginated list of rates for all roles on a specific rate card."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rate_card_id","in":"path","schemaId":"schema_73","required":true}],"pointer":"/paths/~1v1~1rate-cards~1{rate_card_id}~1rates/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_66","description":"The specific page of results requested."},{"name":"page_size","in":"query","schemaId":"schema_67","description":"The number of results in each page."}],"pointer":"/paths/~1v1~1rate-cards~1{rate_card_id}~1rates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/rate-cards/{rate_card_id}/rates","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"rate_card_id","in":"path","required":true,"schemaId":"schema_73"}],"query":[{"name":"page","in":"query","schemaId":"schema_66"},{"name":"page_size","in":"query","schemaId":"schema_67"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/rate-cards/{rate_card_id}/rates","href":"ratecardrates/listratecardrates","openApiOperationId":"ListRateCardRates","summary":"List Rate Card Rates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RateCardRateDtoPagedResultsDto"}},"schemaId":"components/schemas/RateCardRateDtoPagedResultsDto"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1rate-cards~1{rate_card_id}~1rates/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RateCardRateDtoPagedResultsDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RateCardRateDtoPagedResultsDto"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ratecardrates/listratecardrates"}],"panels":[]}]},"httpPath":"/v1/rate-cards/{rate_card_id}/rates"}],"content":{"contentType":"group","meta":{"name":"RateCardRates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"RateCardRates","showPageActions":true},{"nodeType":"markdoc","content":"Rate Card Rates represent the billable rates for specific roles within a Rate Card."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/rate-cards/{rate_card_id}/rates","summary":"List Rate Card Rates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ratecardrates/listratecardrates","deprecated":false}]}]}]}]}},{"type":"group","label":"RateCards","link":"/api-documentation/swagger/ratecards","routeSlug":"/api-documentation/swagger/ratecards","items":[{"label":"List Rate Cards","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/ratecards/listratecards","routeSlug":"/api-documentation/swagger/ratecards/listratecards","metadata":{"seo":{"title":"List Rate Cards","description":"Returns a paginated list of Rate Cards."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListRateCards","name":"List Rate Cards","isWebhook":false,"pointer":"/paths/~1v1~1rate-cards/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Rate Cards","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of Rate Cards."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_66","description":"The specific page of results requested."},{"name":"page_size","in":"query","schemaId":"schema_67","description":"The number of results in each page."},{"name":"archived","in":"query","schemaId":"schema_78","description":"Indicates if results should be filtered by their archived status."}],"pointer":"/paths/~1v1~1rate-cards/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/rate-cards","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"schema_66"},{"name":"page_size","in":"query","schemaId":"schema_67"},{"name":"archived","in":"query","schemaId":"schema_78"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/rate-cards","href":"ratecards/listratecards","openApiOperationId":"ListRateCards","summary":"List Rate Cards"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RateCardDtoPagedResultsDto"}},"schemaId":"components/schemas/RateCardDtoPagedResultsDto"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1rate-cards/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RateCardDtoPagedResultsDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RateCardDtoPagedResultsDto"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ratecards/listratecards"}],"panels":[]}]},"httpPath":"/v1/rate-cards"}],"content":{"contentType":"group","meta":{"name":"RateCards"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"RateCards","showPageActions":true},{"nodeType":"markdoc","content":"A Rate Card represents a list of roles with a standard bill rate for each role."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/rate-cards","summary":"List Rate Cards","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ratecards/listratecards","deprecated":false}]}]}]}]}},{"type":"group","label":"Roles","link":"/api-documentation/swagger/roles","routeSlug":"/api-documentation/swagger/roles","items":[{"label":"List Roles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/roles/listroles","routeSlug":"/api-documentation/swagger/roles/listroles","metadata":{"seo":{"title":"List Roles","description":"Returns paginated list of defined roles used in shaping resource plans, typically categorized by department and used to match people to work."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListRoles","name":"List Roles","isWebhook":false,"pointer":"/paths/~1v1~1roles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Roles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns paginated list of defined roles used in shaping resource plans, typically categorized by department and used to match people to work."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_66","description":"The specific page of results requested."},{"name":"page_size","in":"query","schemaId":"schema_67","description":"The number of results in each page."},{"name":"archived","in":"query","schemaId":"schema_78","description":"Indicates if results should be filtered by their archived status."}],"pointer":"/paths/~1v1~1roles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/roles","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"schema_66"},{"name":"page_size","in":"query","schemaId":"schema_67"},{"name":"archived","in":"query","schemaId":"schema_78"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/roles","href":"roles/listroles","openApiOperationId":"ListRoles","summary":"List Roles"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RoleDtoPagedResultsDto"}},"schemaId":"components/schemas/RoleDtoPagedResultsDto"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1roles/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RoleDtoPagedResultsDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RoleDtoPagedResultsDto"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/roles/listroles"}],"panels":[]}]},"httpPath":"/v1/roles"},{"label":"Create Role","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/roles/createrole","routeSlug":"/api-documentation/swagger/roles/createrole","metadata":{"seo":{"title":"Create Role","description":"Creates a new role within a department to be used for shaping, planning, and reporting."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateRole","name":"Create Role","isWebhook":false,"pointer":"/paths/~1v1~1roles/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new role within a department to be used for shaping, planning, and reporting."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_115"},"application/json":{"schemaId":"schema_115"}},"schemaId":"schema_115","pointer":"/paths/~1v1~1roles/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/roles","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"schema_115"},"application/json":{"schemaId":"schema_115"}},"responseCodes":["201","400"],"pointer":"/v1/roles","href":"roles/createrole","openApiOperationId":"CreateRole","summary":"Create Role"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"schemaId":"schema_115","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_115"},"application/json":{"schemaId":"schema_115"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Role"}},"schemaId":"components/schemas/Role"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1roles/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Role","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Role"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/roles/createrole"}],"panels":[]}]},"httpPath":"/v1/roles"},{"label":"Get Role","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/roles/getrole","routeSlug":"/api-documentation/swagger/roles/getrole","metadata":{"seo":{"title":"Get Role","description":"Gets details of a specific role used for shaping, planning, and reporting."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetRole","name":"Get Role","isWebhook":false,"pointer":"/paths/~1v1~1roles~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets details of a specific role used for shaping, planning, and reporting."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_73","description":"ID of the resource","required":true}],"pointer":"/paths/~1v1~1roles~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/roles/{id}","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_73"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/roles/{id}","href":"roles/getrole","openApiOperationId":"GetRole","summary":"Get Role"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Role"}},"schemaId":"components/schemas/Role"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1roles~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Role","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Role"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/roles/getrole"}],"panels":[]}]},"httpPath":"/v1/roles/{id}"},{"label":"Update Role","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/roles/updaterole","routeSlug":"/api-documentation/swagger/roles/updaterole","metadata":{"seo":{"title":"Update Role","description":"Updates an existing role's properties including name, department, capacity, and utilization targets."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateRole","name":"Update Role","isWebhook":false,"pointer":"/paths/~1v1~1roles~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing role's properties including name, department, capacity, and utilization targets."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_73","description":"ID of the resource","required":true}],"pointer":"/paths/~1v1~1roles~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_116"},"application/json":{"schemaId":"schema_116"}},"schemaId":"schema_116","pointer":"/paths/~1v1~1roles~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/roles/{id}","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_73"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"schema_116"},"application/json":{"schemaId":"schema_116"}},"responseCodes":["200","400"],"pointer":"/v1/roles/{id}","href":"roles/updaterole","openApiOperationId":"UpdateRole","summary":"Update Role"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"schemaId":"schema_116","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_116"},"application/json":{"schemaId":"schema_116"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1roles~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/roles/updaterole"}],"panels":[]}]},"httpPath":"/v1/roles/{id}"}],"content":{"contentType":"group","meta":{"name":"Roles"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Roles","showPageActions":true},{"nodeType":"markdoc","content":"A Role defines the type of work or skill set associated with resource assignments to project offerings. Roles are used to categorize resources, shape staffing needs, and support forecasting by identifying which types of personnel are required for each project offering."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/roles","summary":"List Roles","prefix":{"name":"get","color":"get"},"badges":[],"link":"/roles/listroles","deprecated":false},{"title":"/v1/roles","summary":"Create Role","prefix":{"name":"post","color":"post"},"badges":[],"link":"/roles/createrole","deprecated":false},{"title":"/v1/roles/{id}","summary":"Get Role","prefix":{"name":"get","color":"get"},"badges":[],"link":"/roles/getrole","deprecated":false},{"title":"/v1/roles/{id}","summary":"Update Role","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/roles/updaterole","deprecated":false}]}]}]}]}},{"type":"group","label":"ServiceOfferings","link":"/api-documentation/swagger/serviceofferings","routeSlug":"/api-documentation/swagger/serviceofferings","items":[{"label":"List Service Offerings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/serviceofferings/listserviceofferings","routeSlug":"/api-documentation/swagger/serviceofferings/listserviceofferings","metadata":{"seo":{"title":"List Service Offerings","description":"Returns a paginated list of Service Offerings."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListServiceOfferings","name":"List Service Offerings","isWebhook":false,"pointer":"/paths/~1v1~1service-offerings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Service Offerings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of Service Offerings."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_66","description":"The specific page of results requested."},{"name":"page_size","in":"query","schemaId":"schema_67","description":"The number of results in each page."}],"pointer":"/paths/~1v1~1service-offerings/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/service-offerings","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"schema_66"},{"name":"page_size","in":"query","schemaId":"schema_67"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/service-offerings","href":"serviceofferings/listserviceofferings","openApiOperationId":"ListServiceOfferings","summary":"List Service Offerings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceOfferingDtoPagedResultsDto"}},"schemaId":"components/schemas/ServiceOfferingDtoPagedResultsDto"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1service-offerings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ServiceOfferingDtoPagedResultsDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceOfferingDtoPagedResultsDto"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/serviceofferings/listserviceofferings"}],"panels":[]}]},"httpPath":"/v1/service-offerings"}],"content":{"contentType":"group","meta":{"name":"ServiceOfferings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ServiceOfferings","showPageActions":true},{"nodeType":"markdoc","content":"A Service Offering is a reusable template of roles and plan allocations that can be copied onto a Project Offering, helping standardize how common scopes of work are staffed."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/service-offerings","summary":"List Service Offerings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/serviceofferings/listserviceofferings","deprecated":false}]}]}]}]}},{"type":"group","label":"Stages","link":"/api-documentation/swagger/stages","routeSlug":"/api-documentation/swagger/stages","items":[{"label":"List Pipeline Stages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/stages/liststages","routeSlug":"/api-documentation/swagger/stages/liststages","metadata":{"seo":{"title":"List Pipeline Stages","description":"Gets all pipeline stages reflected in the specified sales pipeline, enabling alignment between sales forecasting and project readiness."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListStages","name":"List Pipeline Stages","isWebhook":false,"pointer":"/paths/~1v1~1pipelines~1{pipeline_id}~1stages/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Pipeline Stages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets all pipeline stages reflected in the specified sales pipeline, enabling alignment between sales forecasting and project readiness."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pipeline_id","in":"path","schemaId":"schema_73","required":true}],"pointer":"/paths/~1v1~1pipelines~1{pipeline_id}~1stages/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_66","description":"The specific page of results requested."},{"name":"page_size","in":"query","schemaId":"schema_67","description":"The number of results in each page."},{"name":"archived","in":"query","schemaId":"schema_78","description":"Indicates if results should be filtered by their archived status."}],"pointer":"/paths/~1v1~1pipelines~1{pipeline_id}~1stages/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/pipelines/{pipeline_id}/stages","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"pipeline_id","in":"path","required":true,"schemaId":"schema_73"}],"query":[{"name":"page","in":"query","schemaId":"schema_66"},{"name":"page_size","in":"query","schemaId":"schema_67"},{"name":"archived","in":"query","schemaId":"schema_78"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/pipelines/{pipeline_id}/stages","href":"stages/liststages","openApiOperationId":"ListStages","summary":"List Pipeline Stages"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StageDtoPagedResultsDto"}},"schemaId":"components/schemas/StageDtoPagedResultsDto"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1pipelines~1{pipeline_id}~1stages/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/StageDtoPagedResultsDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StageDtoPagedResultsDto"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stages/liststages"}],"panels":[]}]},"httpPath":"/v1/pipelines/{pipeline_id}/stages"},{"label":"Create Pipeline Stage","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/stages/createstage","routeSlug":"/api-documentation/swagger/stages/createstage","metadata":{"seo":{"title":"Create Pipeline Stage","description":"Adds a new sales stage to the specified pipeline mapping in Parallax, aligning sales progress with resourcing needs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateStage","name":"Create Pipeline Stage","isWebhook":false,"pointer":"/paths/~1v1~1pipelines~1{pipeline_id}~1stages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Pipeline Stage","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adds a new sales stage to the specified pipeline mapping in Parallax, aligning sales progress with resourcing needs."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pipeline_id","in":"path","schemaId":"schema_73","required":true}],"pointer":"/paths/~1v1~1pipelines~1{pipeline_id}~1stages/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_117"},"application/json":{"schemaId":"schema_117"}},"schemaId":"schema_117","pointer":"/paths/~1v1~1pipelines~1{pipeline_id}~1stages/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/pipelines/{pipeline_id}/stages","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"pipeline_id","in":"path","required":true,"schemaId":"schema_73"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"schema_117"},"application/json":{"schemaId":"schema_117"}},"responseCodes":["201","400"],"pointer":"/v1/pipelines/{pipeline_id}/stages","href":"stages/createstage","openApiOperationId":"CreateStage","summary":"Create Pipeline Stage"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"schemaId":"schema_117","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_117"},"application/json":{"schemaId":"schema_117"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Stage"}},"schemaId":"components/schemas/Stage"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1pipelines~1{pipeline_id}~1stages/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Stage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Stage"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stages/createstage"}],"panels":[]}]},"httpPath":"/v1/pipelines/{pipeline_id}/stages"},{"label":"Get Pipeline Stage","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/stages/getstage","routeSlug":"/api-documentation/swagger/stages/getstage","metadata":{"seo":{"title":"Get Pipeline Stage","description":"Gets details of a pipeline stage used in sales pipeline alignment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetStage","name":"Get Pipeline Stage","isWebhook":false,"pointer":"/paths/~1v1~1pipelines~1{pipeline_id}~1stages~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Pipeline Stage","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets details of a pipeline stage used in sales pipeline alignment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_73","description":"ID of the resource","required":true},{"name":"pipeline_id","in":"path","schemaId":"schema_73","required":true}],"pointer":"/paths/~1v1~1pipelines~1{pipeline_id}~1stages~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/pipelines/{pipeline_id}/stages/{id}","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_73"},{"name":"pipeline_id","in":"path","required":true,"schemaId":"schema_73"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/pipelines/{pipeline_id}/stages/{id}","href":"stages/getstage","openApiOperationId":"GetStage","summary":"Get Pipeline Stage"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Stage"}},"schemaId":"components/schemas/Stage"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1pipelines~1{pipeline_id}~1stages~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Stage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Stage"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stages/getstage"}],"panels":[]}]},"httpPath":"/v1/pipelines/{pipeline_id}/stages/{id}"},{"label":"Update Pipeline Stage","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/stages/updatestage","routeSlug":"/api-documentation/swagger/stages/updatestage","metadata":{"seo":{"title":"Update Pipeline Stage","description":"Updates a stage in the pipeline used to mirror opportunity progress into Parallax."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateStage","name":"Update Pipeline Stage","isWebhook":false,"pointer":"/paths/~1v1~1pipelines~1{pipeline_id}~1stages~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Pipeline Stage","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a stage in the pipeline used to mirror opportunity progress into Parallax."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_73","description":"ID of the resource","required":true},{"name":"pipeline_id","in":"path","schemaId":"schema_73","required":true}],"pointer":"/paths/~1v1~1pipelines~1{pipeline_id}~1stages~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_118"},"application/json":{"schemaId":"schema_118"}},"schemaId":"schema_118","pointer":"/paths/~1v1~1pipelines~1{pipeline_id}~1stages~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/pipelines/{pipeline_id}/stages/{id}","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_73"},{"name":"pipeline_id","in":"path","required":true,"schemaId":"schema_73"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"schema_118"},"application/json":{"schemaId":"schema_118"}},"responseCodes":["200","400"],"pointer":"/v1/pipelines/{pipeline_id}/stages/{id}","href":"stages/updatestage","openApiOperationId":"UpdateStage","summary":"Update Pipeline Stage"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"schemaId":"schema_118","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_118"},"application/json":{"schemaId":"schema_118"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1pipelines~1{pipeline_id}~1stages~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stages/updatestage"}],"panels":[]}]},"httpPath":"/v1/pipelines/{pipeline_id}/stages/{id}"}],"content":{"contentType":"group","meta":{"name":"Stages"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Stages","showPageActions":true},{"nodeType":"markdoc","content":"A Pipeline Stage represents a single stage within the Pipeline, mapping directly to the stages defined in the system. Pipeline Stages allow for real-time visibility into opportunity status and expected resource demand throughout the sales process."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/pipelines/{pipeline_id}/stages","summary":"List Pipeline Stages","prefix":{"name":"get","color":"get"},"badges":[],"link":"/stages/liststages","deprecated":false},{"title":"/v1/pipelines/{pipeline_id}/stages","summary":"Create Pipeline Stage","prefix":{"name":"post","color":"post"},"badges":[],"link":"/stages/createstage","deprecated":false},{"title":"/v1/pipelines/{pipeline_id}/stages/{id}","summary":"Get Pipeline Stage","prefix":{"name":"get","color":"get"},"badges":[],"link":"/stages/getstage","deprecated":false},{"title":"/v1/pipelines/{pipeline_id}/stages/{id}","summary":"Update Pipeline Stage","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/stages/updatestage","deprecated":false}]}]}]}]}},{"type":"group","label":"Tags","link":"/api-documentation/swagger/tags","routeSlug":"/api-documentation/swagger/tags","items":[{"label":"Delete a Tag","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/tags/deletetag","routeSlug":"/api-documentation/swagger/tags/deletetag","metadata":{"seo":{"title":"Delete a Tag","description":"Removes a tag from the organization's tag list so it can no longer be applied to new entities. The tag is also removed from every entity it had previously been added to, which can take additional time to be reflected across the system. The tag is supplied as the URL-encoded tag query parameter rather than a path segment, because tag names may contain /. A category can only be deleted once no tags remain within it; attempting to delete a category that still has tags returns a conflict."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteTag","name":"Delete a Tag","isWebhook":false,"pointer":"/paths/~1v1~1tags/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Removes a tag from the organization's tag list so it can no longer be applied to new entities. The tag is also removed from every entity it had previously been added to, which can take additional time to be reflected across the system. The tag is supplied as the URL-encoded "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter rather than a path segment, because tag names may contain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A category can only be deleted once no tags remain within it; attempting to delete a category that still has tags returns a conflict."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"tag","in":"query","schemaId":"schema_87","required":true}],"pointer":"/paths/~1v1~1tags/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/tags","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[],"query":[{"name":"tag","in":"query","required":true,"schemaId":"schema_87"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204","400"],"pointer":"/v1/tags","href":"tags/deletetag","openApiOperationId":"DeleteTag","summary":"Delete a Tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1tags/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/deletetag"}],"panels":[]}]},"httpPath":"/v1/tags"},{"label":"List all Tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/tags/listtags","routeSlug":"/api-documentation/swagger/tags/listtags","metadata":{"seo":{"title":"List all Tags","description":"Returns all custom tags used throughout the system for categorization, filtering, and segmentation of people, projects, or clients."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListTags","name":"List all Tags","isWebhook":false,"pointer":"/paths/~1v1~1tags/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all Tags","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all custom tags used throughout the system for categorization, filtering, and segmentation of people, projects, or clients."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/tags","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/tags","href":"tags/listtags","openApiOperationId":"ListTags","summary":"List all Tags"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TagList"}},"schemaId":"components/schemas/TagList"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1tags/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TagList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TagList"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/listtags"}],"panels":[]}]},"httpPath":"/v1/tags"},{"label":"Create a Tag","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/tags/createtag","routeSlug":"/api-documentation/swagger/tags/createtag","metadata":{"seo":{"title":"Create a Tag","description":"Adds a tag to the organization's tag list so it can be applied to people, projects, or clients. If the tag's category does not exist yet, it is created automatically. Tags are compared case-insensitively, so creating a tag that already exists leaves the existing tag untouched."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateTag","name":"Create a Tag","isWebhook":false,"pointer":"/paths/~1v1~1tags/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adds a tag to the organization's tag list so it can be applied to people, projects, or clients. If the tag's category does not exist yet, it is created automatically. Tags are compared case-insensitively, so creating a tag that already exists leaves the existing tag untouched."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_119"},"application/json":{"schemaId":"schema_119"}},"schemaId":"schema_119","pointer":"/paths/~1v1~1tags/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/tags","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"schema_119"},"application/json":{"schemaId":"schema_119"}},"responseCodes":["201","400"],"pointer":"/v1/tags","href":"tags/createtag","openApiOperationId":"CreateTag","summary":"Create a Tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"schemaId":"schema_119","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_119"},"application/json":{"schemaId":"schema_119"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Tag"}},"schemaId":"components/schemas/Tag"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1tags/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Tag","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Tag"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/createtag"}],"panels":[]}]},"httpPath":"/v1/tags"},{"label":"Update a Tag","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/tags/updatetag","routeSlug":"/api-documentation/swagger/tags/updatetag","metadata":{"seo":{"title":"Update a Tag","description":"Renames a tag in the organization's tag list. The new name is applied to every entity that had previously been given the current tag, which can take additional time to be reflected across the system. If the current tag names a category (ends with ::), every tag within that category is renamed to use the new category name as well. Tags are compared case-insensitively."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateTag","name":"Update a Tag","isWebhook":false,"pointer":"/paths/~1v1~1tags~1rename/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a Tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Renames a tag in the organization's tag list. The new name is applied to every entity that had previously been given the current tag, which can take additional time to be reflected across the system. If the current tag names a category (ends with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"::"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), every tag within that category is renamed to use the new category name as well. Tags are compared case-insensitively."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_120"},"application/json":{"schemaId":"schema_120"}},"schemaId":"schema_120","pointer":"/paths/~1v1~1tags~1rename/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/tags/rename","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"schema_120"},"application/json":{"schemaId":"schema_120"}},"responseCodes":["204","400"],"pointer":"/v1/tags/rename","href":"tags/updatetag","openApiOperationId":"UpdateTag","summary":"Update a Tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"schemaId":"schema_120","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_120"},"application/json":{"schemaId":"schema_120"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1tags~1rename/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/updatetag"}],"panels":[]}]},"httpPath":"/v1/tags/rename"}],"content":{"contentType":"group","meta":{"name":"Tags"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tags","showPageActions":true},{"nodeType":"markdoc","content":"A Tag is a flexible metadata label used to categorize and filter entities such as People, Projects, and Project Offering Roles. Tags support custom grouping, reporting, and segmentation across multiple areas of the platform, enabling organizations to adapt Parallax to their internal business structures and workflows."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/tags","summary":"Delete a Tag","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tags/deletetag","deprecated":false},{"title":"/v1/tags","summary":"List all Tags","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tags/listtags","deprecated":false},{"title":"/v1/tags","summary":"Create a Tag","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tags/createtag","deprecated":false},{"title":"/v1/tags/rename","summary":"Update a Tag","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tags/updatetag","deprecated":false}]}]}]}]}},{"type":"group","label":"TimesheetEntries","link":"/api-documentation/swagger/timesheetentries","routeSlug":"/api-documentation/swagger/timesheetentries","items":[{"label":"List Timesheet Entries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/timesheetentries/listtimesheetentries","routeSlug":"/api-documentation/swagger/timesheetentries/listtimesheetentries","metadata":{"seo":{"title":"List Timesheet Entries","description":"Gets a paginated list of timesheet entries recorded for a given time period with optional filtering by project offering, approval status, and etc. When no start or end date filters are provided, returns entries from the last 7 days (7 days ago through today)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListTimesheetEntries","name":"List Timesheet Entries","isWebhook":false,"pointer":"/paths/~1v1~1timesheet-entries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Timesheet Entries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a paginated list of timesheet entries recorded for a given time period with optional filtering by project offering, approval status, and etc. When no start or end date filters are provided, returns entries from the last 7 days (7 days ago through today)."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_66","description":"The specific page of results requested."},{"name":"page_size","in":"query","schemaId":"schema_67","description":"The number of results in each page."},{"name":"start_date","in":"query","schemaId":"schema_121","description":"Filter by entries recorded on or after this date. When not provided, defaults to 7 days ago from today. Currently, this endpoint requires the queried date range to not exceed 31 days. You must specify an end date filter when specifying this value. ISO date formatting expected (yyyy-MM-dd)"},{"name":"end_date","in":"query","schemaId":"schema_122","description":"Filter by entries recorded on or before this date. When not provided, defaults to today. You must specify an start date filter when specifying this value. ISO date formatting expected (yyyy-MM-dd)"},{"name":"approval_status","in":"query","schemaId":"schema_123"},{"name":"approval_status_start_date","in":"query","schemaId":"schema_124","description":"Optional filter for entries with an approval status change on or after this date. Currently, this endpoint requires the queried date range to not exceed 31 days. You must specify an approval status end date filter when specifying this value. ISO date formatting expected (yyyy-MM-dd)"},{"name":"approval_status_end_date","in":"query","schemaId":"schema_125","description":"Optional filter for entries with an approval status change on or before this date. You must specify an approval status start date filter when specifying this value. ISO date formatting expected (yyyy-MM-dd)"},{"name":"project_id","in":"query","schemaId":"schema_126","description":"The id of the project in which the time entry belongs to."},{"name":"project_offering_id","in":"query","schemaId":"schema_127","description":"The id of the project offering in which the time entry belongs to."}],"pointer":"/paths/~1v1~1timesheet-entries/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/timesheet-entries","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"schema_66"},{"name":"page_size","in":"query","schemaId":"schema_67"},{"name":"start_date","in":"query","schemaId":"schema_121"},{"name":"end_date","in":"query","schemaId":"schema_122"},{"name":"approval_status","in":"query","schemaId":"schema_123"},{"name":"approval_status_start_date","in":"query","schemaId":"schema_124"},{"name":"approval_status_end_date","in":"query","schemaId":"schema_125"},{"name":"project_id","in":"query","schemaId":"schema_126"},{"name":"project_offering_id","in":"query","schemaId":"schema_127"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/timesheet-entries","href":"timesheetentries/listtimesheetentries","openApiOperationId":"ListTimesheetEntries","summary":"List Timesheet Entries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TimesheetEntryDtoPagedResultsDto"}},"schemaId":"components/schemas/TimesheetEntryDtoPagedResultsDto"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1timesheet-entries/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TimesheetEntryDtoPagedResultsDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TimesheetEntryDtoPagedResultsDto"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/timesheetentries/listtimesheetentries"}],"panels":[]}]},"httpPath":"/v1/timesheet-entries"}],"content":{"contentType":"group","meta":{"name":"TimesheetEntries"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"TimesheetEntries","showPageActions":true},{"nodeType":"markdoc","content":"Timesheet Entries represent time recorded within the Parallax Timesheets service, including additional properties related approval state."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/timesheet-entries","summary":"List Timesheet Entries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/timesheetentries/listtimesheetentries","deprecated":false}]}]}]}]}},{"type":"group","label":"WebhookSubscribers","link":"/api-documentation/swagger/webhooksubscribers","routeSlug":"/api-documentation/swagger/webhooksubscribers","items":[{"label":"List Webhook Subscribers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/webhooksubscribers/listwebhooksubscribers","routeSlug":"/api-documentation/swagger/webhooksubscribers/listwebhooksubscribers","metadata":{"seo":{"title":"List Webhook Subscribers","description":"Returns the webhook subscribers for the organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListWebhookSubscribers","name":"List Webhook Subscribers","isWebhook":false,"pointer":"/paths/~1v1~1webhook-subscribers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Webhook Subscribers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the webhook subscribers for the organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_66","description":"The specific page of results requested."},{"name":"page_size","in":"query","schemaId":"schema_67","description":"The number of results in each page."}],"pointer":"/paths/~1v1~1webhook-subscribers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/webhook-subscribers","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"schema_66"},{"name":"page_size","in":"query","schemaId":"schema_67"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/webhook-subscribers","href":"webhooksubscribers/listwebhooksubscribers","openApiOperationId":"ListWebhookSubscribers","summary":"List Webhook Subscribers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookSubscriberSummaryDtoPagedResultsDto"}},"schemaId":"components/schemas/WebhookSubscriberSummaryDtoPagedResultsDto"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1webhook-subscribers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebhookSubscriberSummaryDtoPagedResultsDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookSubscriberSummaryDtoPagedResultsDto"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooksubscribers/listwebhooksubscribers"}],"panels":[]}]},"httpPath":"/v1/webhook-subscribers"},{"label":"Create Webhook Configuration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/webhooksubscribers/createwebhooksubscriber","routeSlug":"/api-documentation/swagger/webhooksubscribers/createwebhooksubscriber","metadata":{"seo":{"title":"Create Webhook Configuration","description":"Creates a webhook configuration for the organization to receive event notifications via HTTP callbacks."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateWebhookSubscriber","name":"Create Webhook Configuration","isWebhook":false,"pointer":"/paths/~1v1~1webhook-subscribers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Webhook Configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a webhook configuration for the organization to receive event notifications via HTTP callbacks."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_128"},"application/json":{"schemaId":"schema_128"}},"schemaId":"schema_128","pointer":"/paths/~1v1~1webhook-subscribers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/webhook-subscribers","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"schema_128"},"application/json":{"schemaId":"schema_128"}},"responseCodes":["201","400"],"pointer":"/v1/webhook-subscribers","href":"webhooksubscribers/createwebhooksubscriber","openApiOperationId":"CreateWebhookSubscriber","summary":"Create Webhook Configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"schemaId":"schema_128","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_128"},"application/json":{"schemaId":"schema_128"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookSubscriber"}},"schemaId":"components/schemas/WebhookSubscriber"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1webhook-subscribers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/WebhookSubscriber","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookSubscriber"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooksubscribers/createwebhooksubscriber"}],"panels":[]}]},"httpPath":"/v1/webhook-subscribers"},{"label":"Delete Webhook Configuration","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/webhooksubscribers/deletewebhooksubscriber","routeSlug":"/api-documentation/swagger/webhooksubscribers/deletewebhooksubscriber","metadata":{"seo":{"title":"Delete Webhook Configuration","description":"Deletes the webhook configuration for the organization and removes all associated topic subscriptions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteWebhookSubscriber","name":"Delete Webhook Configuration","isWebhook":false,"pointer":"/paths/~1v1~1webhook-subscribers~1{subscriber_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Webhook Configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes the webhook configuration for the organization and removes all associated topic subscriptions."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscriber_id","in":"path","schemaId":"schema_73","required":true}],"pointer":"/paths/~1v1~1webhook-subscribers~1{subscriber_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/webhook-subscribers/{subscriber_id}","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"subscriber_id","in":"path","required":true,"schemaId":"schema_73"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204","400"],"pointer":"/v1/webhook-subscribers/{subscriber_id}","href":"webhooksubscribers/deletewebhooksubscriber","openApiOperationId":"DeleteWebhookSubscriber","summary":"Delete Webhook Configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1webhook-subscribers~1{subscriber_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooksubscribers/deletewebhooksubscriber"}],"panels":[]}]},"httpPath":"/v1/webhook-subscribers/{subscriber_id}"},{"label":"Update Webhook Configuration","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/webhooksubscribers/updatewebhooksubscriber","routeSlug":"/api-documentation/swagger/webhooksubscribers/updatewebhooksubscriber","metadata":{"seo":{"title":"Update Webhook Configuration","description":"Updates the callback URL for an existing webhook configuration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateWebhookSubscriber","name":"Update Webhook Configuration","isWebhook":false,"pointer":"/paths/~1v1~1webhook-subscribers~1{subscriber_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Webhook Configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the callback URL for an existing webhook configuration."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscriber_id","in":"path","schemaId":"schema_73","required":true}],"pointer":"/paths/~1v1~1webhook-subscribers~1{subscriber_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_129"},"application/json":{"schemaId":"schema_129"}},"schemaId":"schema_129","pointer":"/paths/~1v1~1webhook-subscribers~1{subscriber_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/webhook-subscribers/{subscriber_id}","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"subscriber_id","in":"path","required":true,"schemaId":"schema_73"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"schema_129"},"application/json":{"schemaId":"schema_129"}},"responseCodes":["200","400"],"pointer":"/v1/webhook-subscribers/{subscriber_id}","href":"webhooksubscribers/updatewebhooksubscriber","openApiOperationId":"UpdateWebhookSubscriber","summary":"Update Webhook Configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"schemaId":"schema_129","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_129"},"application/json":{"schemaId":"schema_129"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1webhook-subscribers~1{subscriber_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooksubscribers/updatewebhooksubscriber"}],"panels":[]}]},"httpPath":"/v1/webhook-subscribers/{subscriber_id}"}],"content":{"contentType":"group","meta":{"name":"WebhookSubscribers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"WebhookSubscribers","showPageActions":true},{"nodeType":"markdoc","content":"Webhook configurations enable organizations to receive real-time event notifications via HTTP callbacks. Organizations can configure webhook endpoints to receive notifications about events such as project or offering, creation or changes. Each webhook includes a secret key for validating the authenticity of incoming requests."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/webhook-subscribers","summary":"List Webhook Subscribers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooksubscribers/listwebhooksubscribers","deprecated":false},{"title":"/v1/webhook-subscribers","summary":"Create Webhook Configuration","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooksubscribers/createwebhooksubscriber","deprecated":false},{"title":"/v1/webhook-subscribers/{subscriber_id}","summary":"Delete Webhook Configuration","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/webhooksubscribers/deletewebhooksubscriber","deprecated":false},{"title":"/v1/webhook-subscribers/{subscriber_id}","summary":"Update Webhook Configuration","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/webhooksubscribers/updatewebhooksubscriber","deprecated":false}]}]}]}]}},{"type":"group","label":"WebhookSubscriptions","link":"/api-documentation/swagger/webhooksubscriptions","routeSlug":"/api-documentation/swagger/webhooksubscriptions","items":[{"label":"List Webhook Topic Subscriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/webhooksubscriptions/listsubscriptions","routeSlug":"/api-documentation/swagger/webhooksubscriptions/listsubscriptions","metadata":{"seo":{"title":"List Webhook Topic Subscriptions","description":"Returns all topic subscriptions for a webhook configuration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListSubscriptions","name":"List Webhook Topic Subscriptions","isWebhook":false,"pointer":"/paths/~1v1~1webhook-subscribers~1{subscriber_id}~1subscriptions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Webhook Topic Subscriptions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all topic subscriptions for a webhook configuration."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscriber_id","in":"path","schemaId":"schema_130","description":"The unique identifier of the webhook configuration in Parallax.","required":true}],"pointer":"/paths/~1v1~1webhook-subscribers~1{subscriber_id}~1subscriptions/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_66","description":"The specific page of results requested."},{"name":"page_size","in":"query","schemaId":"schema_67","description":"The number of results in each page."}],"pointer":"/paths/~1v1~1webhook-subscribers~1{subscriber_id}~1subscriptions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/webhook-subscribers/{subscriber_id}/subscriptions","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"subscriber_id","in":"path","required":true,"schemaId":"schema_130"}],"query":[{"name":"page","in":"query","schemaId":"schema_66"},{"name":"page_size","in":"query","schemaId":"schema_67"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/webhook-subscribers/{subscriber_id}/subscriptions","href":"webhooksubscriptions/listsubscriptions","openApiOperationId":"ListSubscriptions","summary":"List Webhook Topic Subscriptions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookSubscriptionDtoPagedResultsDto"}},"schemaId":"components/schemas/WebhookSubscriptionDtoPagedResultsDto"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1webhook-subscribers~1{subscriber_id}~1subscriptions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebhookSubscriptionDtoPagedResultsDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookSubscriptionDtoPagedResultsDto"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooksubscriptions/listsubscriptions"}],"panels":[]}]},"httpPath":"/v1/webhook-subscribers/{subscriber_id}/subscriptions"},{"label":"Subscribe to Webhook Topic","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/webhooksubscriptions/createsubscription","routeSlug":"/api-documentation/swagger/webhooksubscriptions/createsubscription","metadata":{"seo":{"title":"Subscribe to Webhook Topic","description":"Creates a subscription to a specific webhook topic for an existing webhook configuration. The webhook will receive notifications for events matching the specified topic."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateSubscription","name":"Subscribe to Webhook Topic","isWebhook":false,"pointer":"/paths/~1v1~1webhook-subscribers~1{subscriber_id}~1subscriptions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscribe to Webhook Topic","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a subscription to a specific webhook topic for an existing webhook configuration. The webhook will receive notifications for events matching the specified topic."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscriber_id","in":"path","schemaId":"schema_130","description":"The unique identifier of the webhook configuration in Parallax.","required":true}],"pointer":"/paths/~1v1~1webhook-subscribers~1{subscriber_id}~1subscriptions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_131"},"application/json":{"schemaId":"schema_131"}},"schemaId":"schema_131","pointer":"/paths/~1v1~1webhook-subscribers~1{subscriber_id}~1subscriptions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/webhook-subscribers/{subscriber_id}/subscriptions","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"subscriber_id","in":"path","required":true,"schemaId":"schema_130"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json-patch+json":{"schemaId":"schema_131"},"application/json":{"schemaId":"schema_131"}},"responseCodes":["201","400"],"pointer":"/v1/webhook-subscribers/{subscriber_id}/subscriptions","href":"webhooksubscriptions/createsubscription","openApiOperationId":"CreateSubscription","summary":"Subscribe to Webhook Topic"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"schemaId":"schema_131","mediaTypes":["application/json-patch+json","application/json"],"mediaTypeSchemas":{"application/json-patch+json":{"schemaId":"schema_131"},"application/json":{"schemaId":"schema_131"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookSubscription"}},"schemaId":"components/schemas/WebhookSubscription"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1webhook-subscribers~1{subscriber_id}~1subscriptions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/WebhookSubscription","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookSubscription"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooksubscriptions/createsubscription"}],"panels":[]}]},"httpPath":"/v1/webhook-subscribers/{subscriber_id}/subscriptions"},{"label":"Remove Webhook Topic Subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/webhooksubscriptions/deletesubscription","routeSlug":"/api-documentation/swagger/webhooksubscriptions/deletesubscription","metadata":{"seo":{"title":"Remove Webhook Topic Subscription","description":"Removes a specific topic subscription from an existing webhook configuration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteSubscription","name":"Remove Webhook Topic Subscription","isWebhook":false,"pointer":"/paths/~1v1~1webhook-subscribers~1{subscriber_id}~1subscriptions~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove Webhook Topic Subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Removes a specific topic subscription from an existing webhook configuration."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_73","description":"ID of the resource","required":true},{"name":"subscriber_id","in":"path","schemaId":"schema_130","description":"The unique identifier of the webhook configuration in Parallax.","required":true}],"pointer":"/paths/~1v1~1webhook-subscribers~1{subscriber_id}~1subscriptions~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/webhook-subscribers/{subscriber_id}/subscriptions/{id}","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_73"},{"name":"subscriber_id","in":"path","required":true,"schemaId":"schema_130"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204","400"],"pointer":"/v1/webhook-subscribers/{subscriber_id}/subscriptions/{id}","href":"webhooksubscriptions/deletesubscription","openApiOperationId":"DeleteSubscription","summary":"Remove Webhook Topic Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1webhook-subscribers~1{subscriber_id}~1subscriptions~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooksubscriptions/deletesubscription"}],"panels":[]}]},"httpPath":"/v1/webhook-subscribers/{subscriber_id}/subscriptions/{id}"},{"label":"Get Webhook Subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-documentation/swagger/webhooksubscriptions/getsubscription","routeSlug":"/api-documentation/swagger/webhooksubscriptions/getsubscription","metadata":{"seo":{"title":"Get Webhook Subscription","description":"Retrieves a specific webhook topic subscription by ID for the given webhook configuration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetSubscription","name":"Get Webhook Subscription","isWebhook":false,"pointer":"/paths/~1v1~1webhook-subscribers~1{subscriber_id}~1subscriptions~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Webhook Subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a specific webhook topic subscription by ID for the given webhook configuration."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_73","description":"ID of the resource","required":true},{"name":"subscriber_id","in":"path","schemaId":"schema_130","description":"The unique identifier of the webhook configuration in Parallax.","required":true}],"pointer":"/paths/~1v1~1webhook-subscribers~1{subscriber_id}~1subscriptions~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/webhook-subscribers/{subscriber_id}/subscriptions/{id}","servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_73"},{"name":"subscriber_id","in":"path","required":true,"schemaId":"schema_130"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/webhook-subscribers/{subscriber_id}/subscriptions/{id}","href":"webhooksubscriptions/getsubscription","openApiOperationId":"GetSubscription","summary":"Get Webhook Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-documentation/swagger","description":"Mock server","isMockServer":true},{"url":"https://api.getparallax.com","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookSubscription"}},"schemaId":"components/schemas/WebhookSubscription"},{"code":"400","description":"The request contains validation errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1v1~1webhook-subscribers~1{subscriber_id}~1subscriptions~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebhookSubscription","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookSubscription"}}},{"code":"400","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooksubscriptions/getsubscription"}],"panels":[]}]},"httpPath":"/v1/webhook-subscribers/{subscriber_id}/subscriptions/{id}"}],"content":{"contentType":"group","meta":{"name":"WebhookSubscriptions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"WebhookSubscriptions","showPageActions":true},{"nodeType":"markdoc","content":"Webhook subscriptions define the topics for which a given WebhookSubscriber will receive notifications."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/webhook-subscribers/{subscriber_id}/subscriptions","summary":"List Webhook Topic Subscriptions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooksubscriptions/listsubscriptions","deprecated":false},{"title":"/v1/webhook-subscribers/{subscriber_id}/subscriptions","summary":"Subscribe to Webhook Topic","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooksubscriptions/createsubscription","deprecated":false},{"title":"/v1/webhook-subscribers/{subscriber_id}/subscriptions/{id}","summary":"Remove Webhook Topic Subscription","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/webhooksubscriptions/deletesubscription","deprecated":false},{"title":"/v1/webhook-subscribers/{subscriber_id}/subscriptions/{id}","summary":"Get Webhook Subscription","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooksubscriptions/getsubscription","deprecated":false}]}]}]}]}},{"type":"separator","label":"Schemas","content":null},{"type":"group","label":"Schemas","link":"/api-documentation/swagger/schemas","routeSlug":"/api-documentation/swagger/schemas","items":[{"type":"link","label":"ActualTime","link":"/api-documentation/swagger/schemas/actualtime","routeSlug":"/api-documentation/swagger/schemas/actualtime","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ActualTime"},"seo":{"title":"ActualTime"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ActualTime","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ActualTime"},"children":[]}]}]}},{"type":"link","label":"ActualTimeDtoPagedResultsDto","link":"/api-documentation/swagger/schemas/actualtimedtopagedresultsdto","routeSlug":"/api-documentation/swagger/schemas/actualtimedtopagedresultsdto","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ActualTimeDtoPagedResultsDto"},"seo":{"title":"ActualTimeDtoPagedResultsDto"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ActualTimeDtoPagedResultsDto","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ActualTimeDtoPagedResultsDto"},"children":[]}]}]}},{"type":"link","label":"ActualTimeOff","link":"/api-documentation/swagger/schemas/actualtimeoff","routeSlug":"/api-documentation/swagger/schemas/actualtimeoff","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ActualTimeOff"},"seo":{"title":"ActualTimeOff"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ActualTimeOff","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ActualTimeOff"},"children":[]}]}]}},{"type":"link","label":"ActualTimeOffDtoPagedResultsDto","link":"/api-documentation/swagger/schemas/actualtimeoffdtopagedresultsdto","routeSlug":"/api-documentation/swagger/schemas/actualtimeoffdtopagedresultsdto","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ActualTimeOffDtoPagedResultsDto"},"seo":{"title":"ActualTimeOffDtoPagedResultsDto"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ActualTimeOffDtoPagedResultsDto","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ActualTimeOffDtoPagedResultsDto"},"children":[]}]}]}},{"type":"link","label":"AddExternalId","link":"/api-documentation/swagger/schemas/addexternalid","routeSlug":"/api-documentation/swagger/schemas/addexternalid","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AddExternalId"},"seo":{"title":"AddExternalId"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"AddExternalId","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AddExternalId"},"children":[]}]}]}},{"type":"link","label":"AddOfferingExternalId","link":"/api-documentation/swagger/schemas/addofferingexternalid","routeSlug":"/api-documentation/swagger/schemas/addofferingexternalid","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AddOfferingExternalId"},"seo":{"title":"AddOfferingExternalId"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"AddOfferingExternalId","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AddOfferingExternalId"},"children":[]}]}]}},{"type":"link","label":"AddPersonExternalId","link":"/api-documentation/swagger/schemas/addpersonexternalid","routeSlug":"/api-documentation/swagger/schemas/addpersonexternalid","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AddPersonExternalId"},"seo":{"title":"AddPersonExternalId"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"AddPersonExternalId","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AddPersonExternalId"},"children":[]}]}]}},{"type":"link","label":"AdjustmentType","link":"/api-documentation/swagger/schemas/adjustmenttype","routeSlug":"/api-documentation/swagger/schemas/adjustmenttype","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AdjustmentType"},"seo":{"title":"AdjustmentType"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"AdjustmentType","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AdjustmentType"},"children":[]}]}]}},{"type":"link","label":"Assignment","link":"/api-documentation/swagger/schemas/assignment","routeSlug":"/api-documentation/swagger/schemas/assignment","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Assignment"},"seo":{"title":"Assignment"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Assignment","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Assignment"},"children":[]}]}]}},{"type":"link","label":"AssignmentType","link":"/api-documentation/swagger/schemas/assignmenttype","routeSlug":"/api-documentation/swagger/schemas/assignmenttype","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"AssignmentType"},"seo":{"title":"AssignmentType"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"AssignmentType","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/AssignmentType"},"children":[]}]}]}},{"type":"link","label":"BillingModel","link":"/api-documentation/swagger/schemas/billingmodel","routeSlug":"/api-documentation/swagger/schemas/billingmodel","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"BillingModel"},"seo":{"title":"BillingModel"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"BillingModel","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/BillingModel"},"children":[]}]}]}},{"type":"link","label":"BillingModelOptionsBase","link":"/api-documentation/swagger/schemas/billingmodeloptionsbase","routeSlug":"/api-documentation/swagger/schemas/billingmodeloptionsbase","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"BillingModelOptionsBase"},"seo":{"title":"BillingModelOptionsBase"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"BillingModelOptionsBase","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/BillingModelOptionsBase"},"children":[]}]}]}},{"type":"link","label":"BillingModelOptionsFixedBid","link":"/api-documentation/swagger/schemas/billingmodeloptionsfixedbid","routeSlug":"/api-documentation/swagger/schemas/billingmodeloptionsfixedbid","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"BillingModelOptionsFixedBid"},"seo":{"title":"BillingModelOptionsFixedBid"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"BillingModelOptionsFixedBid","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/BillingModelOptionsFixedBid"},"children":[]}]}]}},{"type":"link","label":"BillingModelOptionsRetainer","link":"/api-documentation/swagger/schemas/billingmodeloptionsretainer","routeSlug":"/api-documentation/swagger/schemas/billingmodeloptionsretainer","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"BillingModelOptionsRetainer"},"seo":{"title":"BillingModelOptionsRetainer"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"BillingModelOptionsRetainer","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/BillingModelOptionsRetainer"},"children":[]}]}]}},{"type":"link","label":"BillingModelOptionsTimeMaterials","link":"/api-documentation/swagger/schemas/billingmodeloptionstimematerials","routeSlug":"/api-documentation/swagger/schemas/billingmodeloptionstimematerials","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"BillingModelOptionsTimeMaterials"},"seo":{"title":"BillingModelOptionsTimeMaterials"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"BillingModelOptionsTimeMaterials","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/BillingModelOptionsTimeMaterials"},"children":[]}]}]}},{"type":"link","label":"Client","link":"/api-documentation/swagger/schemas/client","routeSlug":"/api-documentation/swagger/schemas/client","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Client"},"seo":{"title":"Client"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Client","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Client"},"children":[]}]}]}},{"type":"link","label":"ClientDtoPagedResultsDto","link":"/api-documentation/swagger/schemas/clientdtopagedresultsdto","routeSlug":"/api-documentation/swagger/schemas/clientdtopagedresultsdto","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ClientDtoPagedResultsDto"},"seo":{"title":"ClientDtoPagedResultsDto"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ClientDtoPagedResultsDto","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ClientDtoPagedResultsDto"},"children":[]}]}]}},{"type":"link","label":"CostMetrics","link":"/api-documentation/swagger/schemas/costmetrics","routeSlug":"/api-documentation/swagger/schemas/costmetrics","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"CostMetrics"},"seo":{"title":"CostMetrics"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CostMetrics","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/CostMetrics"},"children":[]}]}]}},{"type":"link","label":"CreateActualTime","link":"/api-documentation/swagger/schemas/createactualtime","routeSlug":"/api-documentation/swagger/schemas/createactualtime","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"CreateActualTime"},"seo":{"title":"CreateActualTime"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CreateActualTime","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/CreateActualTime"},"children":[]}]}]}},{"type":"link","label":"CreateActualTimeOff","link":"/api-documentation/swagger/schemas/createactualtimeoff","routeSlug":"/api-documentation/swagger/schemas/createactualtimeoff","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"CreateActualTimeOff"},"seo":{"title":"CreateActualTimeOff"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CreateActualTimeOff","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/CreateActualTimeOff"},"children":[]}]}]}},{"type":"link","label":"CreateClient","link":"/api-documentation/swagger/schemas/createclient","routeSlug":"/api-documentation/swagger/schemas/createclient","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"CreateClient"},"seo":{"title":"CreateClient"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CreateClient","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/CreateClient"},"children":[]}]}]}},{"type":"link","label":"CreateDepartment","link":"/api-documentation/swagger/schemas/createdepartment","routeSlug":"/api-documentation/swagger/schemas/createdepartment","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"CreateDepartment"},"seo":{"title":"CreateDepartment"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CreateDepartment","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/CreateDepartment"},"children":[]}]}]}},{"type":"link","label":"CreateOtherCostAndRevenue","link":"/api-documentation/swagger/schemas/createothercostandrevenue","routeSlug":"/api-documentation/swagger/schemas/createothercostandrevenue","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"CreateOtherCostAndRevenue"},"seo":{"title":"CreateOtherCostAndRevenue"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CreateOtherCostAndRevenue","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/CreateOtherCostAndRevenue"},"children":[]}]}]}},{"type":"link","label":"CreatePerson","link":"/api-documentation/swagger/schemas/createperson","routeSlug":"/api-documentation/swagger/schemas/createperson","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"CreatePerson"},"seo":{"title":"CreatePerson"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CreatePerson","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/CreatePerson"},"children":[]}]}]}},{"type":"link","label":"CreatePipeline","link":"/api-documentation/swagger/schemas/createpipeline","routeSlug":"/api-documentation/swagger/schemas/createpipeline","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"CreatePipeline"},"seo":{"title":"CreatePipeline"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CreatePipeline","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/CreatePipeline"},"children":[]}]}]}},{"type":"link","label":"CreatePlannedTimeOff","link":"/api-documentation/swagger/schemas/createplannedtimeoff","routeSlug":"/api-documentation/swagger/schemas/createplannedtimeoff","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"CreatePlannedTimeOff"},"seo":{"title":"CreatePlannedTimeOff"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CreatePlannedTimeOff","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/CreatePlannedTimeOff"},"children":[]}]}]}},{"type":"link","label":"CreateProject","link":"/api-documentation/swagger/schemas/createproject","routeSlug":"/api-documentation/swagger/schemas/createproject","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"CreateProject"},"seo":{"title":"CreateProject"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CreateProject","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/CreateProject"},"children":[]}]}]}},{"type":"link","label":"CreateProjectOffering","link":"/api-documentation/swagger/schemas/createprojectoffering","routeSlug":"/api-documentation/swagger/schemas/createprojectoffering","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"CreateProjectOffering"},"seo":{"title":"CreateProjectOffering"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CreateProjectOffering","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/CreateProjectOffering"},"children":[]}]}]}},{"type":"link","label":"CreateProjectOfferingRole","link":"/api-documentation/swagger/schemas/createprojectofferingrole","routeSlug":"/api-documentation/swagger/schemas/createprojectofferingrole","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"CreateProjectOfferingRole"},"seo":{"title":"CreateProjectOfferingRole"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CreateProjectOfferingRole","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/CreateProjectOfferingRole"},"children":[]}]}]}},{"type":"link","label":"CreateRole","link":"/api-documentation/swagger/schemas/createrole","routeSlug":"/api-documentation/swagger/schemas/createrole","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"CreateRole"},"seo":{"title":"CreateRole"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CreateRole","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/CreateRole"},"children":[]}]}]}},{"type":"link","label":"CreateStage","link":"/api-documentation/swagger/schemas/createstage","routeSlug":"/api-documentation/swagger/schemas/createstage","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"CreateStage"},"seo":{"title":"CreateStage"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CreateStage","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/CreateStage"},"children":[]}]}]}},{"type":"link","label":"CreateSubscription","link":"/api-documentation/swagger/schemas/createsubscription","routeSlug":"/api-documentation/swagger/schemas/createsubscription","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"CreateSubscription"},"seo":{"title":"CreateSubscription"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CreateSubscription","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/CreateSubscription"},"children":[]}]}]}},{"type":"link","label":"CreateTag","link":"/api-documentation/swagger/schemas/createtag","routeSlug":"/api-documentation/swagger/schemas/createtag","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"CreateTag"},"seo":{"title":"CreateTag"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CreateTag","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/CreateTag"},"children":[]}]}]}},{"type":"link","label":"CreateWebhookSubscriber","link":"/api-documentation/swagger/schemas/createwebhooksubscriber","routeSlug":"/api-documentation/swagger/schemas/createwebhooksubscriber","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"CreateWebhookSubscriber"},"seo":{"title":"CreateWebhookSubscriber"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CreateWebhookSubscriber","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/CreateWebhookSubscriber"},"children":[]}]}]}},{"type":"link","label":"Department","link":"/api-documentation/swagger/schemas/department","routeSlug":"/api-documentation/swagger/schemas/department","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Department"},"seo":{"title":"Department"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Department","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Department"},"children":[]}]}]}},{"type":"link","label":"DepartmentDtoPagedResultsDto","link":"/api-documentation/swagger/schemas/departmentdtopagedresultsdto","routeSlug":"/api-documentation/swagger/schemas/departmentdtopagedresultsdto","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"DepartmentDtoPagedResultsDto"},"seo":{"title":"DepartmentDtoPagedResultsDto"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"DepartmentDtoPagedResultsDto","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/DepartmentDtoPagedResultsDto"},"children":[]}]}]}},{"type":"link","label":"FeeSchedule","link":"/api-documentation/swagger/schemas/feeschedule","routeSlug":"/api-documentation/swagger/schemas/feeschedule","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"FeeSchedule"},"seo":{"title":"FeeSchedule"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"FeeSchedule","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/FeeSchedule"},"children":[]}]}]}},{"type":"link","label":"HoursMetrics","link":"/api-documentation/swagger/schemas/hoursmetrics","routeSlug":"/api-documentation/swagger/schemas/hoursmetrics","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"HoursMetrics"},"seo":{"title":"HoursMetrics"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"HoursMetrics","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/HoursMetrics"},"children":[]}]}]}},{"type":"link","label":"Money","link":"/api-documentation/swagger/schemas/money","routeSlug":"/api-documentation/swagger/schemas/money","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Money"},"seo":{"title":"Money"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Money","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Money"},"children":[]}]}]}},{"type":"link","label":"OtherCostAndRevenue","link":"/api-documentation/swagger/schemas/othercostandrevenue","routeSlug":"/api-documentation/swagger/schemas/othercostandrevenue","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"OtherCostAndRevenue"},"seo":{"title":"OtherCostAndRevenue"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"OtherCostAndRevenue","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/OtherCostAndRevenue"},"children":[]}]}]}},{"type":"link","label":"OtherCostAndRevenueDtoPagedResultsDto","link":"/api-documentation/swagger/schemas/othercostandrevenuedtopagedresultsdto","routeSlug":"/api-documentation/swagger/schemas/othercostandrevenuedtopagedresultsdto","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"OtherCostAndRevenueDtoPagedResultsDto"},"seo":{"title":"OtherCostAndRevenueDtoPagedResultsDto"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"OtherCostAndRevenueDtoPagedResultsDto","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/OtherCostAndRevenueDtoPagedResultsDto"},"children":[]}]}]}},{"type":"link","label":"Person","link":"/api-documentation/swagger/schemas/person","routeSlug":"/api-documentation/swagger/schemas/person","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Person"},"seo":{"title":"Person"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Person","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Person"},"children":[]}]}]}},{"type":"link","label":"PersonDtoPagedResultsDto","link":"/api-documentation/swagger/schemas/persondtopagedresultsdto","routeSlug":"/api-documentation/swagger/schemas/persondtopagedresultsdto","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"PersonDtoPagedResultsDto"},"seo":{"title":"PersonDtoPagedResultsDto"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"PersonDtoPagedResultsDto","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/PersonDtoPagedResultsDto"},"children":[]}]}]}},{"type":"link","label":"Pipeline","link":"/api-documentation/swagger/schemas/pipeline","routeSlug":"/api-documentation/swagger/schemas/pipeline","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Pipeline"},"seo":{"title":"Pipeline"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pipeline","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Pipeline"},"children":[]}]}]}},{"type":"link","label":"PipelineDtoPagedResultsDto","link":"/api-documentation/swagger/schemas/pipelinedtopagedresultsdto","routeSlug":"/api-documentation/swagger/schemas/pipelinedtopagedresultsdto","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"PipelineDtoPagedResultsDto"},"seo":{"title":"PipelineDtoPagedResultsDto"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"PipelineDtoPagedResultsDto","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/PipelineDtoPagedResultsDto"},"children":[]}]}]}},{"type":"link","label":"PlannedTimeOff","link":"/api-documentation/swagger/schemas/plannedtimeoff","routeSlug":"/api-documentation/swagger/schemas/plannedtimeoff","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"PlannedTimeOff"},"seo":{"title":"PlannedTimeOff"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"PlannedTimeOff","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/PlannedTimeOff"},"children":[]}]}]}},{"type":"link","label":"PlannedTimeOffDtoPagedResultsDto","link":"/api-documentation/swagger/schemas/plannedtimeoffdtopagedresultsdto","routeSlug":"/api-documentation/swagger/schemas/plannedtimeoffdtopagedresultsdto","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"PlannedTimeOffDtoPagedResultsDto"},"seo":{"title":"PlannedTimeOffDtoPagedResultsDto"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"PlannedTimeOffDtoPagedResultsDto","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/PlannedTimeOffDtoPagedResultsDto"},"children":[]}]}]}},{"type":"link","label":"Project","link":"/api-documentation/swagger/schemas/project","routeSlug":"/api-documentation/swagger/schemas/project","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Project"},"seo":{"title":"Project"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Project","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Project"},"children":[]}]}]}},{"type":"link","label":"ProjectDtoPagedResultsDto","link":"/api-documentation/swagger/schemas/projectdtopagedresultsdto","routeSlug":"/api-documentation/swagger/schemas/projectdtopagedresultsdto","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ProjectDtoPagedResultsDto"},"seo":{"title":"ProjectDtoPagedResultsDto"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ProjectDtoPagedResultsDto","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ProjectDtoPagedResultsDto"},"children":[]}]}]}},{"type":"link","label":"ProjectModel","link":"/api-documentation/swagger/schemas/projectmodel","routeSlug":"/api-documentation/swagger/schemas/projectmodel","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ProjectModel"},"seo":{"title":"ProjectModel"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ProjectModel","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ProjectModel"},"children":[]}]}]}},{"type":"link","label":"ProjectOffering","link":"/api-documentation/swagger/schemas/projectoffering","routeSlug":"/api-documentation/swagger/schemas/projectoffering","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ProjectOffering"},"seo":{"title":"ProjectOffering"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ProjectOffering","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ProjectOffering"},"children":[]}]}]}},{"type":"link","label":"ProjectOfferingDtoPagedResultsDto","link":"/api-documentation/swagger/schemas/projectofferingdtopagedresultsdto","routeSlug":"/api-documentation/swagger/schemas/projectofferingdtopagedresultsdto","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ProjectOfferingDtoPagedResultsDto"},"seo":{"title":"ProjectOfferingDtoPagedResultsDto"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ProjectOfferingDtoPagedResultsDto","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ProjectOfferingDtoPagedResultsDto"},"children":[]}]}]}},{"type":"link","label":"ProjectOfferingMetrics","link":"/api-documentation/swagger/schemas/projectofferingmetrics","routeSlug":"/api-documentation/swagger/schemas/projectofferingmetrics","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ProjectOfferingMetrics"},"seo":{"title":"ProjectOfferingMetrics"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ProjectOfferingMetrics","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ProjectOfferingMetrics"},"children":[]}]}]}},{"type":"link","label":"ProjectOfferingRole","link":"/api-documentation/swagger/schemas/projectofferingrole","routeSlug":"/api-documentation/swagger/schemas/projectofferingrole","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ProjectOfferingRole"},"seo":{"title":"ProjectOfferingRole"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ProjectOfferingRole","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ProjectOfferingRole"},"children":[]}]}]}},{"type":"link","label":"ProjectOfferingRoleDtoPagedResultsDto","link":"/api-documentation/swagger/schemas/projectofferingroledtopagedresultsdto","routeSlug":"/api-documentation/swagger/schemas/projectofferingroledtopagedresultsdto","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ProjectOfferingRoleDtoPagedResultsDto"},"seo":{"title":"ProjectOfferingRoleDtoPagedResultsDto"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ProjectOfferingRoleDtoPagedResultsDto","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ProjectOfferingRoleDtoPagedResultsDto"},"children":[]}]}]}},{"type":"link","label":"ProjectOfferingRolePlannedTime","link":"/api-documentation/swagger/schemas/projectofferingroleplannedtime","routeSlug":"/api-documentation/swagger/schemas/projectofferingroleplannedtime","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ProjectOfferingRolePlannedTime"},"seo":{"title":"ProjectOfferingRolePlannedTime"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ProjectOfferingRolePlannedTime","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ProjectOfferingRolePlannedTime"},"children":[]}]}]}},{"type":"link","label":"ProjectOfferingRolePlannedTimeDtoPagedResultsDto","link":"/api-documentation/swagger/schemas/projectofferingroleplannedtimedtopagedresultsdto","routeSlug":"/api-documentation/swagger/schemas/projectofferingroleplannedtimedtopagedresultsdto","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ProjectOfferingRolePlannedTimeDtoPagedResultsDto"},"seo":{"title":"ProjectOfferingRolePlannedTimeDtoPagedResultsDto"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ProjectOfferingRolePlannedTimeDtoPagedResultsDto","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ProjectOfferingRolePlannedTimeDtoPagedResultsDto"},"children":[]}]}]}},{"type":"link","label":"ProjectStatus","link":"/api-documentation/swagger/schemas/projectstatus","routeSlug":"/api-documentation/swagger/schemas/projectstatus","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ProjectStatus"},"seo":{"title":"ProjectStatus"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ProjectStatus","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ProjectStatus"},"children":[]}]}]}},{"type":"link","label":"RateCard","link":"/api-documentation/swagger/schemas/ratecard","routeSlug":"/api-documentation/swagger/schemas/ratecard","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"RateCard"},"seo":{"title":"RateCard"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"RateCard","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/RateCard"},"children":[]}]}]}},{"type":"link","label":"RateCardDtoPagedResultsDto","link":"/api-documentation/swagger/schemas/ratecarddtopagedresultsdto","routeSlug":"/api-documentation/swagger/schemas/ratecarddtopagedresultsdto","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"RateCardDtoPagedResultsDto"},"seo":{"title":"RateCardDtoPagedResultsDto"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"RateCardDtoPagedResultsDto","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/RateCardDtoPagedResultsDto"},"children":[]}]}]}},{"type":"link","label":"RateCardRate","link":"/api-documentation/swagger/schemas/ratecardrate","routeSlug":"/api-documentation/swagger/schemas/ratecardrate","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"RateCardRate"},"seo":{"title":"RateCardRate"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"RateCardRate","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/RateCardRate"},"children":[]}]}]}},{"type":"link","label":"RateCardRateDtoPagedResultsDto","link":"/api-documentation/swagger/schemas/ratecardratedtopagedresultsdto","routeSlug":"/api-documentation/swagger/schemas/ratecardratedtopagedresultsdto","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"RateCardRateDtoPagedResultsDto"},"seo":{"title":"RateCardRateDtoPagedResultsDto"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"RateCardRateDtoPagedResultsDto","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/RateCardRateDtoPagedResultsDto"},"children":[]}]}]}},{"type":"link","label":"RevenueMetrics","link":"/api-documentation/swagger/schemas/revenuemetrics","routeSlug":"/api-documentation/swagger/schemas/revenuemetrics","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"RevenueMetrics"},"seo":{"title":"RevenueMetrics"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"RevenueMetrics","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/RevenueMetrics"},"children":[]}]}]}},{"type":"link","label":"Role","link":"/api-documentation/swagger/schemas/role","routeSlug":"/api-documentation/swagger/schemas/role","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Role"},"seo":{"title":"Role"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Role","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Role"},"children":[]}]}]}},{"type":"link","label":"RoleDtoPagedResultsDto","link":"/api-documentation/swagger/schemas/roledtopagedresultsdto","routeSlug":"/api-documentation/swagger/schemas/roledtopagedresultsdto","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"RoleDtoPagedResultsDto"},"seo":{"title":"RoleDtoPagedResultsDto"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"RoleDtoPagedResultsDto","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/RoleDtoPagedResultsDto"},"children":[]}]}]}},{"type":"link","label":"ServiceOffering","link":"/api-documentation/swagger/schemas/serviceoffering","routeSlug":"/api-documentation/swagger/schemas/serviceoffering","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ServiceOffering"},"seo":{"title":"ServiceOffering"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ServiceOffering","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ServiceOffering"},"children":[]}]}]}},{"type":"link","label":"ServiceOfferingDtoPagedResultsDto","link":"/api-documentation/swagger/schemas/serviceofferingdtopagedresultsdto","routeSlug":"/api-documentation/swagger/schemas/serviceofferingdtopagedresultsdto","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ServiceOfferingDtoPagedResultsDto"},"seo":{"title":"ServiceOfferingDtoPagedResultsDto"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ServiceOfferingDtoPagedResultsDto","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ServiceOfferingDtoPagedResultsDto"},"children":[]}]}]}},{"type":"link","label":"Stage","link":"/api-documentation/swagger/schemas/stage","routeSlug":"/api-documentation/swagger/schemas/stage","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Stage"},"seo":{"title":"Stage"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Stage","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Stage"},"children":[]}]}]}},{"type":"link","label":"StageDtoPagedResultsDto","link":"/api-documentation/swagger/schemas/stagedtopagedresultsdto","routeSlug":"/api-documentation/swagger/schemas/stagedtopagedresultsdto","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"StageDtoPagedResultsDto"},"seo":{"title":"StageDtoPagedResultsDto"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"StageDtoPagedResultsDto","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/StageDtoPagedResultsDto"},"children":[]}]}]}},{"type":"link","label":"Tag","link":"/api-documentation/swagger/schemas/tag","routeSlug":"/api-documentation/swagger/schemas/tag","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Tag"},"seo":{"title":"Tag"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tag","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Tag"},"children":[]}]}]}},{"type":"link","label":"TagList","link":"/api-documentation/swagger/schemas/taglist","routeSlug":"/api-documentation/swagger/schemas/taglist","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"TagList"},"seo":{"title":"TagList"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"TagList","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/TagList"},"children":[]}]}]}},{"type":"link","label":"TimeOffAllocation","link":"/api-documentation/swagger/schemas/timeoffallocation","routeSlug":"/api-documentation/swagger/schemas/timeoffallocation","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"TimeOffAllocation"},"seo":{"title":"TimeOffAllocation"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"TimeOffAllocation","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/TimeOffAllocation"},"children":[]}]}]}},{"type":"link","label":"TimeOffCategory","link":"/api-documentation/swagger/schemas/timeoffcategory","routeSlug":"/api-documentation/swagger/schemas/timeoffcategory","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"TimeOffCategory"},"seo":{"title":"TimeOffCategory"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"TimeOffCategory","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/TimeOffCategory"},"children":[]}]}]}},{"type":"link","label":"TimesheetEntry","link":"/api-documentation/swagger/schemas/timesheetentry","routeSlug":"/api-documentation/swagger/schemas/timesheetentry","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"TimesheetEntry"},"seo":{"title":"TimesheetEntry"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"TimesheetEntry","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/TimesheetEntry"},"children":[]}]}]}},{"type":"link","label":"TimesheetEntryDtoPagedResultsDto","link":"/api-documentation/swagger/schemas/timesheetentrydtopagedresultsdto","routeSlug":"/api-documentation/swagger/schemas/timesheetentrydtopagedresultsdto","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"TimesheetEntryDtoPagedResultsDto"},"seo":{"title":"TimesheetEntryDtoPagedResultsDto"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"TimesheetEntryDtoPagedResultsDto","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/TimesheetEntryDtoPagedResultsDto"},"children":[]}]}]}},{"type":"link","label":"TimesheetSubmissionState","link":"/api-documentation/swagger/schemas/timesheetsubmissionstate","routeSlug":"/api-documentation/swagger/schemas/timesheetsubmissionstate","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"TimesheetSubmissionState"},"seo":{"title":"TimesheetSubmissionState"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"TimesheetSubmissionState","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/TimesheetSubmissionState"},"children":[]}]}]}},{"type":"link","label":"UpdateActualTime","link":"/api-documentation/swagger/schemas/updateactualtime","routeSlug":"/api-documentation/swagger/schemas/updateactualtime","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"UpdateActualTime"},"seo":{"title":"UpdateActualTime"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"UpdateActualTime","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/UpdateActualTime"},"children":[]}]}]}},{"type":"link","label":"UpdateActualTimeOff","link":"/api-documentation/swagger/schemas/updateactualtimeoff","routeSlug":"/api-documentation/swagger/schemas/updateactualtimeoff","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"UpdateActualTimeOff"},"seo":{"title":"UpdateActualTimeOff"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"UpdateActualTimeOff","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/UpdateActualTimeOff"},"children":[]}]}]}},{"type":"link","label":"UpdateClient","link":"/api-documentation/swagger/schemas/updateclient","routeSlug":"/api-documentation/swagger/schemas/updateclient","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"UpdateClient"},"seo":{"title":"UpdateClient"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"UpdateClient","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/UpdateClient"},"children":[]}]}]}},{"type":"link","label":"UpdateDepartment","link":"/api-documentation/swagger/schemas/updatedepartment","routeSlug":"/api-documentation/swagger/schemas/updatedepartment","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"UpdateDepartment"},"seo":{"title":"UpdateDepartment"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"UpdateDepartment","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/UpdateDepartment"},"children":[]}]}]}},{"type":"link","label":"UpdateOtherCostAndRevenue","link":"/api-documentation/swagger/schemas/updateothercostandrevenue","routeSlug":"/api-documentation/swagger/schemas/updateothercostandrevenue","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"UpdateOtherCostAndRevenue"},"seo":{"title":"UpdateOtherCostAndRevenue"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"UpdateOtherCostAndRevenue","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/UpdateOtherCostAndRevenue"},"children":[]}]}]}},{"type":"link","label":"UpdatePerson","link":"/api-documentation/swagger/schemas/updateperson","routeSlug":"/api-documentation/swagger/schemas/updateperson","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"UpdatePerson"},"seo":{"title":"UpdatePerson"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"UpdatePerson","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/UpdatePerson"},"children":[]}]}]}},{"type":"link","label":"UpdatePipeline","link":"/api-documentation/swagger/schemas/updatepipeline","routeSlug":"/api-documentation/swagger/schemas/updatepipeline","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"UpdatePipeline"},"seo":{"title":"UpdatePipeline"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"UpdatePipeline","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/UpdatePipeline"},"children":[]}]}]}},{"type":"link","label":"UpdatePlannedTimeOff","link":"/api-documentation/swagger/schemas/updateplannedtimeoff","routeSlug":"/api-documentation/swagger/schemas/updateplannedtimeoff","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"UpdatePlannedTimeOff"},"seo":{"title":"UpdatePlannedTimeOff"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"UpdatePlannedTimeOff","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/UpdatePlannedTimeOff"},"children":[]}]}]}},{"type":"link","label":"UpdateProject","link":"/api-documentation/swagger/schemas/updateproject","routeSlug":"/api-documentation/swagger/schemas/updateproject","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"UpdateProject"},"seo":{"title":"UpdateProject"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"UpdateProject","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/UpdateProject"},"children":[]}]}]}},{"type":"link","label":"UpdateProjectOffering","link":"/api-documentation/swagger/schemas/updateprojectoffering","routeSlug":"/api-documentation/swagger/schemas/updateprojectoffering","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"UpdateProjectOffering"},"seo":{"title":"UpdateProjectOffering"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"UpdateProjectOffering","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/UpdateProjectOffering"},"children":[]}]}]}},{"type":"link","label":"UpdateProjectOfferingRole","link":"/api-documentation/swagger/schemas/updateprojectofferingrole","routeSlug":"/api-documentation/swagger/schemas/updateprojectofferingrole","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"UpdateProjectOfferingRole"},"seo":{"title":"UpdateProjectOfferingRole"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"UpdateProjectOfferingRole","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/UpdateProjectOfferingRole"},"children":[]}]}]}},{"type":"link","label":"UpdateRole","link":"/api-documentation/swagger/schemas/updaterole","routeSlug":"/api-documentation/swagger/schemas/updaterole","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"UpdateRole"},"seo":{"title":"UpdateRole"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"UpdateRole","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/UpdateRole"},"children":[]}]}]}},{"type":"link","label":"UpdateStage","link":"/api-documentation/swagger/schemas/updatestage","routeSlug":"/api-documentation/swagger/schemas/updatestage","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"UpdateStage"},"seo":{"title":"UpdateStage"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"UpdateStage","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/UpdateStage"},"children":[]}]}]}},{"type":"link","label":"UpdateTag","link":"/api-documentation/swagger/schemas/updatetag","routeSlug":"/api-documentation/swagger/schemas/updatetag","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"UpdateTag"},"seo":{"title":"UpdateTag"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"UpdateTag","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/UpdateTag"},"children":[]}]}]}},{"type":"link","label":"UpdateWebhookSubscriber","link":"/api-documentation/swagger/schemas/updatewebhooksubscriber","routeSlug":"/api-documentation/swagger/schemas/updatewebhooksubscriber","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"UpdateWebhookSubscriber"},"seo":{"title":"UpdateWebhookSubscriber"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"UpdateWebhookSubscriber","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/UpdateWebhookSubscriber"},"children":[]}]}]}},{"type":"link","label":"ValidationErrorResponse","link":"/api-documentation/swagger/schemas/validationerrorresponse","routeSlug":"/api-documentation/swagger/schemas/validationerrorresponse","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ValidationErrorResponse"},"seo":{"title":"ValidationErrorResponse"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ValidationErrorResponse","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ValidationErrorResponse"},"children":[]}]}]}},{"type":"link","label":"WebhookSubscriber","link":"/api-documentation/swagger/schemas/webhooksubscriber","routeSlug":"/api-documentation/swagger/schemas/webhooksubscriber","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"WebhookSubscriber"},"seo":{"title":"WebhookSubscriber"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"WebhookSubscriber","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/WebhookSubscriber"},"children":[]}]}]}},{"type":"link","label":"WebhookSubscriberSummary","link":"/api-documentation/swagger/schemas/webhooksubscribersummary","routeSlug":"/api-documentation/swagger/schemas/webhooksubscribersummary","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"WebhookSubscriberSummary"},"seo":{"title":"WebhookSubscriberSummary"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"WebhookSubscriberSummary","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/WebhookSubscriberSummary"},"children":[]}]}]}},{"type":"link","label":"WebhookSubscriberSummaryDtoPagedResultsDto","link":"/api-documentation/swagger/schemas/webhooksubscribersummarydtopagedresultsdto","routeSlug":"/api-documentation/swagger/schemas/webhooksubscribersummarydtopagedresultsdto","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"WebhookSubscriberSummaryDtoPagedResultsDto"},"seo":{"title":"WebhookSubscriberSummaryDtoPagedResultsDto"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"WebhookSubscriberSummaryDtoPagedResultsDto","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/WebhookSubscriberSummaryDtoPagedResultsDto"},"children":[]}]}]}},{"type":"link","label":"WebhookSubscription","link":"/api-documentation/swagger/schemas/webhooksubscription","routeSlug":"/api-documentation/swagger/schemas/webhooksubscription","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"WebhookSubscription"},"seo":{"title":"WebhookSubscription"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"WebhookSubscription","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/WebhookSubscription"},"children":[]}]}]}},{"type":"link","label":"WebhookSubscriptionDtoPagedResultsDto","link":"/api-documentation/swagger/schemas/webhooksubscriptiondtopagedresultsdto","routeSlug":"/api-documentation/swagger/schemas/webhooksubscriptiondtopagedresultsdto","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"WebhookSubscriptionDtoPagedResultsDto"},"seo":{"title":"WebhookSubscriptionDtoPagedResultsDto"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"WebhookSubscriptionDtoPagedResultsDto","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/WebhookSubscriptionDtoPagedResultsDto"},"children":[]}]}]}},{"type":"link","label":"WorkerType","link":"/api-documentation/swagger/schemas/workertype","routeSlug":"/api-documentation/swagger/schemas/workertype","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"WorkerType"},"seo":{"title":"WorkerType"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"WorkerType","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/WorkerType"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Schemas"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Schemas","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"ActualTime","link":"/schemas/actualtime","deprecated":false},{"title":"ActualTimeDtoPagedResultsDto","link":"/schemas/actualtimedtopagedresultsdto","deprecated":false},{"title":"ActualTimeOff","link":"/schemas/actualtimeoff","deprecated":false},{"title":"ActualTimeOffDtoPagedResultsDto","link":"/schemas/actualtimeoffdtopagedresultsdto","deprecated":false},{"title":"AddExternalId","link":"/schemas/addexternalid","deprecated":false},{"title":"AddOfferingExternalId","link":"/schemas/addofferingexternalid","deprecated":false},{"title":"AddPersonExternalId","link":"/schemas/addpersonexternalid","deprecated":false},{"title":"AdjustmentType","link":"/schemas/adjustmenttype","deprecated":false},{"title":"Assignment","link":"/schemas/assignment","deprecated":false},{"title":"AssignmentType","link":"/schemas/assignmenttype","deprecated":false},{"title":"BillingModel","link":"/schemas/billingmodel","deprecated":false},{"title":"BillingModelOptionsBase","link":"/schemas/billingmodeloptionsbase","deprecated":false},{"title":"BillingModelOptionsFixedBid","link":"/schemas/billingmodeloptionsfixedbid","deprecated":false},{"title":"BillingModelOptionsRetainer","link":"/schemas/billingmodeloptionsretainer","deprecated":false},{"title":"BillingModelOptionsTimeMaterials","link":"/schemas/billingmodeloptionstimematerials","deprecated":false},{"title":"Client","link":"/schemas/client","deprecated":false},{"title":"ClientDtoPagedResultsDto","link":"/schemas/clientdtopagedresultsdto","deprecated":false},{"title":"CostMetrics","link":"/schemas/costmetrics","deprecated":false},{"title":"CreateActualTime","link":"/schemas/createactualtime","deprecated":false},{"title":"CreateActualTimeOff","link":"/schemas/createactualtimeoff","deprecated":false},{"title":"CreateClient","link":"/schemas/createclient","deprecated":false},{"title":"CreateDepartment","link":"/schemas/createdepartment","deprecated":false},{"title":"CreateOtherCostAndRevenue","link":"/schemas/createothercostandrevenue","deprecated":false},{"title":"CreatePerson","link":"/schemas/createperson","deprecated":false},{"title":"CreatePipeline","link":"/schemas/createpipeline","deprecated":false},{"title":"CreatePlannedTimeOff","link":"/schemas/createplannedtimeoff","deprecated":false},{"title":"CreateProject","link":"/schemas/createproject","deprecated":false},{"title":"CreateProjectOffering","link":"/schemas/createprojectoffering","deprecated":false},{"title":"CreateProjectOfferingRole","link":"/schemas/createprojectofferingrole","deprecated":false},{"title":"CreateRole","link":"/schemas/createrole","deprecated":false},{"title":"CreateStage","link":"/schemas/createstage","deprecated":false},{"title":"CreateSubscription","link":"/schemas/createsubscription","deprecated":false},{"title":"CreateTag","link":"/schemas/createtag","deprecated":false},{"title":"CreateWebhookSubscriber","link":"/schemas/createwebhooksubscriber","deprecated":false},{"title":"Department","link":"/schemas/department","deprecated":false},{"title":"DepartmentDtoPagedResultsDto","link":"/schemas/departmentdtopagedresultsdto","deprecated":false},{"title":"FeeSchedule","link":"/schemas/feeschedule","deprecated":false},{"title":"HoursMetrics","link":"/schemas/hoursmetrics","deprecated":false},{"title":"Money","link":"/schemas/money","deprecated":false},{"title":"OtherCostAndRevenue","link":"/schemas/othercostandrevenue","deprecated":false},{"title":"OtherCostAndRevenueDtoPagedResultsDto","link":"/schemas/othercostandrevenuedtopagedresultsdto","deprecated":false},{"title":"Person","link":"/schemas/person","deprecated":false},{"title":"PersonDtoPagedResultsDto","link":"/schemas/persondtopagedresultsdto","deprecated":false},{"title":"Pipeline","link":"/schemas/pipeline","deprecated":false},{"title":"PipelineDtoPagedResultsDto","link":"/schemas/pipelinedtopagedresultsdto","deprecated":false},{"title":"PlannedTimeOff","link":"/schemas/plannedtimeoff","deprecated":false},{"title":"PlannedTimeOffDtoPagedResultsDto","link":"/schemas/plannedtimeoffdtopagedresultsdto","deprecated":false},{"title":"Project","link":"/schemas/project","deprecated":false},{"title":"ProjectDtoPagedResultsDto","link":"/schemas/projectdtopagedresultsdto","deprecated":false},{"title":"ProjectModel","link":"/schemas/projectmodel","deprecated":false},{"title":"ProjectOffering","link":"/schemas/projectoffering","deprecated":false},{"title":"ProjectOfferingDtoPagedResultsDto","link":"/schemas/projectofferingdtopagedresultsdto","deprecated":false},{"title":"ProjectOfferingMetrics","link":"/schemas/projectofferingmetrics","deprecated":false},{"title":"ProjectOfferingRole","link":"/schemas/projectofferingrole","deprecated":false},{"title":"ProjectOfferingRoleDtoPagedResultsDto","link":"/schemas/projectofferingroledtopagedresultsdto","deprecated":false},{"title":"ProjectOfferingRolePlannedTime","link":"/schemas/projectofferingroleplannedtime","deprecated":false},{"title":"ProjectOfferingRolePlannedTimeDtoPagedResultsDto","link":"/schemas/projectofferingroleplannedtimedtopagedresultsdto","deprecated":false},{"title":"ProjectStatus","link":"/schemas/projectstatus","deprecated":false},{"title":"RateCard","link":"/schemas/ratecard","deprecated":false},{"title":"RateCardDtoPagedResultsDto","link":"/schemas/ratecarddtopagedresultsdto","deprecated":false},{"title":"RateCardRate","link":"/schemas/ratecardrate","deprecated":false},{"title":"RateCardRateDtoPagedResultsDto","link":"/schemas/ratecardratedtopagedresultsdto","deprecated":false},{"title":"RevenueMetrics","link":"/schemas/revenuemetrics","deprecated":false},{"title":"Role","link":"/schemas/role","deprecated":false},{"title":"RoleDtoPagedResultsDto","link":"/schemas/roledtopagedresultsdto","deprecated":false},{"title":"ServiceOffering","link":"/schemas/serviceoffering","deprecated":false},{"title":"ServiceOfferingDtoPagedResultsDto","link":"/schemas/serviceofferingdtopagedresultsdto","deprecated":false},{"title":"Stage","link":"/schemas/stage","deprecated":false},{"title":"StageDtoPagedResultsDto","link":"/schemas/stagedtopagedresultsdto","deprecated":false},{"title":"Tag","link":"/schemas/tag","deprecated":false},{"title":"TagList","link":"/schemas/taglist","deprecated":false},{"title":"TimeOffAllocation","link":"/schemas/timeoffallocation","deprecated":false},{"title":"TimeOffCategory","link":"/schemas/timeoffcategory","deprecated":false},{"title":"TimesheetEntry","link":"/schemas/timesheetentry","deprecated":false},{"title":"TimesheetEntryDtoPagedResultsDto","link":"/schemas/timesheetentrydtopagedresultsdto","deprecated":false},{"title":"TimesheetSubmissionState","link":"/schemas/timesheetsubmissionstate","deprecated":false},{"title":"UpdateActualTime","link":"/schemas/updateactualtime","deprecated":false},{"title":"UpdateActualTimeOff","link":"/schemas/updateactualtimeoff","deprecated":false},{"title":"UpdateClient","link":"/schemas/updateclient","deprecated":false},{"title":"UpdateDepartment","link":"/schemas/updatedepartment","deprecated":false},{"title":"UpdateOtherCostAndRevenue","link":"/schemas/updateothercostandrevenue","deprecated":false},{"title":"UpdatePerson","link":"/schemas/updateperson","deprecated":false},{"title":"UpdatePipeline","link":"/schemas/updatepipeline","deprecated":false},{"title":"UpdatePlannedTimeOff","link":"/schemas/updateplannedtimeoff","deprecated":false},{"title":"UpdateProject","link":"/schemas/updateproject","deprecated":false},{"title":"UpdateProjectOffering","link":"/schemas/updateprojectoffering","deprecated":false},{"title":"UpdateProjectOfferingRole","link":"/schemas/updateprojectofferingrole","deprecated":false},{"title":"UpdateRole","link":"/schemas/updaterole","deprecated":false},{"title":"UpdateStage","link":"/schemas/updatestage","deprecated":false},{"title":"UpdateTag","link":"/schemas/updatetag","deprecated":false},{"title":"UpdateWebhookSubscriber","link":"/schemas/updatewebhooksubscriber","deprecated":false},{"title":"ValidationErrorResponse","link":"/schemas/validationerrorresponse","deprecated":false},{"title":"WebhookSubscriber","link":"/schemas/webhooksubscriber","deprecated":false},{"title":"WebhookSubscriberSummary","link":"/schemas/webhooksubscribersummary","deprecated":false},{"title":"WebhookSubscriberSummaryDtoPagedResultsDto","link":"/schemas/webhooksubscribersummarydtopagedresultsdto","deprecated":false},{"title":"WebhookSubscription","link":"/schemas/webhooksubscription","deprecated":false},{"title":"WebhookSubscriptionDtoPagedResultsDto","link":"/schemas/webhooksubscriptiondtopagedresultsdto","deprecated":false},{"title":"WorkerType","link":"/schemas/workertype","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ActualTime":{"id":"components/schemas/ActualTime","kind":"json-schema","title":"ActualTime","data":{"type":"object","properties":{"id":{"type":"string","description":"The id of the actual time entry","format":"uuid"},"project_id":{"type":"string","description":"The id of the project that the actual time is being recorded for.","format":"uuid"},"project_offering_id":{"type":"string","description":"The id of the project offering in which the actual time entry belongs to.","format":"uuid"},"project_offering_role_id":{"type":"string","description":"The id of the project offering role that the actual time is recorded to.","format":"uuid"},"person_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of the Person to which the actual time entry belongs. If a person is specified who does not currently have a role on the project, a new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProjectOfferingRole"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be created using the person's default organization role. The person will be assigned to it, and the ActualTime entry will be attached."},"children":[]}]}]}],"format":"uuid"},"description":{"type":"string","description":"Notes associated with the actual time entry.","nullable":true},"recorded_date":{"type":"string","description":"The date for which the actual time entry is recorded. ISO date formatting expected (yyyy-MM-dd)","format":"date"},"hours":{"type":"number","description":"The number of hours associated with the actual time entry.","format":"double"},"billable":{"type":"boolean","description":"Indicates whether the actual time entry was for billable work."}},"additionalProperties":false}},"components/schemas/ActualTimeDtoPagedResultsDto":{"id":"components/schemas/ActualTimeDtoPagedResultsDto","kind":"json-schema","title":"ActualTimeDtoPagedResultsDto","data":{"required":["results"],"type":"object","properties":{"count":{"type":"integer","description":"The number of results in the current page.","format":"int64"},"total":{"type":"integer","description":"The total number of results that fulfill the request.","format":"int64"},"page":{"type":"integer","description":"The current page of results being returned.","format":"int64"},"total_pages":{"type":"integer","description":"The total number of available pages that fulfill the request.","format":"int64"},"page_size":{"type":"integer","description":"The number of results in each page returned.","format":"int64"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ActualTime"},"description":"The array of result objects for the current page."}},"additionalProperties":false}},"components/schemas/ActualTimeOff":{"id":"components/schemas/ActualTimeOff","kind":"json-schema","title":"ActualTimeOff","data":{"type":"object","properties":{"id":{"type":"string","description":"The id of the actual time off entry.","format":"uuid"},"person_id":{"type":"string","description":"The id of the person to whom the actual time off belongs.","format":"uuid"},"recorded_date":{"type":"string","description":"The date on which the time off was recorded, in YYYY-MM-DD format.","format":"date"},"hours":{"type":"number","description":"The number of hours of time off recorded.","format":"double"},"time_off_category":{"title":"TimeOffCategory","type":"string","allOf":[{"$ref":"#/components/schemas/TimeOffCategory"}],"description":"The category of time off.","x-schema-name":"TimeOffCategory"},"description":{"type":"string","description":"Optional notes associated with the actual time off entry.","nullable":true}},"additionalProperties":false}},"components/schemas/ActualTimeOffDtoPagedResultsDto":{"id":"components/schemas/ActualTimeOffDtoPagedResultsDto","kind":"json-schema","title":"ActualTimeOffDtoPagedResultsDto","data":{"required":["results"],"type":"object","properties":{"count":{"type":"integer","description":"The number of results in the current page.","format":"int64"},"total":{"type":"integer","description":"The total number of results that fulfill the request.","format":"int64"},"page":{"type":"integer","description":"The current page of results being returned.","format":"int64"},"total_pages":{"type":"integer","description":"The total number of available pages that fulfill the request.","format":"int64"},"page_size":{"type":"integer","description":"The number of results in each page returned.","format":"int64"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ActualTimeOff"},"description":"The array of result objects for the current page."}},"additionalProperties":false}},"components/schemas/AddExternalId":{"id":"components/schemas/AddExternalId","kind":"json-schema","title":"AddExternalId","data":{"type":"object","properties":{"external_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An opaque string identifier from an external system. Must not start with a reserved 'px_' provider prefix. Forward slashes ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") are not supported."},"children":[]}]}]}]}},"additionalProperties":false}},"components/schemas/AddOfferingExternalId":{"id":"components/schemas/AddOfferingExternalId","kind":"json-schema","title":"AddOfferingExternalId","data":{"type":"object","properties":{"external_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An opaque string identifier from an external system. Must not start with a reserved 'px_' provider prefix. Forward slashes ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") are not supported."},"children":[]}]}]}]}},"additionalProperties":false}},"components/schemas/AddPersonExternalId":{"id":"components/schemas/AddPersonExternalId","kind":"json-schema","title":"AddPersonExternalId","data":{"type":"object","properties":{"external_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An opaque string identifier from an external system. Must not start with a reserved 'px_' provider prefix. Forward slashes ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") are not supported."},"children":[]}]}]}]}},"additionalProperties":false}},"components/schemas/AdjustmentType":{"id":"components/schemas/AdjustmentType","kind":"json-schema","title":"AdjustmentType","data":{"enum":["cost","revenue"],"type":"string"}},"components/schemas/Assignment":{"id":"components/schemas/Assignment","kind":"json-schema","title":"Assignment","data":{"required":["id","type"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource assigned to the project offering role.","format":"uuid"},"type":{"title":"AssignmentType","type":"string","allOf":[{"$ref":"#/components/schemas/AssignmentType"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the resource assigned to the project offering role. This describes which entity type is being referred to by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"x-schema-name":"AssignmentType"}},"additionalProperties":false}},"components/schemas/AssignmentType":{"id":"components/schemas/AssignmentType","kind":"json-schema","title":"AssignmentType","data":{"enum":["person","requisition"],"type":"string"}},"components/schemas/BillingModel":{"id":"components/schemas/BillingModel","kind":"json-schema","title":"BillingModel","data":{"enum":["fixed_bid","time_materials","retainer","non_billable","investment","admin"],"type":"string"}},"components/schemas/BillingModelOptionsBase":{"id":"components/schemas/BillingModelOptionsBase","kind":"json-schema","title":"BillingModelOptionsBase","data":{"required":["billing_model"],"type":"object","properties":{"billing_model":{"title":"BillingModel","type":"string","allOf":[{"$ref":"#/components/schemas/BillingModel"}],"description":"The Billing Model of the Project Offering Configuration.  This needs to match the Billing Model in the parent request body.","x-schema-name":"BillingModel"}},"additionalProperties":false}},"components/schemas/BillingModelOptionsFixedBid":{"id":"components/schemas/BillingModelOptionsFixedBid","kind":"json-schema","title":"BillingModelOptionsFixedBid","data":{"required":["service_fee"],"type":"object","allOf":[{"$ref":"#/components/schemas/BillingModelOptionsBase"}],"properties":{"service_fee":{"title":"Money","type":"object","allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The total service fees for the fixed bid Project Offering.","x-schema-name":"Money"}},"additionalProperties":false}},"components/schemas/BillingModelOptionsRetainer":{"id":"components/schemas/BillingModelOptionsRetainer","kind":"json-schema","title":"BillingModelOptionsRetainer","data":{"required":["fee_schedule"],"type":"object","allOf":[{"$ref":"#/components/schemas/BillingModelOptionsBase"}],"properties":{"fee_schedule":{"type":"array","items":{"$ref":"#/components/schemas/FeeSchedule"},"description":"The fee schedule for the fixed retainer Project Offering. There can only be one fee item per calendar date. When updating the fee schedule of a Project Offering, all existing fee schedule items will be removed and replaced with the provided list.","nullable":true}},"additionalProperties":false}},"components/schemas/BillingModelOptionsTimeMaterials":{"id":"components/schemas/BillingModelOptionsTimeMaterials","kind":"json-schema","title":"BillingModelOptionsTimeMaterials","data":{"required":["rate_card_id"],"type":"object","allOf":[{"$ref":"#/components/schemas/BillingModelOptionsBase"}],"properties":{"rate_card_id":{"type":"string","description":"The ID for the Rate Card that should be associated with this Time and Materials Project Offering.","format":"uuid"}},"additionalProperties":false}},"components/schemas/Client":{"id":"components/schemas/Client","kind":"json-schema","title":"Client","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the client in Parallax.","format":"uuid"},"name":{"type":"string","description":"The name of the client organization associated with one or more projects."},"archived":{"type":"boolean","description":"Indicates whether the client record has been archived and is no longer active for project assignment."},"created_date":{"type":"string","description":"The date and time when the client record was initially created in Parallax.","format":"date-time"},"modified_date":{"type":"string","description":"The date and time when the client record was last modified in Parallax.","format":"date-time"}},"additionalProperties":false}},"components/schemas/ClientDtoPagedResultsDto":{"id":"components/schemas/ClientDtoPagedResultsDto","kind":"json-schema","title":"ClientDtoPagedResultsDto","data":{"required":["results"],"type":"object","properties":{"count":{"type":"integer","description":"The number of results in the current page.","format":"int64"},"total":{"type":"integer","description":"The total number of results that fulfill the request.","format":"int64"},"page":{"type":"integer","description":"The current page of results being returned.","format":"int64"},"total_pages":{"type":"integer","description":"The total number of available pages that fulfill the request.","format":"int64"},"page_size":{"type":"integer","description":"The number of results in each page returned.","format":"int64"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Client"},"description":"The array of result objects for the current page."}},"additionalProperties":false}},"components/schemas/CostMetrics":{"id":"components/schemas/CostMetrics","kind":"json-schema","title":"CostMetrics","data":{"required":["actual_costs","estimated_at_completion_costs","estimated_to_completion_costs","sold_costs"],"type":"object","properties":{"sold_costs":{"title":"Money","type":"object","allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The total cost associated to the offering at the time the sold snapshot was generated.","x-schema-name":"Money"},"actual_costs":{"title":"Money","type":"object","allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The actual costs associated to the offering at the time the metrics were generated.","x-schema-name":"Money"},"estimated_at_completion_costs":{"title":"Money","type":"object","allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The total cost estimated at the time of offering completion.","x-schema-name":"Money"},"estimated_to_completion_costs":{"title":"Money","type":"object","allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The total cost estimated remaining to the time of offering completion.","x-schema-name":"Money"}},"additionalProperties":false}},"components/schemas/CreateActualTime":{"id":"components/schemas/CreateActualTime","kind":"json-schema","title":"CreateActualTime","data":{"required":["billable","hours","person_id","project_id","project_offering_id","recorded_date"],"type":"object","properties":{"project_id":{"type":"string","description":"The id of the project that the actual time is being recorded for.","format":"uuid"},"project_offering_id":{"type":"string","description":"The id of the project offering in which the actual time entry belongs to.","format":"uuid"},"person_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of the Person to which the actual time entry belongs. If a person is specified who does not currently have a role on the project, a new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProjectOfferingRole"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be created using the person's default organization role. The person will be assigned to it, and the ActualTime entry will be attached."},"children":[]}]}]}],"format":"uuid"},"description":{"type":"string","description":"Notes associated with the actual time entry.","nullable":true},"recorded_date":{"type":"string","description":"The date for which the actual time entry is recorded. ISO date formatting expected (yyyy-MM-dd)","format":"date"},"hours":{"type":"number","description":"The number of hours associated with the actual time entry.","format":"double"},"billable":{"type":"boolean","description":"Indicates whether the actual time entry was for billable work."}},"additionalProperties":false}},"components/schemas/CreateActualTimeOff":{"id":"components/schemas/CreateActualTimeOff","kind":"json-schema","title":"CreateActualTimeOff","data":{"required":["hours","person_id","recorded_date","time_off_category"],"type":"object","properties":{"person_id":{"type":"string","description":"The id of the person to whom the actual time off belongs.","format":"uuid"},"recorded_date":{"type":"string","description":"The date on which the time off was recorded, in YYYY-MM-DD format.","format":"date"},"hours":{"type":"number","description":"The number of hours of time off recorded.","format":"double"},"time_off_category":{"title":"TimeOffCategory","type":"string","allOf":[{"$ref":"#/components/schemas/TimeOffCategory"}],"description":"The category of time off.","x-schema-name":"TimeOffCategory"},"description":{"type":"string","description":"Optional notes associated with the actual time off entry.","nullable":true}},"additionalProperties":false}},"components/schemas/CreateClient":{"id":"components/schemas/CreateClient","kind":"json-schema","title":"CreateClient","data":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"The name of the client organization associated with one or more projects."}},"additionalProperties":false}},"components/schemas/CreateDepartment":{"id":"components/schemas/CreateDepartment","kind":"json-schema","title":"CreateDepartment","data":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"The name of the department used to categorize employees into functional teams for capacity planning."}},"additionalProperties":false}},"components/schemas/CreateOtherCostAndRevenue":{"id":"components/schemas/CreateOtherCostAndRevenue","kind":"json-schema","title":"CreateOtherCostAndRevenue","data":{"required":["amount","date","type"],"type":"object","properties":{"type":{"title":"AdjustmentType","type":"string","allOf":[{"$ref":"#/components/schemas/AdjustmentType"}],"description":"The type of entry: \"cost\" or \"revenue\".","x-schema-name":"AdjustmentType"},"amount":{"title":"Money","type":"object","allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The monetary amount of the entry.","x-schema-name":"Money"},"date":{"type":"string","description":"The effective date of the entry in ISO format.","format":"date"},"name":{"type":"string","description":"An optional descriptive name for the entry.","nullable":true},"project_offering_id":{"type":"string","description":"The unique identifier of the Project Offering this entry is associated with, or null for project-level entries.","format":"uuid","nullable":true}},"additionalProperties":false}},"components/schemas/CreatePerson":{"id":"components/schemas/CreatePerson","kind":"json-schema","title":"CreatePerson","data":{"required":["email_address"],"type":"object","properties":{"given_name":{"type":"string","description":"The first name or given name of the Person.","nullable":true},"family_name":{"type":"string","description":"The last name or family name of the Person.","nullable":true},"email_address":{"minLength":1,"type":"string","description":"The email address associated with the Person."},"capacity":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The capacity of this Person if they are using a custom capacity instead of their Role's capacity.Note: This value can be cleared out by sending "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request body."},"children":[]}]}]}],"format":"double","nullable":true},"role_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Id of the Role to be used as the primary (default) Role for this person. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the unassigned role will be applied instead."},"children":[]}]}]}],"format":"uuid","nullable":true},"billable_utilization_target":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billable utilization target of this Person if they are using a custom target utilization instead of their Role's target utilization. Note: This value can be cleared out by sending "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request body."},"children":[]}]}]}],"format":"double","nullable":true},"billable":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Denotes whether this Person's time worked is billable. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for new records."},"children":[]}]}]}]},"start_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The earliest date this Person is available for resourcing on a Project. The Person's capacity prior to this date is 0%."},"children":[]}]}]}],"format":"date","nullable":true},"end_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this Person will have or has had their employment or contract terminated, this is the last date they are available for resourcing on a project. They will automatically be archived after this date has passed, and their capacity will drop to 0%. This value can be cleared out by sending "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request body."},"children":[]}]}]}],"format":"date","nullable":true},"worker_type":{"title":"WorkerType","type":"string","allOf":[{"$ref":"#/components/schemas/WorkerType"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Denotes whether this Person is a full time employee, contractor, etc. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"full_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for new records."},"children":[]}]}]}],"x-schema-name":"WorkerType"},"tags":{"type":"array","items":{"type":"string"},"description":"A list of tags used to categorize the Person for filtering, reporting, or custom grouping.","nullable":true},"image_url":{"type":"string","description":"A publicly-accessible URL to an avatar for this Person.","nullable":true}},"additionalProperties":false}},"components/schemas/CreatePipeline":{"id":"components/schemas/CreatePipeline","kind":"json-schema","title":"CreatePipeline","data":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"The name of the Pipeline, typically reflecting the sales funnel or opportunity workflow."},"is_enabled":{"type":"boolean","description":"Indicates whether syncs for this Pipeline are enabled; differs from IsArchived.","default":true}},"additionalProperties":false}},"components/schemas/CreatePlannedTimeOff":{"id":"components/schemas/CreatePlannedTimeOff","kind":"json-schema","title":"CreatePlannedTimeOff","data":{"required":["allocations","person_id"],"type":"object","properties":{"person_id":{"type":"string","description":"The unique identifier of the person associated with this time off.","format":"uuid"},"allocations":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffAllocation"},"description":"The list of date and hours allocations for this time off."}},"additionalProperties":false}},"components/schemas/CreateProject":{"id":"components/schemas/CreateProject","kind":"json-schema","title":"CreateProject","data":{"required":["client_id","name","start_date","target_budget"],"type":"object","properties":{"name":{"type":"string","description":"The name of the Project, typically describing the work engagement or scope for the Client."},"start_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheduled start date for the Project’s resource plan."},"children":[]}]}]}],"format":"date"},"end_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheduled end date for the Project’s resource plan."},"children":[]}]}]}],"format":"date","nullable":true},"client_id":{"type":"string","description":"Id of the Client associated with this Project.","format":"uuid"},"target_budget":{"title":"Money","type":"object","allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The target budget for the Project, representing the expected revenue from the Client.","x-schema-name":"Money"},"target_margin":{"type":"number","description":"Target margin for the Project. Defaults to Organization's target margin.","format":"double","nullable":true},"tags":{"type":"array","items":{"type":"string"},"description":"A list of tags assigned to the Project for filtering, categorization, or reporting."},"project_model":{"title":"ProjectModel","type":"string","allOf":[{"$ref":"#/components/schemas/ProjectModel"}],"description":"Project model. Default is client.","x-schema-name":"ProjectModel"},"currency_code":{"type":"string","description":"Currency code for the Project. Defaults to Organization's currency code.","nullable":true},"status":{"title":"ProjectStatus","type":"string","allOf":[{"$ref":"#/components/schemas/ProjectStatus"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status for the Project. Default is pre_sale."},"children":[]}]}]}],"nullable":true,"x-schema-name":"ProjectStatus"},"stage_id":{"type":"string","description":"The CRM Pipeline Stage id this Project is linked to.","format":"uuid","nullable":true},"project_owner_id":{"type":"string","description":"Id of the Person who owns this Project.","format":"uuid","nullable":true},"sales_owner_id":{"type":"string","description":"Id of the Person who is responsible for the sale of this Project.","format":"uuid","nullable":true},"external_ids":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional list of custom external IDs to associate with the Project at creation time. Each ID must not start with a reserved 'px_' provider prefix and must be unique across all Projects in the organization. Forward slashes ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") are not supported."},"children":[]}]}]}],"nullable":true}},"additionalProperties":false}},"components/schemas/CreateProjectOffering":{"id":"components/schemas/CreateProjectOffering","kind":"json-schema","title":"CreateProjectOffering","data":{"required":["billing_model","name"],"type":"object","properties":{"name":{"type":"string","description":"The name for the Project Offering."},"billing_model":{"title":"BillingModel","type":"string","allOf":[{"$ref":"#/components/schemas/BillingModel"}],"description":"The Billing Model for the Project Offering.","x-schema-name":"BillingModel"},"billing_model_options":{"type":"object","oneOf":[{"$ref":"#/components/schemas/BillingModelOptionsFixedBid"},{"$ref":"#/components/schemas/BillingModelOptionsRetainer"},{"$ref":"#/components/schemas/BillingModelOptionsTimeMaterials"}],"description":"Additional Billing Model configuration for the Project Offering.","nullable":true},"external_ids":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional list of custom external IDs to associate with the Project Offering at creation time. Each ID must not start with a reserved 'px_' provider prefix and must be unique across all Project Offerings in the organization. Forward slashes ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") are not supported."},"children":[]}]}]}],"nullable":true},"service_offering_id":{"type":"string","description":"The ID of an existing Service Offering to copy roles, plan allocations, and tags from. The Project Offering's name and billing model still come from this request.","format":"uuid","nullable":true}},"additionalProperties":false}},"components/schemas/CreateProjectOfferingRole":{"id":"components/schemas/CreateProjectOfferingRole","kind":"json-schema","title":"CreateProjectOfferingRole","data":{"required":["role_id"],"type":"object","properties":{"role_id":{"type":"string","description":"Id of the Role that will be performing work on this ProjectOffering.","format":"uuid"},"assignment":{"title":"Assignment","type":"object","allOf":[{"$ref":"#/components/schemas/Assignment"}],"description":"Optional assignment of a Person or Requisition to this role.","nullable":true,"x-schema-name":"Assignment"},"tags":{"type":"array","items":{"type":"string"},"description":"Optional list of tags to associate with this Project Offering Role. Tags help categorize and filter roles.","nullable":true}},"additionalProperties":false}},"components/schemas/CreateRole":{"id":"components/schemas/CreateRole","kind":"json-schema","title":"CreateRole","data":{"required":["department_id","name"],"type":"object","properties":{"department_id":{"type":"string","description":"The unique identifier of the Department that this Role belongs to for capacity and reporting segmentation.","format":"uuid"},"name":{"type":"string","description":"The name of the Role, typically describing the job function or skill set (e.g. Designer, Developer)."}},"additionalProperties":false}},"components/schemas/CreateStage":{"id":"components/schemas/CreateStage","kind":"json-schema","title":"CreateStage","data":{"required":["confidence","name"],"type":"object","properties":{"name":{"type":"string"},"confidence":{"type":"number","format":"double"}},"additionalProperties":false}},"components/schemas/CreateSubscription":{"id":"components/schemas/CreateSubscription","kind":"json-schema","title":"CreateSubscription","data":{"required":["topic"],"type":"object","properties":{"topic":{"type":"string","description":"The event topic for this subscription (e.g., 'project.created', 'project.updated')."}},"additionalProperties":false}},"components/schemas/CreateTag":{"id":"components/schemas/CreateTag","kind":"json-schema","title":"CreateTag","data":{"required":["tag"],"type":"object","properties":{"tag":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tag to create."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tag names are structured as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CATEGORY::TAG_NAME"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"::"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" separating the category and tag name. Category names will be returned with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"::"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in their name."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Skills::"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would indicate a category named skills. Further, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Skills::ActionScript"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would indicate a tag named "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ActionScript"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" within the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Skills"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" category."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New category and tag names may not start or end with whitespace, so creating "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Skills:: ActionScript"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is rejected. Whitespace within a name is allowed: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Front End::Dust Bringer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is valid."},"children":[]}]}]}]}},"additionalProperties":false}},"components/schemas/CreateWebhookSubscriber":{"id":"components/schemas/CreateWebhookSubscriber","kind":"json-schema","title":"CreateWebhookSubscriber","data":{"type":"object","properties":{"callback_url":{"type":"string"},"active":{"type":"boolean"}},"additionalProperties":false}},"components/schemas/Department":{"id":"components/schemas/Department","kind":"json-schema","title":"Department","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the department in Parallax.","format":"uuid"},"name":{"type":"string","description":"The name of the department used to categorize employees into functional teams for capacity planning."},"archived":{"type":"boolean","description":"Indicates whether the department is archived and no longer active for resource assignment or reporting."}},"additionalProperties":false}},"components/schemas/DepartmentDtoPagedResultsDto":{"id":"components/schemas/DepartmentDtoPagedResultsDto","kind":"json-schema","title":"DepartmentDtoPagedResultsDto","data":{"required":["results"],"type":"object","properties":{"count":{"type":"integer","description":"The number of results in the current page.","format":"int64"},"total":{"type":"integer","description":"The total number of results that fulfill the request.","format":"int64"},"page":{"type":"integer","description":"The current page of results being returned.","format":"int64"},"total_pages":{"type":"integer","description":"The total number of available pages that fulfill the request.","format":"int64"},"page_size":{"type":"integer","description":"The number of results in each page returned.","format":"int64"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Department"},"description":"The array of result objects for the current page."}},"additionalProperties":false}},"components/schemas/FeeSchedule":{"id":"components/schemas/FeeSchedule","kind":"json-schema","title":"FeeSchedule","data":{"required":["fee_amount","occured_on"],"type":"object","properties":{"occured_on":{"type":"string","description":"The amount of the service fee.","format":"date"},"fee_amount":{"title":"Money","type":"object","allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The date in which the service fee was invoiced, received or otherwise recognized in ISO format.","x-schema-name":"Money"}},"additionalProperties":false}},"components/schemas/HoursMetrics":{"id":"components/schemas/HoursMetrics","kind":"json-schema","title":"HoursMetrics","data":{"required":["actual_hours","estimated_at_completion_hours","estimated_to_completion_hours","sold_hours"],"type":"object","properties":{"sold_hours":{"type":"number","description":"The total revenue associated to the offering at the time the sold snapshot was generated.","format":"double"},"actual_hours":{"type":"number","description":"The actual revenue associated to the offering at the time the metrics were generated.","format":"double"},"estimated_at_completion_hours":{"type":"number","description":"The total revenue estimated at the time of offering completion.","format":"double"},"estimated_to_completion_hours":{"type":"number","description":"The total revenue estimated remaining to the time of offering completion.","format":"double"}},"additionalProperties":false}},"components/schemas/Money":{"id":"components/schemas/Money","kind":"json-schema","title":"Money","data":{"type":"object","properties":{"currency_code":{"type":"string","description":"The currency code of the monetary object."},"amount":{"type":"number","description":"The amount of the monetary object.","format":"double","default":0}},"additionalProperties":false}},"components/schemas/OtherCostAndRevenue":{"id":"components/schemas/OtherCostAndRevenue","kind":"json-schema","title":"OtherCostAndRevenue","data":{"required":["amount","date","id","type"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the entry.","format":"uuid"},"name":{"type":"string","description":"An optional descriptive name for the entry.","nullable":true},"date":{"type":"string","description":"The effective date of the entry in ISO format.","format":"date"},"amount":{"title":"Money","type":"object","allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The monetary amount of the entry.","x-schema-name":"Money"},"type":{"title":"AdjustmentType","type":"string","allOf":[{"$ref":"#/components/schemas/AdjustmentType"}],"description":"The type of entry: \"cost\" or \"revenue\".","x-schema-name":"AdjustmentType"},"project_offering_id":{"type":"string","description":"The unique identifier of the Project Offering this entry is associated with, or null for project-level entries.","format":"uuid","nullable":true}},"additionalProperties":false}},"components/schemas/OtherCostAndRevenueDtoPagedResultsDto":{"id":"components/schemas/OtherCostAndRevenueDtoPagedResultsDto","kind":"json-schema","title":"OtherCostAndRevenueDtoPagedResultsDto","data":{"required":["results"],"type":"object","properties":{"count":{"type":"integer","description":"The number of results in the current page.","format":"int64"},"total":{"type":"integer","description":"The total number of results that fulfill the request.","format":"int64"},"page":{"type":"integer","description":"The current page of results being returned.","format":"int64"},"total_pages":{"type":"integer","description":"The total number of available pages that fulfill the request.","format":"int64"},"page_size":{"type":"integer","description":"The number of results in each page returned.","format":"int64"},"results":{"type":"array","items":{"$ref":"#/components/schemas/OtherCostAndRevenue"},"description":"The array of result objects for the current page."}},"additionalProperties":false}},"components/schemas/Person":{"id":"components/schemas/Person","kind":"json-schema","title":"Person","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the Person in Parallax.","format":"uuid"},"given_name":{"type":"string","description":"The first name or given name of the Person.","nullable":true},"family_name":{"type":"string","description":"The last name or family name of the Person.","nullable":true},"email_address":{"type":"string","description":"The email address associated with the Person.","nullable":true},"capacity":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The capacity of this Person if they are using a custom capacity instead of their Role's capacity.Note: This value can be cleared out by sending "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request body."},"children":[]}]}]}],"format":"double","nullable":true},"role_id":{"type":"string","description":"Id of the Role to be used as the primary (default) Role for this person.","format":"uuid"},"billable_utilization_target":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billable utilization target of this Person if they are using a custom target utilization instead of their Role's target utilization. Note: This value can be cleared out by sending "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request body."},"children":[]}]}]}],"format":"double","nullable":true},"billable":{"type":"boolean","description":"Indicates whether the Person's work is considered billable for client projects."},"start_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The earliest date this Person is available for resourcing on a Project. The Person's capacity prior to this date is 0%."},"children":[]}]}]}],"format":"date","nullable":true},"end_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this Person will have or has had their employment or contract terminated, this is the last date they are available for resourcing on a project. They will automatically be archived after this date has passed, and their capacity will drop to 0%. This value can be cleared out by sending "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request body."},"children":[]}]}]}],"format":"date","nullable":true},"worker_type":{"title":"WorkerType","type":"string","allOf":[{"$ref":"#/components/schemas/WorkerType"}],"description":"Specifies the worker classification for the Person, such as Employee or Contractor.","x-schema-name":"WorkerType"},"tags":{"type":"array","items":{"type":"string"},"description":"A list of tags used to categorize the Person for filtering, reporting, or custom grouping."},"created_date":{"type":"string","description":"The date and time when the Person record was created in Parallax.","format":"date-time"},"modified_date":{"type":"string","description":"The date and time when the Person record was last modified in Parallax.","format":"date-time"},"image_url":{"type":"string","description":"The URL of the profile image associated with the Person.","nullable":true},"archived":{"type":"boolean","description":"Indicates whether the Person is archived and no longer active for project assignment or planning."},"current_cost_rate":{"title":"Money","type":"object","allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The current effective cost rate for the person. This will return the current overridden cost rate of the person, and will fall back to the current cost rate of their assigned role if there is no override.","x-schema-name":"Money"},"external_ids":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All external IDs associated with the Person. Parallax-managed integrations use the delimited format 'px_{provider}:{id}' (e.g., 'px_hubspot:12345678901')."},"children":[]}]}]}]}},"additionalProperties":false}},"components/schemas/PersonDtoPagedResultsDto":{"id":"components/schemas/PersonDtoPagedResultsDto","kind":"json-schema","title":"PersonDtoPagedResultsDto","data":{"required":["results"],"type":"object","properties":{"count":{"type":"integer","description":"The number of results in the current page.","format":"int64"},"total":{"type":"integer","description":"The total number of results that fulfill the request.","format":"int64"},"page":{"type":"integer","description":"The current page of results being returned.","format":"int64"},"total_pages":{"type":"integer","description":"The total number of available pages that fulfill the request.","format":"int64"},"page_size":{"type":"integer","description":"The number of results in each page returned.","format":"int64"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Person"},"description":"The array of result objects for the current page."}},"additionalProperties":false}},"components/schemas/Pipeline":{"id":"components/schemas/Pipeline","kind":"json-schema","title":"Pipeline","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the Pipeline in Parallax.","format":"uuid"},"name":{"type":"string","description":"The name of the Pipeline, typically reflecting the sales funnel or opportunity workflow."},"currency_code":{"type":"string","description":"The ISO currency code associated with the Pipeline, used for financial values tied to deals."},"is_enabled":{"type":"boolean","description":"Indicates whether syncs for this Pipeline are enabled; differs from IsArchived."},"archived":{"type":"boolean","description":"Indicates whether the Pipeline is archived and no longer active in Parallax."}},"additionalProperties":false}},"components/schemas/PipelineDtoPagedResultsDto":{"id":"components/schemas/PipelineDtoPagedResultsDto","kind":"json-schema","title":"PipelineDtoPagedResultsDto","data":{"required":["results"],"type":"object","properties":{"count":{"type":"integer","description":"The number of results in the current page.","format":"int64"},"total":{"type":"integer","description":"The total number of results that fulfill the request.","format":"int64"},"page":{"type":"integer","description":"The current page of results being returned.","format":"int64"},"total_pages":{"type":"integer","description":"The total number of available pages that fulfill the request.","format":"int64"},"page_size":{"type":"integer","description":"The number of results in each page returned.","format":"int64"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Pipeline"},"description":"The array of result objects for the current page."}},"additionalProperties":false}},"components/schemas/PlannedTimeOff":{"id":"components/schemas/PlannedTimeOff","kind":"json-schema","title":"PlannedTimeOff","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the planned time off.","format":"uuid"},"person_id":{"type":"string","description":"The unique identifier of the person associated with this time off.","format":"uuid"},"allocations":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffAllocation"},"description":"The list of date and hours allocations for this time off."}},"additionalProperties":false}},"components/schemas/PlannedTimeOffDtoPagedResultsDto":{"id":"components/schemas/PlannedTimeOffDtoPagedResultsDto","kind":"json-schema","title":"PlannedTimeOffDtoPagedResultsDto","data":{"required":["results"],"type":"object","properties":{"count":{"type":"integer","description":"The number of results in the current page.","format":"int64"},"total":{"type":"integer","description":"The total number of results that fulfill the request.","format":"int64"},"page":{"type":"integer","description":"The current page of results being returned.","format":"int64"},"total_pages":{"type":"integer","description":"The total number of available pages that fulfill the request.","format":"int64"},"page_size":{"type":"integer","description":"The number of results in each page returned.","format":"int64"},"results":{"type":"array","items":{"$ref":"#/components/schemas/PlannedTimeOff"},"description":"The array of result objects for the current page."}},"additionalProperties":false}},"components/schemas/Project":{"id":"components/schemas/Project","kind":"json-schema","title":"Project","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the Project in Parallax.","format":"uuid"},"name":{"type":"string","description":"The name of the Project, typically describing the work engagement or scope for the Client."},"client_id":{"type":"string","description":"Id of the Client associated with this Project.","format":"uuid","nullable":true},"stage_id":{"type":"string","description":"Id of the Project's current Pipeline Stage.","format":"uuid","nullable":true},"project_owner_id":{"type":"string","description":"Id of the Person who owns this Project.","format":"uuid","nullable":true},"sales_owner_id":{"type":"string","description":"Id of the Person who is responsible for the sale of this Project.","format":"uuid","nullable":true},"start_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheduled start date for the Project’s resource plan."},"children":[]}]}]}],"format":"date"},"end_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheduled end date for the Project’s resource plan."},"children":[]}]}]}],"format":"date"},"target_budget":{"title":"Money","type":"object","allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The target budget for the Project, representing the expected revenue from the Client.","x-schema-name":"Money"},"target_margin":{"type":"number","description":"Target margin for the Project. Defaults to Organization's target margin.","format":"double"},"currency_code":{"type":"string","description":"Currency code for the Project. Defaults to Organization's currency code."},"status":{"title":"ProjectStatus","type":"string","allOf":[{"$ref":"#/components/schemas/ProjectStatus"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status for the Project. Default is pre_sale."},"children":[]}]}]}],"x-schema-name":"ProjectStatus"},"project_model":{"title":"ProjectModel","type":"string","allOf":[{"$ref":"#/components/schemas/ProjectModel"}],"description":"Project model. Default is client.","x-schema-name":"ProjectModel"},"archived":{"type":"boolean","description":"Indicates whether the Project is archived and no longer active for delivery or planning."},"is_included":{"type":"boolean","description":"Manual flag to hide Projects from reports while keeping them visible in the UI."},"tags":{"type":"array","items":{"type":"string"},"description":"A list of tags assigned to the Project for filtering, categorization, or reporting."},"created_date":{"type":"string","description":"The date and time when the Project record was created in Parallax.","format":"date-time"},"modified_date":{"type":"string","description":"The date and time when the Project record was last modified in Parallax.","format":"date-time"},"external_ids":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All external IDs associated with the Project. Parallax-managed integrations use the delimited format 'px_{provider}:{id}' (e.g., 'px_hubspot:12345678901')."},"children":[]}]}]}]}},"additionalProperties":false}},"components/schemas/ProjectDtoPagedResultsDto":{"id":"components/schemas/ProjectDtoPagedResultsDto","kind":"json-schema","title":"ProjectDtoPagedResultsDto","data":{"required":["results"],"type":"object","properties":{"count":{"type":"integer","description":"The number of results in the current page.","format":"int64"},"total":{"type":"integer","description":"The total number of results that fulfill the request.","format":"int64"},"page":{"type":"integer","description":"The current page of results being returned.","format":"int64"},"total_pages":{"type":"integer","description":"The total number of available pages that fulfill the request.","format":"int64"},"page_size":{"type":"integer","description":"The number of results in each page returned.","format":"int64"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Project"},"description":"The array of result objects for the current page."}},"additionalProperties":false}},"components/schemas/ProjectModel":{"id":"components/schemas/ProjectModel","kind":"json-schema","title":"ProjectModel","data":{"enum":["client","internal"],"type":"string"}},"components/schemas/ProjectOffering":{"id":"components/schemas/ProjectOffering","kind":"json-schema","title":"ProjectOffering","data":{"required":["billing_model","billing_model_options","external_ids","id","name","tags"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the Project Offering.","format":"uuid"},"name":{"type":"string","description":"The name of the Project Offering."},"billing_model":{"title":"BillingModel","type":"string","allOf":[{"$ref":"#/components/schemas/BillingModel"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing model applied to the Project Offering.  This is restricted by the Project's Project Type. Client projects support Time & Materials, Fixed Bid, and Fixed Retainer billing models while Internal projects only allow Investment and Admin models"},"children":[]}]}]}],"x-schema-name":"BillingModel"},"billing_model_options":{"oneOf":[{"$ref":"#/components/schemas/BillingModelOptionsFixedBid"},{"$ref":"#/components/schemas/BillingModelOptionsRetainer"},{"$ref":"#/components/schemas/BillingModelOptionsTimeMaterials"}],"description":"Additional Billing Model configuration for the Project Offering."},"external_ids":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All external IDs associated with the Project Offering. Parallax-managed integrations use the delimited format 'px_{provider}:{id}' (e.g., 'px_harvest:12345678901')."},"children":[]}]}]}]},"tags":{"type":"array","items":{"type":"string"},"description":"A list of tags assigned to the Project Offering for filtering, categorization, or reporting."},"service_offering_id":{"type":"string","description":"The ID of the Service Offering this Project Offering was linked to, if any.","format":"uuid","nullable":true}},"additionalProperties":false}},"components/schemas/ProjectOfferingDtoPagedResultsDto":{"id":"components/schemas/ProjectOfferingDtoPagedResultsDto","kind":"json-schema","title":"ProjectOfferingDtoPagedResultsDto","data":{"required":["results"],"type":"object","properties":{"count":{"type":"integer","description":"The number of results in the current page.","format":"int64"},"total":{"type":"integer","description":"The total number of results that fulfill the request.","format":"int64"},"page":{"type":"integer","description":"The current page of results being returned.","format":"int64"},"total_pages":{"type":"integer","description":"The total number of available pages that fulfill the request.","format":"int64"},"page_size":{"type":"integer","description":"The number of results in each page returned.","format":"int64"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ProjectOffering"},"description":"The array of result objects for the current page."}},"additionalProperties":false}},"components/schemas/ProjectOfferingMetrics":{"id":"components/schemas/ProjectOfferingMetrics","kind":"json-schema","title":"ProjectOfferingMetrics","data":{"required":["cost_metrics","hours_metrics","revenue_metrics"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the Project Offering.","format":"uuid"},"calculated_date":{"type":"string","description":"The date in which the metrics were calculated.","format":"date-time"},"cost_metrics":{"title":"CostMetrics","type":"object","allOf":[{"$ref":"#/components/schemas/CostMetrics"}],"description":"The cost metrics of the project offering.","x-schema-name":"CostMetrics"},"revenue_metrics":{"title":"RevenueMetrics","type":"object","allOf":[{"$ref":"#/components/schemas/RevenueMetrics"}],"description":"The revenue metrics of the project offering.","x-schema-name":"RevenueMetrics"},"hours_metrics":{"title":"HoursMetrics","type":"object","allOf":[{"$ref":"#/components/schemas/HoursMetrics"}],"description":"The hour metrics of the project offering.","x-schema-name":"HoursMetrics"}},"additionalProperties":false}},"components/schemas/ProjectOfferingRole":{"id":"components/schemas/ProjectOfferingRole","kind":"json-schema","title":"ProjectOfferingRole","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the project offering role.","format":"uuid"},"assignment":{"title":"Assignment","type":"object","allOf":[{"$ref":"#/components/schemas/Assignment"}],"description":"The unique identifier for the (optional) person attached to the role.","nullable":true,"x-schema-name":"Assignment"},"role_id":{"type":"string","description":"The unique identifier for role that describes the project offering role.","format":"uuid"},"tags":{"type":"array","items":{"type":"string"},"description":"A list of tags assigned to the Project Offering Role for filtering, categorization, or reporting."}},"additionalProperties":false}},"components/schemas/ProjectOfferingRoleDtoPagedResultsDto":{"id":"components/schemas/ProjectOfferingRoleDtoPagedResultsDto","kind":"json-schema","title":"ProjectOfferingRoleDtoPagedResultsDto","data":{"required":["results"],"type":"object","properties":{"count":{"type":"integer","description":"The number of results in the current page.","format":"int64"},"total":{"type":"integer","description":"The total number of results that fulfill the request.","format":"int64"},"page":{"type":"integer","description":"The current page of results being returned.","format":"int64"},"total_pages":{"type":"integer","description":"The total number of available pages that fulfill the request.","format":"int64"},"page_size":{"type":"integer","description":"The number of results in each page returned.","format":"int64"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ProjectOfferingRole"},"description":"The array of result objects for the current page."}},"additionalProperties":false}},"components/schemas/ProjectOfferingRolePlannedTime":{"id":"components/schemas/ProjectOfferingRolePlannedTime","kind":"json-schema","title":"ProjectOfferingRolePlannedTime","data":{"required":["hours","plan_date"],"type":"object","properties":{"plan_date":{"type":"string","description":"The date in which the actual time entry is recorded to, in the YYYY-MM-DD format.","format":"date"},"hours":{"type":"number","description":"The number of hours associated with the planned time entry.","format":"double"}},"additionalProperties":false}},"components/schemas/ProjectOfferingRolePlannedTimeDtoPagedResultsDto":{"id":"components/schemas/ProjectOfferingRolePlannedTimeDtoPagedResultsDto","kind":"json-schema","title":"ProjectOfferingRolePlannedTimeDtoPagedResultsDto","data":{"required":["results"],"type":"object","properties":{"count":{"type":"integer","description":"The number of results in the current page.","format":"int64"},"total":{"type":"integer","description":"The total number of results that fulfill the request.","format":"int64"},"page":{"type":"integer","description":"The current page of results being returned.","format":"int64"},"total_pages":{"type":"integer","description":"The total number of available pages that fulfill the request.","format":"int64"},"page_size":{"type":"integer","description":"The number of results in each page returned.","format":"int64"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ProjectOfferingRolePlannedTime"},"description":"The array of result objects for the current page."}},"additionalProperties":false}},"components/schemas/ProjectStatus":{"id":"components/schemas/ProjectStatus","kind":"json-schema","title":"ProjectStatus","data":{"enum":["pre_sale","awaiting_start","completed","in_progress","on_hold"],"type":"string"}},"components/schemas/RateCard":{"id":"components/schemas/RateCard","kind":"json-schema","title":"RateCard","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the Rate Card in Parallax.","format":"uuid"},"name":{"type":"string","description":"The name of the Rate Card."},"default_rate":{"title":"Money","type":"object","allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The default rate for roles that are not included in the Rate Card.","x-schema-name":"Money"},"archived":{"type":"boolean","description":"Indicates whether the Rate Card is archived or not."}},"additionalProperties":false}},"components/schemas/RateCardDtoPagedResultsDto":{"id":"components/schemas/RateCardDtoPagedResultsDto","kind":"json-schema","title":"RateCardDtoPagedResultsDto","data":{"required":["results"],"type":"object","properties":{"count":{"type":"integer","description":"The number of results in the current page.","format":"int64"},"total":{"type":"integer","description":"The total number of results that fulfill the request.","format":"int64"},"page":{"type":"integer","description":"The current page of results being returned.","format":"int64"},"total_pages":{"type":"integer","description":"The total number of available pages that fulfill the request.","format":"int64"},"page_size":{"type":"integer","description":"The number of results in each page returned.","format":"int64"},"results":{"type":"array","items":{"$ref":"#/components/schemas/RateCard"},"description":"The array of result objects for the current page."}},"additionalProperties":false}},"components/schemas/RateCardRate":{"id":"components/schemas/RateCardRate","kind":"json-schema","title":"RateCardRate","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the rate card role rate in Parallax.","format":"uuid"},"role_id":{"type":"string","description":"The unique identifier of the role that this rate applies to. This links to the Parallax Role this rate applies to.","format":"uuid"},"rate":{"title":"Money","type":"object","allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The bill rate for this role on the rate card.","x-schema-name":"Money"}},"additionalProperties":false}},"components/schemas/RateCardRateDtoPagedResultsDto":{"id":"components/schemas/RateCardRateDtoPagedResultsDto","kind":"json-schema","title":"RateCardRateDtoPagedResultsDto","data":{"required":["results"],"type":"object","properties":{"count":{"type":"integer","description":"The number of results in the current page.","format":"int64"},"total":{"type":"integer","description":"The total number of results that fulfill the request.","format":"int64"},"page":{"type":"integer","description":"The current page of results being returned.","format":"int64"},"total_pages":{"type":"integer","description":"The total number of available pages that fulfill the request.","format":"int64"},"page_size":{"type":"integer","description":"The number of results in each page returned.","format":"int64"},"results":{"type":"array","items":{"$ref":"#/components/schemas/RateCardRate"},"description":"The array of result objects for the current page."}},"additionalProperties":false}},"components/schemas/RevenueMetrics":{"id":"components/schemas/RevenueMetrics","kind":"json-schema","title":"RevenueMetrics","data":{"required":["actual_revenue","estimated_at_completion_revenue","estimated_to_completion_revenue","sold_revenue"],"type":"object","properties":{"sold_revenue":{"title":"Money","type":"object","allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The total revenue associated to the offering at the time the sold snapshot was generated.","x-schema-name":"Money"},"actual_revenue":{"title":"Money","type":"object","allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The actual revenue associated to the offering at the time the metrics were generated.","x-schema-name":"Money"},"estimated_at_completion_revenue":{"title":"Money","type":"object","allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The total revenue estimated at the time of offering completion.","x-schema-name":"Money"},"estimated_to_completion_revenue":{"title":"Money","type":"object","allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The total revenue estimated remaining to the time of offering completion.","x-schema-name":"Money"}},"additionalProperties":false}},"components/schemas/Role":{"id":"components/schemas/Role","kind":"json-schema","title":"Role","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the Role in Parallax.","format":"uuid"},"name":{"type":"string","description":"The name of the Role, typically describing the job function or skill set (e.g. Designer, Developer)."},"department_id":{"type":"string","description":"The unique identifier of the Department that this Role belongs to for capacity and reporting segmentation.","format":"uuid"},"capacity":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The full-time capacity for this Role, expressed as a decimal percentage (e.g. 1.0 = 100%)."},"children":[]}]}]}],"format":"double"},"billable_utilization_target":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The target percentage of billable utilization expected for this Role, expressed as a decimal percentage (e.g. 1.0 = 100%)."},"children":[]}]}]}],"format":"double"},"archived":{"type":"boolean","description":"Indicates whether this Role has been archived and is no longer active for planning or reporting."},"created_date":{"type":"string","description":"The date and time when the Role record was created in Parallax.","format":"date-time"},"modified_date":{"type":"string","description":"The date and time when the Role record was last modified in Parallax.","format":"date-time"}},"additionalProperties":false}},"components/schemas/RoleDtoPagedResultsDto":{"id":"components/schemas/RoleDtoPagedResultsDto","kind":"json-schema","title":"RoleDtoPagedResultsDto","data":{"required":["results"],"type":"object","properties":{"count":{"type":"integer","description":"The number of results in the current page.","format":"int64"},"total":{"type":"integer","description":"The total number of results that fulfill the request.","format":"int64"},"page":{"type":"integer","description":"The current page of results being returned.","format":"int64"},"total_pages":{"type":"integer","description":"The total number of available pages that fulfill the request.","format":"int64"},"page_size":{"type":"integer","description":"The number of results in each page returned.","format":"int64"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Role"},"description":"The array of result objects for the current page."}},"additionalProperties":false}},"components/schemas/ServiceOffering":{"id":"components/schemas/ServiceOffering","kind":"json-schema","title":"ServiceOffering","data":{"required":["id","name"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the Service Offering.","format":"uuid"},"name":{"type":"string","description":"The name of the Service Offering."}},"additionalProperties":false}},"components/schemas/ServiceOfferingDtoPagedResultsDto":{"id":"components/schemas/ServiceOfferingDtoPagedResultsDto","kind":"json-schema","title":"ServiceOfferingDtoPagedResultsDto","data":{"required":["results"],"type":"object","properties":{"count":{"type":"integer","description":"The number of results in the current page.","format":"int64"},"total":{"type":"integer","description":"The total number of results that fulfill the request.","format":"int64"},"page":{"type":"integer","description":"The current page of results being returned.","format":"int64"},"total_pages":{"type":"integer","description":"The total number of available pages that fulfill the request.","format":"int64"},"page_size":{"type":"integer","description":"The number of results in each page returned.","format":"int64"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ServiceOffering"},"description":"The array of result objects for the current page."}},"additionalProperties":false}},"components/schemas/Stage":{"id":"components/schemas/Stage","kind":"json-schema","title":"Stage","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the Pipeline Stage in Parallax.","format":"uuid"},"pipeline_id":{"type":"string","description":"The unique identifier of the Pipeline that this Stage belongs to.","format":"uuid"},"name":{"type":"string","description":"The name of the Pipeline Stage."},"confidence":{"type":"number","description":"Represents the likelihood that the project will be sold, as a value between 0.0 (no confidence) and 1.0 (full confidence).","format":"double"},"archived":{"type":"boolean","description":"Indicates whether this Pipeline Stage has been archived and is no longer active."},"created_date":{"type":"string","description":"The date and time when the Pipeline Stage record was created in Parallax.","format":"date-time"},"modified_date":{"type":"string","description":"The date and time when the Pipeline Stage record was last modified in Parallax.","format":"date-time"}},"additionalProperties":false}},"components/schemas/StageDtoPagedResultsDto":{"id":"components/schemas/StageDtoPagedResultsDto","kind":"json-schema","title":"StageDtoPagedResultsDto","data":{"required":["results"],"type":"object","properties":{"count":{"type":"integer","description":"The number of results in the current page.","format":"int64"},"total":{"type":"integer","description":"The total number of results that fulfill the request.","format":"int64"},"page":{"type":"integer","description":"The current page of results being returned.","format":"int64"},"total_pages":{"type":"integer","description":"The total number of available pages that fulfill the request.","format":"int64"},"page_size":{"type":"integer","description":"The number of results in each page returned.","format":"int64"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Stage"},"description":"The array of result objects for the current page."}},"additionalProperties":false}},"components/schemas/Tag":{"id":"components/schemas/Tag","kind":"json-schema","title":"Tag","data":{"type":"object","properties":{"tag":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tag."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tag names are structured as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CATEGORY::TAG_NAME"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"::"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" separating the category and tag name. Category names will be returned with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"::"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in their name."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Skills::"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would indicate a category named skills. Further, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Skills::ActionScript"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would indicate a tag named "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ActionScript"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" within the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Skills"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" category."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New category and tag names may not start or end with whitespace, so creating "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Skills:: ActionScript"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is rejected. Whitespace within a name is allowed: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Front End::Dust Bringer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is valid."},"children":[]}]}]}]}},"additionalProperties":false}},"components/schemas/TagList":{"id":"components/schemas/TagList","kind":"json-schema","title":"TagList","data":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of tags."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tag names are structured as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CATEGORY::TAG_NAME"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"::"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" separating the category and tag name. Category names will be returned with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"::"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in their name."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Skills::"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would indicate a category named skills. Further, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Skills::ActionScript"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would indicate a tag named "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ActionScript"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" within the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Skills"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" category."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New category and tag names may not start or end with whitespace, so creating "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Skills:: ActionScript"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is rejected. Whitespace within a name is allowed: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Front End::Dust Bringer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is valid."},"children":[]}]}]}]}},"additionalProperties":false}},"components/schemas/TimeOffAllocation":{"id":"components/schemas/TimeOffAllocation","kind":"json-schema","title":"TimeOffAllocation","data":{"required":["date","hours"],"type":"object","properties":{"date":{"type":"string","description":"The date of the allocation ISO date formatting expected (yyyy-MM-dd).","format":"date"},"hours":{"type":"number","description":"The number of hours allocated on this date. Must be greater than 0 and at most 24.","format":"double"}},"additionalProperties":false}},"components/schemas/TimeOffCategory":{"id":"components/schemas/TimeOffCategory","kind":"json-schema","title":"TimeOffCategory","data":{"enum":["personal_time_off","holiday"],"type":"string"}},"components/schemas/TimesheetEntry":{"id":"components/schemas/TimesheetEntry","kind":"json-schema","title":"TimesheetEntry","data":{"type":"object","properties":{"id":{"type":"string","description":"The id of the time entry.","format":"uuid"},"submission_id":{"type":"string","description":"The id of the submission in which the time entry belongs to.","format":"uuid"},"submission_start_date":{"type":"string","description":"The start date of the submission (period) this time entry belongs to.","format":"date"},"submission_end_date":{"type":"string","description":"The end date of the submission (period) this time entry belongs to.","format":"date"},"approval_status":{"title":"TimesheetSubmissionState","type":"string","allOf":[{"$ref":"#/components/schemas/TimesheetSubmissionState"}],"x-schema-name":"TimesheetSubmissionState"},"approval_status_date":{"type":"string","description":"The date and time at which the timesheet's approval status changed to its current value.","format":"date-time"},"person_id":{"type":"string","description":"The id of the Person in which the actual time entry belongs to.","format":"uuid"},"client_id":{"type":"string","description":"The unique identifier of the client in Parallax.","format":"uuid","nullable":true},"project_id":{"type":"string","description":"The id of the project in which the time entry belongs to.","format":"uuid"},"project_offering_id":{"type":"string","description":"The id of the project offering in which the time entry belongs to.","format":"uuid"},"project_offering_role_id":{"type":"string","description":"The id of the project offering role that the actual time is recorded to.","format":"uuid"},"note":{"type":"string","description":"Notes associated with the time entry.","nullable":true},"date":{"type":"string","description":"The date in which the time entry is recorded to, in the YYYY-MM-DD format.","format":"date"},"hours":{"type":"number","description":"The number of hours associated with the time entry.","format":"double"},"is_billable":{"type":"boolean","description":"Indicates whether the time entry was for billable work."}},"additionalProperties":false}},"components/schemas/TimesheetEntryDtoPagedResultsDto":{"id":"components/schemas/TimesheetEntryDtoPagedResultsDto","kind":"json-schema","title":"TimesheetEntryDtoPagedResultsDto","data":{"required":["results"],"type":"object","properties":{"count":{"type":"integer","description":"The number of results in the current page.","format":"int64"},"total":{"type":"integer","description":"The total number of results that fulfill the request.","format":"int64"},"page":{"type":"integer","description":"The current page of results being returned.","format":"int64"},"total_pages":{"type":"integer","description":"The total number of available pages that fulfill the request.","format":"int64"},"page_size":{"type":"integer","description":"The number of results in each page returned.","format":"int64"},"results":{"type":"array","items":{"$ref":"#/components/schemas/TimesheetEntry"},"description":"The array of result objects for the current page."}},"additionalProperties":false}},"components/schemas/TimesheetSubmissionState":{"id":"components/schemas/TimesheetSubmissionState","kind":"json-schema","title":"TimesheetSubmissionState","data":{"enum":["open","submitted","approved"],"type":"string"}},"components/schemas/UpdateActualTime":{"id":"components/schemas/UpdateActualTime","kind":"json-schema","title":"UpdateActualTime","data":{"type":"object","properties":{"project_offering_id":{"type":"string","description":"The id of the project offering in which the actual time entry belongs to.","format":"uuid","nullable":true},"person_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of the Person to which the actual time entry belongs. If a person is specified who does not currently have a role on the project, a new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProjectOfferingRole"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be created using the person's default organization role. The person will be assigned to it, and the ActualTime entry will be attached."},"children":[]}]}]}],"format":"uuid","nullable":true},"description":{"type":"string","description":"Notes associated with the actual time entry.","nullable":true},"recorded_date":{"type":"string","description":"The date for which the actual time entry is recorded. ISO date formatting expected (yyyy-MM-dd)","format":"date","nullable":true},"hours":{"type":"number","description":"The number of hours associated with the actual time entry.","format":"double","nullable":true},"billable":{"type":"boolean","description":"Indicates whether the actual time entry was for billable work.","nullable":true}},"additionalProperties":false}},"components/schemas/UpdateActualTimeOff":{"id":"components/schemas/UpdateActualTimeOff","kind":"json-schema","title":"UpdateActualTimeOff","data":{"type":"object","properties":{"person_id":{"type":"string","description":"The id of the person to whom the actual time off belongs.","format":"uuid","nullable":true},"recorded_date":{"type":"string","description":"The date on which the time off was recorded, in YYYY-MM-DD format.","format":"date","nullable":true},"hours":{"type":"number","description":"The number of hours of time off recorded.","format":"double","nullable":true},"time_off_category":{"title":"TimeOffCategory","type":"string","allOf":[{"$ref":"#/components/schemas/TimeOffCategory"}],"description":"The category of time off.","nullable":true,"x-schema-name":"TimeOffCategory"},"description":{"type":"string","description":"Optional notes associated with the actual time off entry.","nullable":true}},"additionalProperties":false}},"components/schemas/UpdateClient":{"id":"components/schemas/UpdateClient","kind":"json-schema","title":"UpdateClient","data":{"type":"object","properties":{"name":{"type":"string","description":"The name of the client organization associated with one or more projects.","nullable":true},"archived":{"type":"boolean","description":"Indicates whether the client record has been archived and is no longer active for project assignment.","nullable":true}},"additionalProperties":false}},"components/schemas/UpdateDepartment":{"id":"components/schemas/UpdateDepartment","kind":"json-schema","title":"UpdateDepartment","data":{"type":"object","properties":{"name":{"type":"string","description":"The name of the department used to categorize employees into functional teams for capacity planning.","nullable":true},"archived":{"type":"boolean","description":"Indicates whether the department is archived and no longer active for resource assignment or reporting.","nullable":true}},"additionalProperties":false}},"components/schemas/UpdateOtherCostAndRevenue":{"id":"components/schemas/UpdateOtherCostAndRevenue","kind":"json-schema","title":"UpdateOtherCostAndRevenue","data":{"type":"object","properties":{"type":{"title":"AdjustmentType","type":"string","allOf":[{"$ref":"#/components/schemas/AdjustmentType"}],"description":"The type of entry: \"cost\" or \"revenue\".","nullable":true,"x-schema-name":"AdjustmentType"},"amount":{"title":"Money","type":"object","allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The monetary amount of the entry.","nullable":true,"x-schema-name":"Money"},"date":{"type":"string","description":"The effective date of the entry in ISO format.","format":"date","nullable":true},"name":{"type":"string","description":"An optional descriptive name for the entry.","nullable":true},"should_clear_name":{"type":"boolean","readOnly":true},"project_offering_id":{"type":"string","description":"The unique identifier of the Project Offering this entry is associated with, or null for project-level entries.","format":"uuid","nullable":true},"should_clear_project_offering_id":{"type":"boolean","readOnly":true}},"additionalProperties":false}},"components/schemas/UpdatePerson":{"id":"components/schemas/UpdatePerson","kind":"json-schema","title":"UpdatePerson","data":{"type":"object","properties":{"given_name":{"type":"string","description":"The first name or given name of the Person.","nullable":true},"family_name":{"type":"string","description":"The last name or family name of the Person.","nullable":true},"email_address":{"type":"string","description":"The email address associated with the Person.","nullable":true},"capacity":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The capacity of this Person if they are using a custom capacity instead of their Role's capacity.Note: This value can be cleared out by sending "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request body."},"children":[]}]}]}],"format":"double","nullable":true},"billable_utilization_target":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billable utilization target of this Person if they are using a custom target utilization instead of their Role's target utilization. Note: This value can be cleared out by sending "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request body."},"children":[]}]}]}],"format":"double","nullable":true},"billable":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Denotes whether this Person's time worked is billable. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for new records."},"children":[]}]}]}],"nullable":true},"start_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The earliest date this Person is available for resourcing on a Project. The Person's capacity prior to this date is 0%."},"children":[]}]}]}],"format":"date","nullable":true},"end_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this Person will have or has had their employment or contract terminated, this is the last date they are available for resourcing on a project. They will automatically be archived after this date has passed, and their capacity will drop to 0%. This value can be cleared out by sending "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request body."},"children":[]}]}]}],"format":"date","nullable":true},"worker_type":{"title":"WorkerType","type":"string","allOf":[{"$ref":"#/components/schemas/WorkerType"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Denotes whether this Person is a full time employee, contractor, etc. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"full_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for new records."},"children":[]}]}]}],"nullable":true,"x-schema-name":"WorkerType"},"tags":{"type":"array","items":{"type":"string"},"description":"A list of tags used to categorize the Person for filtering, reporting, or custom grouping.","nullable":true},"image_url":{"type":"string","description":"A publicly-accessible URL to an avatar for this Person.","nullable":true},"archived":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Denotes whether this Person has been archived. This is complimentary to an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that is today or in the past."},"children":[]}]}]}],"nullable":true}},"additionalProperties":false}},"components/schemas/UpdatePipeline":{"id":"components/schemas/UpdatePipeline","kind":"json-schema","title":"UpdatePipeline","data":{"type":"object","properties":{"name":{"type":"string","description":"The name of the Pipeline, typically reflecting the sales funnel or opportunity workflow.","nullable":true},"is_enabled":{"type":"boolean","description":"Indicates whether syncs for this Pipeline are enabled; differs from IsArchived.","nullable":true},"archived":{"type":"boolean","description":"Indicates whether the Pipeline is archived and no longer active in Parallax.","nullable":true}},"additionalProperties":false}},"components/schemas/UpdatePlannedTimeOff":{"id":"components/schemas/UpdatePlannedTimeOff","kind":"json-schema","title":"UpdatePlannedTimeOff","data":{"required":["allocations"],"type":"object","properties":{"allocations":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffAllocation"},"description":"The list of date and hours allocations for this time off."}},"additionalProperties":false}},"components/schemas/UpdateProject":{"id":"components/schemas/UpdateProject","kind":"json-schema","title":"UpdateProject","data":{"type":"object","properties":{"name":{"type":"string","description":"The name of the Project, typically describing the work engagement or scope for the Client.","nullable":true},"status":{"title":"ProjectStatus","type":"string","allOf":[{"$ref":"#/components/schemas/ProjectStatus"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status for the Project. Default is pre_sale."},"children":[]}]}]}],"nullable":true,"x-schema-name":"ProjectStatus"},"start_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheduled start date for the Project’s resource plan."},"children":[]}]}]}],"format":"date","nullable":true},"end_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheduled end date for the Project’s resource plan."},"children":[]}]}]}],"format":"date","nullable":true},"target_margin":{"type":"number","description":"Target margin for the Project. Defaults to Organization's target margin.","format":"double","nullable":true},"target_budget":{"title":"Money","type":"object","allOf":[{"$ref":"#/components/schemas/Money"}],"description":"The target budget for the Project, representing the expected revenue from the Client.","nullable":true,"x-schema-name":"Money"},"archived":{"type":"boolean","description":"Indicates whether the Project is archived and no longer active for delivery or planning.","nullable":true},"client_id":{"type":"string","description":"Id of the Client associated with this Project.","format":"uuid","nullable":true},"stage_id":{"type":"string","description":"Id of the Project's current Pipeline Stage.","format":"uuid","nullable":true},"project_owner_id":{"type":"string","description":"Id of the Person who owns this Project. Sending null clears the value; omitting leaves it unchanged.","format":"uuid","nullable":true},"sales_owner_id":{"type":"string","description":"Id of the Person who is responsible for the sale of this Project. Sending null clears the value; omitting leaves it unchanged.","format":"uuid","nullable":true},"tags":{"type":"array","items":{"type":"string"},"description":"A list of tags assigned to the Project for filtering, categorization, or reporting.","nullable":true},"project_model":{"title":"ProjectModel","type":"string","allOf":[{"$ref":"#/components/schemas/ProjectModel"}],"description":"Project model. Default is client.","nullable":true,"x-schema-name":"ProjectModel"},"is_included":{"type":"boolean","description":"Manual flag to hide Projects from reports while keeping them visible in the UI.","nullable":true}},"additionalProperties":false}},"components/schemas/UpdateProjectOffering":{"id":"components/schemas/UpdateProjectOffering","kind":"json-schema","title":"UpdateProjectOffering","data":{"type":"object","properties":{"name":{"type":"string","description":"The new name for the Project Offering.","nullable":true},"billing_model":{"title":"BillingModel","type":"string","allOf":[{"$ref":"#/components/schemas/BillingModel"}],"description":"The new Billing Model for the Project Offering. This cannot be updated for a project offering that is In Progress","nullable":true,"x-schema-name":"BillingModel"},"billing_model_options":{"type":"object","oneOf":[{"$ref":"#/components/schemas/BillingModelOptionsFixedBid"},{"$ref":"#/components/schemas/BillingModelOptionsRetainer"},{"$ref":"#/components/schemas/BillingModelOptionsTimeMaterials"}],"description":"Additional Billing Model configuration for the Project Offering.","nullable":true},"tags":{"type":"array","items":{"type":"string"},"description":"A list of tags assigned to the Project Offering for filtering, categorization, or reporting.","nullable":true},"service_offering_id":{"type":"string","description":"The ID of a Service Offering to link to the Project Offering, replacing any previously linked Service Offering. Set to null to remove the link. Existing roles and plans are not affected.","format":"uuid","nullable":true},"should_clear_service_offering_id":{"type":"boolean","readOnly":true}},"additionalProperties":false}},"components/schemas/UpdateProjectOfferingRole":{"id":"components/schemas/UpdateProjectOfferingRole","kind":"json-schema","title":"UpdateProjectOfferingRole","data":{"type":"object","properties":{"role_id":{"type":"string","description":"Id of the organization Role that will be performing work on this ProjectOffering.","format":"uuid","nullable":true},"assignment":{"title":"Assignment","type":"object","allOf":[{"$ref":"#/components/schemas/Assignment"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assignment of a Person or Requisition to this role. Set to null to unassign. "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Removing or replacing an assignment where the person has actuals will return a 409 Conflict. The person must first be reassigned to another role or have their actuals removed."},"children":[]}]}]}]}],"nullable":true,"x-schema-name":"Assignment"},"should_clear_assignment":{"type":"boolean","readOnly":true},"tags":{"type":"array","items":{"type":"string"},"description":"List of tags to associate with this Project Offering Role. When provided, this completely replaces existing tags. Provide an empty array to clear all tags. Omit this property to leave tags unchanged.","nullable":true}},"additionalProperties":false}},"components/schemas/UpdateRole":{"id":"components/schemas/UpdateRole","kind":"json-schema","title":"UpdateRole","data":{"type":"object","properties":{"name":{"type":"string","description":"The name of the Role, typically describing the job function or skill set (e.g. Designer, Developer).","nullable":true},"department_id":{"type":"string","description":"The unique identifier of the Department that this Role belongs to for capacity and reporting segmentation.","format":"uuid","nullable":true},"archived":{"type":"boolean","description":"Indicates whether this Role has been archived and is no longer active for planning or reporting.","nullable":true}},"additionalProperties":false}},"components/schemas/UpdateStage":{"id":"components/schemas/UpdateStage","kind":"json-schema","title":"UpdateStage","data":{"type":"object","properties":{"name":{"type":"string","description":"The name of the Pipeline Stage.","nullable":true},"archived":{"type":"boolean","description":"Indicates whether this Pipeline Stage has been archived and is no longer active.","nullable":true},"confidence":{"type":"number","description":"Represents the likelihood that the project will be sold, as a value between 0.0 (no confidence) and 1.0 (full confidence).","format":"double","nullable":true}},"additionalProperties":false}},"components/schemas/UpdateTag":{"id":"components/schemas/UpdateTag","kind":"json-schema","title":"UpdateTag","data":{"required":["current_tag","updated_tag"],"type":"object","properties":{"current_tag":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The existing tag to rename."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tag names are structured as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CATEGORY::TAG_NAME"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"::"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" separating the category and tag name. Category names will be returned with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"::"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in their name."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Skills::"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would indicate a category named skills. Further, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Skills::ActionScript"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would indicate a tag named "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ActionScript"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" within the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Skills"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" category."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New category and tag names may not start or end with whitespace, so creating "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Skills:: ActionScript"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is rejected. Whitespace within a name is allowed: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Front End::Dust Bringer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is valid."},"children":[]}]}]}]},"updated_tag":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The new value for the tag."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tag names are structured as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CATEGORY::TAG_NAME"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"::"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" separating the category and tag name. Category names will be returned with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"::"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in their name."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Skills::"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would indicate a category named skills. Further, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Skills::ActionScript"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would indicate a tag named "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ActionScript"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" within the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Skills"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" category."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New category and tag names may not start or end with whitespace, so creating "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Skills:: ActionScript"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is rejected. Whitespace within a name is allowed: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Front End::Dust Bringer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is valid."},"children":[]}]}]}]}},"additionalProperties":false}},"components/schemas/UpdateWebhookSubscriber":{"id":"components/schemas/UpdateWebhookSubscriber","kind":"json-schema","title":"UpdateWebhookSubscriber","data":{"type":"object","properties":{"callback_url":{"type":"string","nullable":true},"active":{"type":"boolean","nullable":true}},"additionalProperties":false}},"components/schemas/ValidationErrorResponse":{"id":"components/schemas/ValidationErrorResponse","kind":"json-schema","title":"ValidationErrorResponse","data":{"type":"object","properties":{"type":{"type":"string","description":"RFC reference for the error type"},"title":{"type":"string","description":"Human-readable summary of the error"},"status":{"type":"integer","description":"HTTP status code","format":"int32"},"errors":{"type":"array","items":{"type":"string"},"description":"Detailed error messages for each validation failure"},"trace_id":{"type":"string","description":"Trace identifier for debugging"}},"additionalProperties":false,"description":"Represents the structure of validation error responses returned by the API"}},"components/schemas/WebhookSubscriber":{"id":"components/schemas/WebhookSubscriber","kind":"json-schema","title":"WebhookSubscriber","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the webhook configuration in Parallax.","format":"uuid"},"callback_url":{"type":"string","description":"The HTTPS URL endpoint where webhook event notifications will be sent. Must be a valid HTTPS URL."},"secret":{"type":"string","description":"The secret key used to sign webhook payloads for verification. This will be generated when the Webhook Subscriber is created and returned in the response body."},"active":{"type":"boolean","description":"Indicates whether the webhook is active and will receive event notifications."},"created_date":{"type":"string","description":"The date and time when the webhook configuration was initially created in Parallax.","format":"date-time"},"modified_date":{"type":"string","description":"The date and time when the webhook configuration was last modified in Parallax.","format":"date-time"}},"additionalProperties":false}},"components/schemas/WebhookSubscriberSummary":{"id":"components/schemas/WebhookSubscriberSummary","kind":"json-schema","title":"WebhookSubscriberSummary","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the webhook configuration in Parallax.","format":"uuid"},"callback_url":{"type":"string","description":"The HTTPS URL endpoint where webhook event notifications will be sent. Must be a valid HTTPS URL."},"active":{"type":"boolean","description":"Indicates whether the webhook is active and will receive event notifications."},"created_date":{"type":"string","description":"The date and time when the webhook configuration was initially created in Parallax.","format":"date-time"},"modified_date":{"type":"string","description":"The date and time when the webhook configuration was last modified in Parallax.","format":"date-time"}},"additionalProperties":false}},"components/schemas/WebhookSubscriberSummaryDtoPagedResultsDto":{"id":"components/schemas/WebhookSubscriberSummaryDtoPagedResultsDto","kind":"json-schema","title":"WebhookSubscriberSummaryDtoPagedResultsDto","data":{"required":["results"],"type":"object","properties":{"count":{"type":"integer","description":"The number of results in the current page.","format":"int64"},"total":{"type":"integer","description":"The total number of results that fulfill the request.","format":"int64"},"page":{"type":"integer","description":"The current page of results being returned.","format":"int64"},"total_pages":{"type":"integer","description":"The total number of available pages that fulfill the request.","format":"int64"},"page_size":{"type":"integer","description":"The number of results in each page returned.","format":"int64"},"results":{"type":"array","items":{"$ref":"#/components/schemas/WebhookSubscriberSummary"},"description":"The array of result objects for the current page."}},"additionalProperties":false}},"components/schemas/WebhookSubscription":{"id":"components/schemas/WebhookSubscription","kind":"json-schema","title":"WebhookSubscription","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the webhook subscription.","format":"uuid"},"webhook_subscriber_id":{"type":"string","description":"The unique identifier of the parent webhook subscriber configuration.","format":"uuid"},"topic":{"type":"string","description":"The event topic for this subscription (e.g., 'project.created', 'project.updated')."},"created_date":{"type":"string","description":"The date and time when the subscription was created.","format":"date-time"},"modified_date":{"type":"string","description":"The date and time when the subscription was last modified.","format":"date-time"}},"additionalProperties":false}},"components/schemas/WebhookSubscriptionDtoPagedResultsDto":{"id":"components/schemas/WebhookSubscriptionDtoPagedResultsDto","kind":"json-schema","title":"WebhookSubscriptionDtoPagedResultsDto","data":{"required":["results"],"type":"object","properties":{"count":{"type":"integer","description":"The number of results in the current page.","format":"int64"},"total":{"type":"integer","description":"The total number of results that fulfill the request.","format":"int64"},"page":{"type":"integer","description":"The current page of results being returned.","format":"int64"},"total_pages":{"type":"integer","description":"The total number of available pages that fulfill the request.","format":"int64"},"page_size":{"type":"integer","description":"The number of results in each page returned.","format":"int64"},"results":{"type":"array","items":{"$ref":"#/components/schemas/WebhookSubscription"},"description":"The array of result objects for the current page."}},"additionalProperties":false}},"components/schemas/WorkerType":{"id":"components/schemas/WorkerType","kind":"json-schema","title":"WorkerType","data":{"enum":["full_time","contractor"],"type":"string"}},"schema_66":{"kind":"json-schema","data":{"type":"integer","description":"The specific page of results requested.","format":"int32"},"id":"schema_66"},"schema_67":{"kind":"json-schema","data":{"type":"integer","description":"The number of results in each page.","format":"int32"},"id":"schema_67"},"schema_68":{"kind":"json-schema","data":{"type":"string","description":"Filter by entries recorded on or after this date. When not provided, defaults to 7 days ago from today. ISO date formatting expected (yyyy-MM-dd)","format":"date"},"id":"schema_68"},"schema_69":{"kind":"json-schema","data":{"type":"string","description":"Filter by entries recorded on or before this date. When not provided, defaults to today. ISO date formatting expected (yyyy-MM-dd)","format":"date"},"id":"schema_69"},"schema_70":{"kind":"json-schema","data":{"type":"string","description":"The id of the project offering in which the actual time entry belongs to.","format":"uuid"},"id":"schema_70"},"schema_71":{"kind":"json-schema","data":{"type":"string","description":"The id of the Person to which the actual time entry belongs.","format":"uuid"},"id":"schema_71"},"schema_72":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CreateActualTime"}]},"id":"schema_72"},"schema_73":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_73"},"schema_74":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/UpdateActualTime"}]},"id":"schema_74"},"schema_75":{"kind":"json-schema","data":{"type":"string","description":"Filter results to a specific person.","format":"uuid"},"id":"schema_75"},"schema_76":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CreateActualTimeOff"}]},"id":"schema_76"},"schema_77":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/UpdateActualTimeOff"}]},"id":"schema_77"},"schema_78":{"kind":"json-schema","data":{"type":"boolean","description":"Indicates if results should be filtered by their archived status."},"id":"schema_78"},"schema_79":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CreateClient"}]},"id":"schema_79"},"schema_80":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/UpdateClient"}]},"id":"schema_80"},"schema_81":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CreateDepartment"}]},"id":"schema_81"},"schema_82":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/UpdateDepartment"}]},"id":"schema_82"},"schema_83":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by external ID. For Parallax-managed integrations, use the format 'px_provider:id' (e.g., 'px_hubspot:12345'). For custom integrations, use the string format appropriate for that integration."},"children":[]}]}]}]},"id":"schema_83"},"schema_84":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CreatePerson"}]},"id":"schema_84"},"schema_85":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/UpdatePerson"}]},"id":"schema_85"},"schema_86":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/AddPersonExternalId"}]},"id":"schema_86"},"schema_87":{"kind":"json-schema","data":{"type":"string"},"id":"schema_87"},"schema_88":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CreatePipeline"}]},"id":"schema_88"},"schema_89":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/UpdatePipeline"}]},"id":"schema_89"},"schema_90":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by entries recorded for the Person associated with this person_id."},"children":[]}]}]}],"format":"uuid"},"id":"schema_90"},"schema_91":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CreatePlannedTimeOff"}]},"id":"schema_91"},"schema_92":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/UpdatePlannedTimeOff"}]},"id":"schema_92"},"schema_93":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CreateProjectOfferingRole"}]},"id":"schema_93"},"schema_94":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/UpdateProjectOfferingRole"}]},"id":"schema_94"},"schema_95":{"kind":"json-schema","data":{"type":"string","description":"Filter by entries recorded on or after this date. ISO date formatting expected (yyyy-MM-dd)","format":"date"},"id":"schema_95"},"schema_96":{"kind":"json-schema","data":{"type":"string","description":"Filter by entries recorded on or before this date. ISO date formatting expected (yyyy-MM-dd)","format":"date"},"id":"schema_96"},"schema_97":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ProjectOfferingRolePlannedTime"}},"id":"schema_97"},"schema_98":{"kind":"json-schema","data":{"type":"string","description":"The ID of the Project, to which this Project Offering belongs.","format":"uuid"},"id":"schema_98"},"schema_99":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by external ID. For Parallax-managed integrations, use the format 'px_provider:id' (e.g., 'px_harvest:12345'). For custom integrations, use the string format appropriate for that integration."},"children":[]}]}]}]},"id":"schema_99"},"schema_100":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CreateProjectOffering"}]},"id":"schema_100"},"schema_101":{"kind":"json-schema","data":{"type":"string","description":"ID of the Project Offering.","format":"uuid"},"id":"schema_101"},"schema_102":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/UpdateProjectOffering"}]},"id":"schema_102"},"schema_103":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/AddOfferingExternalId"}]},"id":"schema_103"},"schema_104":{"kind":"json-schema","data":{"type":"string","description":"The unique identifier for the Project.","format":"uuid"},"id":"schema_104"},"schema_105":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/AdjustmentType"}],"description":"Filter entries by type: \"cost\" or \"revenue\"."},"id":"schema_105"},"schema_106":{"kind":"json-schema","data":{"type":"string","description":"Filter entries by Project Offering ID.","format":"uuid"},"id":"schema_106"},"schema_107":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CreateOtherCostAndRevenue"}]},"id":"schema_107"},"schema_108":{"kind":"json-schema","data":{"type":"string","description":"The unique identifier for the cost or revenue entry.","format":"uuid"},"id":"schema_108"},"schema_109":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/UpdateOtherCostAndRevenue"}]},"id":"schema_109"},"schema_110":{"kind":"json-schema","data":{"type":"string","description":"Filter by the Id of the Person who owns the sale of the Project.","format":"uuid"},"id":"schema_110"},"schema_111":{"kind":"json-schema","data":{"type":"string","description":"Filter by the Id of the Person who owns the Project.","format":"uuid"},"id":"schema_111"},"schema_112":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CreateProject"}]},"id":"schema_112"},"schema_113":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/UpdateProject"}]},"id":"schema_113"},"schema_114":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/AddExternalId"}]},"id":"schema_114"},"schema_115":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CreateRole"}]},"id":"schema_115"},"schema_116":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/UpdateRole"}]},"id":"schema_116"},"schema_117":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CreateStage"}]},"id":"schema_117"},"schema_118":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/UpdateStage"}]},"id":"schema_118"},"schema_119":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CreateTag"}]},"id":"schema_119"},"schema_120":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/UpdateTag"}]},"id":"schema_120"},"schema_121":{"kind":"json-schema","data":{"type":"string","description":"Filter by entries recorded on or after this date. When not provided, defaults to 7 days ago from today. Currently, this endpoint requires the queried date range to not exceed 31 days. You must specify an end date filter when specifying this value. ISO date formatting expected (yyyy-MM-dd)","format":"date"},"id":"schema_121"},"schema_122":{"kind":"json-schema","data":{"type":"string","description":"Filter by entries recorded on or before this date. When not provided, defaults to today. You must specify an start date filter when specifying this value. ISO date formatting expected (yyyy-MM-dd)","format":"date"},"id":"schema_122"},"schema_123":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/TimesheetSubmissionState"}]},"id":"schema_123"},"schema_124":{"kind":"json-schema","data":{"type":"string","description":"Optional filter for entries with an approval status change on or after this date. Currently, this endpoint requires the queried date range to not exceed 31 days. You must specify an approval status end date filter when specifying this value. ISO date formatting expected (yyyy-MM-dd)","format":"date"},"id":"schema_124"},"schema_125":{"kind":"json-schema","data":{"type":"string","description":"Optional filter for entries with an approval status change on or before this date. You must specify an approval status start date filter when specifying this value. ISO date formatting expected (yyyy-MM-dd)","format":"date"},"id":"schema_125"},"schema_126":{"kind":"json-schema","data":{"type":"string","description":"The id of the project in which the time entry belongs to.","format":"uuid"},"id":"schema_126"},"schema_127":{"kind":"json-schema","data":{"type":"string","description":"The id of the project offering in which the time entry belongs to.","format":"uuid"},"id":"schema_127"},"schema_128":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CreateWebhookSubscriber"}]},"id":"schema_128"},"schema_129":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/UpdateWebhookSubscriber"}]},"id":"schema_129"},"schema_130":{"kind":"json-schema","data":{"type":"string","description":"The unique identifier of the webhook configuration in Parallax.","format":"uuid"},"id":"schema_130"},"schema_131":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CreateSubscription"}]},"id":"schema_131"}},"exampleStore":{},"securitySchemeStore":{"ApiKey":{"id":"ApiKey","type":"apiKey","description":"Personal Access Token (PAT) for authentication within the X-API-KEY header.","in":"header","paramName":"X-API-KEY"}},"servers":[{"url":"/_mock/api-documentation/swagger","isMockServer":true,"description":"Mock server"},{"url":"https://api.getparallax.com","description":"Production Server"}]},"options":{"schemaDefinitionsTagName":"Schemas","schemasExpansionLevel":0,"hideSidebar":true,"mockServer":{"url":"/_mock/api-documentation/swagger","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/API Documentation/swagger.json?download"},{"url":"/_bundle/API Documentation/swagger.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Parallax Api","description":"## Overview\n\nAccess to the Parallax API is available exclusively to Parallax API customers. To learn more about becoming a Parallax API customer, please reach out to your Customer Success Manager.\n\nAll Parallax API calls are made under `https://api.getparallax.com` and all responses return standard JSON. The following HTTP methods are supported:\n\n- GET\n- POST\n- PATCH\n- DELETE\n"}},"baseSlug":"/api-documentation/swagger","routesMapping":{}}