Organization-scoped API key. Create one in the BuildingSwell app under Organization settings, API keys.
Query Parameters
page
integer
default:1
Page to return, starting at 1. Pages are 1-based, so page=0 is rejected with a 400.
Required range: x >= 1
pageSize
integer
default:100
Records per page. Defaults to 100 when no pagination parameter is sent. /timesheet applies no default at all, so send this explicitly.
orderBy
string
Sort fields, e.g. name:asc,createdAt:desc. Comma-separated and repeated parameters are equivalent.
select
string[]
Fields to return. Comma-separated or repeated parameters are equivalent; an explicit selection includes only requested fields. Nested JSON paths are supported.
search
string
Full-text search across the resource's search columns. Append :col1,col2 to limit which columns are searched.
filter
string
AND/OR filter expression, for example type eq 'phase' and isArchived eq false. Simple equality can also be passed as plain field parameters.
Response
Successful response.
values
object[]
Show child attributes
hasMore
boolean
⌘I
List custom properties
curl --request GET \ --url https://{instance}/api/v2/custom-property \ --header 'X-API-Key: <api-key>'
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"BuildingSwell API","description":"Integrate with the BuildingSwell v2 Public API","colors":{"primary":"#469CD0","light":"#E3E4EB","dark":"#2B6F94"},"logo":{"light":"https://mintcdn.com/buildingswell/Qr29DdMV6RgYz0r1/images/logo/light.svg?fit=max\u0026auto=format\u0026n=Qr29DdMV6RgYz0r1\u0026q=85\u0026s=4ac56cb72dbd077d8fe51caa9d2a36c0","dark":"https://mintcdn.com/buildingswell/Qr29DdMV6RgYz0r1/images/logo/dark.svg?fit=max\u0026auto=format\u0026n=Qr29DdMV6RgYz0r1\u0026q=85\u0026s=e12c7020bde066982825fe3512de26bf","href":"https://www.buildingswell.com"},"favicon":"https://mintcdn.com/buildingswell/Qr29DdMV6RgYz0r1/images/logo/light.svg?fit=max\u0026auto=format\u0026n=Qr29DdMV6RgYz0r1\u0026q=85\u0026s=4ac56cb72dbd077d8fe51caa9d2a36c0","api":{"openapi":"openapi.yaml","playground":{"display":"interactive","proxy":true},"examples":{"defaults":"all","languages":["bash","javascript","python"],"autogenerate":true},"mdx":{"auth":{"method":"key","name":"X-API-Key"},"server":"https://{instance}/api/v2"}},"navbar":{"links":[{"href":"https://app.buildingswell.com","label":"App"},{"href":"https://help.buildingswell.com/","label":"Support"}]},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"buildingswell","hasAudioNarration":false,"actualSubdomain":"buildingswell","customDomains":["api.buildingswell.com"],"gitSource":{"type":"github","owner":"buildingswell","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6aac4f20e57c1c210951de0d","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"API reference","count":434},{"language":"default","tag":"Guides","count":43},{"language":"default","tag":"Codes","count":39},{"language":"default","tag":"Deliverables","count":23},{"language":"default","tag":"Deliveries","count":22},{"language":"default","tag":"Documents","count":20},{"language":"default","tag":"QC","count":20},{"language":"default","tag":"BOM lines","count":17},{"language":"default","tag":"Production outputs","count":17},{"language":"default","tag":"Users","count":16}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/custom-properties/list-custom-properties","slug":"/api-reference/custom-properties/list-custom-properties","pageMetadata":{"title":"List custom properties","description":"Requires customPropertiesEnabled. Disabled organizations receive 403. ","deprecated":null,"version":null,"openapi":"/openapi.yaml get /custom-property","href":"/api-reference/custom-properties/list-custom-properties","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Requires customPropertiesEnabled. Disabled organizations receive 403.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"List custom properties","description":"Requires customPropertiesEnabled. Disabled organizations receive 403. ","deprecated":null,"version":null,"openapi":"/openapi.yaml get /custom-property","href":"/api-reference/custom-properties/list-custom-properties","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Custom properties"],"summary":"List custom properties","responses":{"200":"db317e5c-3268-4144-84b3-824aade50f65","400":"9661968b-cb53-4607-9815-fd2d5c85d06d","401":"db49c71c-1ec0-4c20-85c1-def673337106","403":"3121f417-2d5d-4820-9520-924761c59617","429":"41de6e88-cc59-4177-9b5f-ce024c879bcc"},"parameters":["1c6990fe-73c3-4ee8-9c77-14073f7a394c","14f8312f-2f71-497b-bdf4-8b9aafda572f","4ebaf047-8c30-45e9-8a31-9246a25f7f47","fd6c6996-f6a4-4fca-8424-d619d1ebe6be","08575dc6-1173-48ba-8382-7c5f86751025","2d005376-9181-4ad5-9511-91ed4f67e9b0"],"description":"Requires customPropertiesEnabled. Disabled organizations receive 403. ","method":"get","type":"path","servers":["d2424206-51df-4087-82cf-155ef617e047"],"security":["73ed015f-134d-4902-9f0b-de20a0edabcb"],"path":"/custom-property","baseUrlOptions":["https://{instance}/api/v2"],"title":"List custom properties","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"1c6990fe-73c3-4ee8-9c77-14073f7a394c":{"name":"page","in":"query","description":"Page to return, starting at 1. Pages are 1-based, so `page=0` is rejected with a `400`.","schema":{"type":"integer","minimum":1,"default":1,"description":"Page to return, starting at 1. Pages are 1-based, so `page=0` is rejected with a `400`.","uniqueKey":"","typeLabel":"integer"}},"14f8312f-2f71-497b-bdf4-8b9aafda572f":{"name":"pageSize","in":"query","description":"Records per page. Defaults to 100 when no pagination parameter is sent. `/timesheet` applies no default at all, so send this explicitly.","schema":{"type":"integer","default":100,"description":"Records per page. Defaults to 100 when no pagination parameter is sent. `/timesheet` applies no default at all, so send this explicitly.","uniqueKey":"","typeLabel":"integer"}},"4ebaf047-8c30-45e9-8a31-9246a25f7f47":{"name":"orderBy","in":"query","description":"Sort fields, e.g. name:asc,createdAt:desc. Comma-separated and repeated parameters are equivalent.","schema":{"type":"string","description":"Sort fields, e.g. name:asc,createdAt:desc. Comma-separated and repeated parameters are equivalent.","uniqueKey":"","typeLabel":"string"},"example":"name:asc"},"fd6c6996-f6a4-4fca-8424-d619d1ebe6be":{"name":"select","in":"query","description":"Fields to return. Comma-separated or repeated parameters are equivalent; an explicit selection includes only requested fields. Nested JSON paths are supported.","schema":{"type":"array","items":{"type":"string","uniqueKey":"items.[INDEX]","typeLabel":"string"},"description":"Fields to return. Comma-separated or repeated parameters are equivalent; an explicit selection includes only requested fields. Nested JSON paths are supported.","uniqueKey":"","typeLabel":"string[]"},"style":"form","explode":true,"example":["id","name"]},"08575dc6-1173-48ba-8382-7c5f86751025":{"name":"search","in":"query","description":"Full-text search across the resource's search columns. Append `:col1,col2` to limit which columns are searched.","schema":{"type":"string","description":"Full-text search across the resource's search columns. Append `:col1,col2` to limit which columns are searched.","uniqueKey":"","typeLabel":"string"},"example":"warehouse"},"2d005376-9181-4ad5-9511-91ed4f67e9b0":{"name":"filter","in":"query","description":"AND/OR filter expression, for example `type eq 'phase' and isArchived eq false`. Simple equality can also be passed as plain field parameters.","schema":{"type":"string","description":"AND/OR filter expression, for example `type eq 'phase' and isArchived eq false`. Simple equality can also be passed as plain field parameters.","uniqueKey":"","typeLabel":"string"},"example":"isArchived eq false"}},"responses":{"db317e5c-3268-4144-84b3-824aade50f65":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique record ID.","uniqueKey":"values.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"organizationId":{"type":"string","format":"uuid","readOnly":true,"description":"Organization from your API key.","uniqueKey":"values.items.[INDEX].organizationId","typeLabel":"string\u003cuuid>"},"createdAt":{"type":"string","format":"date-time","readOnly":true,"uniqueKey":"values.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","readOnly":true,"uniqueKey":"values.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"},"isArchived":{"type":"boolean","uniqueKey":"values.items.[INDEX].isArchived","typeLabel":"boolean"},"archivedAt":{"oneOf":[{"type":"string","format":"date-time","readOnly":true,"uniqueKey":"values.items.[INDEX].archivedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","readOnly":true,"uniqueKey":"values.items.[INDEX].archivedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"values.items.[INDEX].archivedAt","typeLabel":"string\u003cdate-time> | null"},"identifier":{"type":"string","uniqueKey":"values.items.[INDEX].identifier","typeLabel":"string"},"key":{"type":"string","pattern":"^[A-Za-z][A-Za-z0-9]*$","minLength":1,"maxLength":64,"description":"Immutable storage key, unique case-insensitively even across archived definitions.","uniqueKey":"values.items.[INDEX].key","typeLabel":"string"},"name":{"type":"string","minLength":1,"uniqueKey":"values.items.[INDEX].name","typeLabel":"string"},"dataType":{"type":"string","enum":["number","text","boolean","single_select","multi_select"],"uniqueKey":"values.items.[INDEX].dataType","typeLabel":"enum\u003cstring>"},"unitMeasureId":{"oneOf":[{"type":"string","format":"uuid","description":"Only number properties can have a unit.","uniqueKey":"values.items.[INDEX].unitMeasureId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Only number properties can have a unit.","uniqueKey":"values.items.[INDEX].unitMeasureId.oneOf.1","typeLabel":"null"}],"uniqueKey":"values.items.[INDEX].unitMeasureId","typeLabel":"string\u003cuuid> | null"},"deliverableTypes":{"type":"array","items":{"type":"string","enum":["order"],"uniqueKey":"values.items.[INDEX].deliverableTypes.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Currently only [\"order\"] is supported; cannot be empty.","uniqueKey":"values.items.[INDEX].deliverableTypes","typeLabel":"enum\u003cstring>[]"},"options":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"values.items.[INDEX].options.items.[INDEX]","typeLabel":"string"},"description":"Select types only. Trimmed strings, unique case-insensitively; array position is display order.","uniqueKey":"values.items.[INDEX].options","typeLabel":"string[]"},"allowsAdHocOptions":{"type":"boolean","description":"Select types only. Append unknown options on value writes when true.","uniqueKey":"values.items.[INDEX].allowsAdHocOptions","typeLabel":"boolean"}},"uniqueKey":"values.items.[INDEX]","typeLabel":"object"},"uniqueKey":"values","typeLabel":"object[]"},"hasMore":{"type":"boolean","uniqueKey":"hasMore","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"values":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","organizationId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","isArchived":true,"archivedAt":"2023-11-07T05:31:56Z","identifier":"\u003cstring>","key":"\u003cstring>","name":"\u003cstring>","dataType":"number","unitMeasureId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","deliverableTypes":["order"],"options":["\u003cstring>"],"allowsAdHocOptions":true}],"hasMore":true}}},"exampleType":"generated"}},"exampleType":"generated"},"9661968b-cb53-4607-9815-fd2d5c85d06d":{"description":"The request was malformed or failed validation. Check `error.details` for the fields at fault.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"message":{"type":"string","description":"What went wrong, in plain language.","uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","VALIDATION","UNIQUE_VIOLATION","FK_VIOLATION","RATE_LIMITED","INTERNAL"],"description":"Stable machine-readable code. Branch on this rather than on the message text.","uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"requestId":{"type":"string","description":"Id for this request. Quote it when you contact support.","uniqueKey":"error.requestId","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","description":"One field-level problem.","properties":{"path":{"type":"string","description":"Field that failed, for example `data.stageId`.","uniqueKey":"error.details.items.[INDEX].path","typeLabel":"string"},"message":{"type":"string","description":"Why it failed.","uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"},"code":{"type":"string","description":"Validation code.","uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"description":"Per-field problems. Present on validation failures only.","uniqueKey":"error.details","typeLabel":"object[]"},"missingPermissions":{"type":"array","items":{"type":"string","description":"Permission name.","uniqueKey":"error.missingPermissions.items.[INDEX]","typeLabel":"string"},"description":"Permissions your key is missing. Present on `403` only.","uniqueKey":"error.missingPermissions","typeLabel":"string[]"}},"uniqueKey":"error","typeLabel":"object"},"context":{"type":"object","description":"Extra context for the error. Usually empty.","additionalProperties":true,"uniqueKey":"context","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"message":"\u003cstring>","code":"BAD_REQUEST","requestId":"\u003cstring>","details":[{"path":"\u003cstring>","message":"\u003cstring>","code":"\u003cstring>"}],"missingPermissions":["\u003cstring>"]},"context":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"db49c71c-1ec0-4c20-85c1-def673337106":{"description":"The `X-API-Key` header is missing or the key is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"message":{"type":"string","description":"What went wrong, in plain language.","uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","VALIDATION","UNIQUE_VIOLATION","FK_VIOLATION","RATE_LIMITED","INTERNAL"],"description":"Stable machine-readable code. Branch on this rather than on the message text.","uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"requestId":{"type":"string","description":"Id for this request. Quote it when you contact support.","uniqueKey":"error.requestId","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","description":"One field-level problem.","properties":{"path":{"type":"string","description":"Field that failed, for example `data.stageId`.","uniqueKey":"error.details.items.[INDEX].path","typeLabel":"string"},"message":{"type":"string","description":"Why it failed.","uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"},"code":{"type":"string","description":"Validation code.","uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"description":"Per-field problems. Present on validation failures only.","uniqueKey":"error.details","typeLabel":"object[]"},"missingPermissions":{"type":"array","items":{"type":"string","description":"Permission name.","uniqueKey":"error.missingPermissions.items.[INDEX]","typeLabel":"string"},"description":"Permissions your key is missing. Present on `403` only.","uniqueKey":"error.missingPermissions","typeLabel":"string[]"}},"uniqueKey":"error","typeLabel":"object"},"context":{"type":"object","description":"Extra context for the error. Usually empty.","additionalProperties":true,"uniqueKey":"context","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"message":"\u003cstring>","code":"BAD_REQUEST","requestId":"\u003cstring>","details":[{"path":"\u003cstring>","message":"\u003cstring>","code":"\u003cstring>"}],"missingPermissions":["\u003cstring>"]},"context":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"3121f417-2d5d-4820-9520-924761c59617":{"description":"Your key lacks the permission for this call. `error.missingPermissions` lists what is needed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"message":{"type":"string","description":"What went wrong, in plain language.","uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","VALIDATION","UNIQUE_VIOLATION","FK_VIOLATION","RATE_LIMITED","INTERNAL"],"description":"Stable machine-readable code. Branch on this rather than on the message text.","uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"requestId":{"type":"string","description":"Id for this request. Quote it when you contact support.","uniqueKey":"error.requestId","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","description":"One field-level problem.","properties":{"path":{"type":"string","description":"Field that failed, for example `data.stageId`.","uniqueKey":"error.details.items.[INDEX].path","typeLabel":"string"},"message":{"type":"string","description":"Why it failed.","uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"},"code":{"type":"string","description":"Validation code.","uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"description":"Per-field problems. Present on validation failures only.","uniqueKey":"error.details","typeLabel":"object[]"},"missingPermissions":{"type":"array","items":{"type":"string","description":"Permission name.","uniqueKey":"error.missingPermissions.items.[INDEX]","typeLabel":"string"},"description":"Permissions your key is missing. Present on `403` only.","uniqueKey":"error.missingPermissions","typeLabel":"string[]"}},"uniqueKey":"error","typeLabel":"object"},"context":{"type":"object","description":"Extra context for the error. Usually empty.","additionalProperties":true,"uniqueKey":"context","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"message":"\u003cstring>","code":"BAD_REQUEST","requestId":"\u003cstring>","details":[{"path":"\u003cstring>","message":"\u003cstring>","code":"\u003cstring>"}],"missingPermissions":["\u003cstring>"]},"context":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"41de6e88-cc59-4177-9b5f-ce024c879bcc":{"description":"Too many requests. Read `RateLimit-Reset` for when to retry. This response also carries a top-level `message` alongside `error`.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"message":{"type":"string","description":"What went wrong, in plain language.","uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","VALIDATION","UNIQUE_VIOLATION","FK_VIOLATION","RATE_LIMITED","INTERNAL"],"description":"Stable machine-readable code. Branch on this rather than on the message text.","uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"requestId":{"type":"string","description":"Id for this request. Quote it when you contact support.","uniqueKey":"error.requestId","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","description":"One field-level problem.","properties":{"path":{"type":"string","description":"Field that failed, for example `data.stageId`.","uniqueKey":"error.details.items.[INDEX].path","typeLabel":"string"},"message":{"type":"string","description":"Why it failed.","uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"},"code":{"type":"string","description":"Validation code.","uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"description":"Per-field problems. Present on validation failures only.","uniqueKey":"error.details","typeLabel":"object[]"},"missingPermissions":{"type":"array","items":{"type":"string","description":"Permission name.","uniqueKey":"error.missingPermissions.items.[INDEX]","typeLabel":"string"},"description":"Permissions your key is missing. Present on `403` only.","uniqueKey":"error.missingPermissions","typeLabel":"string[]"}},"uniqueKey":"error","typeLabel":"object"},"context":{"type":"object","description":"Extra context for the error. Usually empty.","additionalProperties":true,"uniqueKey":"context","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"message":"\u003cstring>","code":"BAD_REQUEST","requestId":"\u003cstring>","details":[{"path":"\u003cstring>","message":"\u003cstring>","code":"\u003cstring>"}],"missingPermissions":["\u003cstring>"]},"context":{}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"73ed015f-134d-4902-9f0b-de20a0edabcb":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Organization-scoped API key. Create one in the BuildingSwell app under Organization settings, API keys.","scopes":[]}}},"servers":{"d2424206-51df-4087-82cf-155ef617e047":{"url":"https://{instance}/api/v2","description":"Your BuildingSwell instance","variables":{"instance":{"default":"app.buildingswell.com","description":"Your BuildingSwell host"}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Organization-scoped API key. Create one in the BuildingSwell app under Organization settings, API keys.","scopes":[]},"schema":{"title":"X-API-Key","type":"string","description":"Organization-scoped API key. Create one in the BuildingSwell app under Organization settings, API keys.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"X-API-Key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"buildingswell","siteName":"BuildingSwell API","title":"List custom properties - BuildingSwell API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-17T20:36:02.029Z","originalFileLocation":"api-reference/custom-properties/list-custom-properties.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Requires customPropertiesEnabled. Disabled organizations receive 403.\">\u003cmeta data-mint-head name=\"application-name\" content=\"BuildingSwell API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/svg+xml\" sizes=\"180x180\" href=\"https://mintcdn.com/buildingswell/Qr29DdMV6RgYz0r1/images/logo/light.svg?fit=max\u0026amp;auto=format\u0026amp;n=Qr29DdMV6RgYz0r1\u0026amp;q=85\u0026amp;s=4ac56cb72dbd077d8fe51caa9d2a36c0\">\u003clink data-mint-head rel=\"icon\" type=\"image/svg+xml\" sizes=\"32x32\" href=\"https://mintcdn.com/buildingswell/Qr29DdMV6RgYz0r1/images/logo/light.svg?fit=max\u0026amp;auto=format\u0026amp;n=Qr29DdMV6RgYz0r1\u0026amp;q=85\u0026amp;s=4ac56cb72dbd077d8fe51caa9d2a36c0\">\u003clink data-mint-head rel=\"icon\" type=\"image/svg+xml\" sizes=\"16x16\" href=\"https://mintcdn.com/buildingswell/Qr29DdMV6RgYz0r1/images/logo/light.svg?fit=max\u0026amp;auto=format\u0026amp;n=Qr29DdMV6RgYz0r1\u0026amp;q=85\u0026amp;s=4ac56cb72dbd077d8fe51caa9d2a36c0\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/svg+xml\" href=\"https://mintcdn.com/buildingswell/Qr29DdMV6RgYz0r1/images/logo/light.svg?fit=max\u0026amp;auto=format\u0026amp;n=Qr29DdMV6RgYz0r1\u0026amp;q=85\u0026amp;s=4ac56cb72dbd077d8fe51caa9d2a36c0\">\u003cmeta data-mint-head property=\"og:title\" content=\"List custom properties - BuildingSwell API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Requires customPropertiesEnabled. Disabled organizations receive 403.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"BuildingSwell API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://api.buildingswell.com/api-reference/custom-properties/list-custom-properties\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://buildingswell.mintlify.site/_mintlify/api/og/v2?division=Custom+properties\u0026amp;title=List+custom+properties\u0026amp;description=Requires+customPropertiesEnabled.+Disabled+organizations+receive+403.+\u0026amp;theme=d9adcf615e5bcb5d910ff93d\u0026amp;signature=70d001784ef7b13bef003606deff39a11d0139e84c354bb60f7b4c1bdb86349d\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"List custom properties - BuildingSwell API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Requires customPropertiesEnabled. Disabled organizations receive 403.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://buildingswell.mintlify.site/_mintlify/api/og/v2?division=Custom+properties\u0026amp;title=List+custom+properties\u0026amp;description=Requires+customPropertiesEnabled.+Disabled+organizations+receive+403.+\u0026amp;theme=d9adcf615e5bcb5d910ff93d\u0026amp;signature=70d001784ef7b13bef003606deff39a11d0139e84c354bb60f7b4c1bdb86349d\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"https://mintlify.s3.us-west-1.amazonaws.com/buildingswell/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"BuildingSwell API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#469CD0\">\u003clink data-mint-head rel=\"canonical\" href=\"https://api.buildingswell.com/api-reference/custom-properties/list-custom-properties\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/custom-properties/list-custom-properties.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://api.buildingswell.com/#organization\",\"name\":\"BuildingSwell API\",\"url\":\"https://api.buildingswell.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/buildingswell/Qr29DdMV6RgYz0r1/images/logo/light.svg?fit=max\u0026auto=format\u0026n=Qr29DdMV6RgYz0r1\u0026q=85\u0026s=4ac56cb72dbd077d8fe51caa9d2a36c0\"}},{\"@type\":\"WebSite\",\"@id\":\"https://api.buildingswell.com#website\",\"name\":\"BuildingSwell API\",\"url\":\"https://api.buildingswell.com\",\"publisher\":{\"@id\":\"https://api.buildingswell.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://api.buildingswell.com/api-reference/custom-properties/list-custom-properties#webpage\",\"url\":\"https://api.buildingswell.com/api-reference/custom-properties/list-custom-properties\",\"name\":\"List custom properties\",\"description\":\"Requires customPropertiesEnabled. Disabled organizations receive 403.\",\"dateModified\":\"2026-09-17T20:36:02.029Z\",\"isPartOf\":{\"@id\":\"https://api.buildingswell.com#website\"},\"breadcrumb\":{\"@id\":\"https://api.buildingswell.com/api-reference/custom-properties/list-custom-properties#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://api.buildingswell.com/api-reference/custom-properties/list-custom-properties#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"BuildingSwell API\",\"item\":\"https://api.buildingswell.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List custom properties\",\"item\":\"https://api.buildingswell.com/api-reference/custom-properties/list-custom-properties\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://api.buildingswell.com/api-reference/custom-properties/list-custom-properties#apireference\",\"headline\":\"List custom properties\",\"name\":\"List custom properties\",\"description\":\"Requires customPropertiesEnabled. Disabled organizations receive 403.\",\"url\":\"https://api.buildingswell.com/api-reference/custom-properties/list-custom-properties\",\"mainEntityOfPage\":{\"@id\":\"https://api.buildingswell.com/api-reference/custom-properties/list-custom-properties#webpage\"},\"dateModified\":\"2026-09-17T20:36:02.029Z\",\"publisher\":{\"@id\":\"https://api.buildingswell.com/#organization\"},\"isPartOf\":{\"@id\":\"https://api.buildingswell.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"BuildingSwell API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"BuildingSwell API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/custom-properties/list-custom-properties.md","siteName":"BuildingSwell API","nav":{"global":null,"tabs":[{"tab":"Guides","icon":"book-open","pages":[{"title":"Guides","href":""}]},{"tab":"API reference","icon":"square-terminal","groups":[{"group":"Overview","pages":[{"title":"API reference overview","href":"/api-reference/overview"}]},{"group":"Projects","pages":[{"title":"List projects","deprecated":null,"version":null,"openapi":"/openapi.yaml get /project","href":"/api-reference/projects/list-projects"},{"title":"Create a project","deprecated":null,"version":null,"openapi":"/openapi.yaml post /project","href":"/api-reference/projects/create-a-project"},{"title":"Get a project","deprecated":null,"version":null,"openapi":"/openapi.yaml get /project/{id}","href":"/api-reference/projects/get-a-project"},{"title":"Update a project","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /project/{id}","href":"/api-reference/projects/update-a-project"},{"title":"Upsert a project","deprecated":null,"version":null,"openapi":"/openapi.yaml put /project/{id}","href":"/api-reference/projects/upsert-a-project"},{"title":"Delete a project","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /project/{id}","href":"/api-reference/projects/delete-a-project"},{"title":"Count projects","deprecated":null,"version":null,"openapi":"/openapi.yaml get /project/count","href":"/api-reference/projects/count-projects"},{"title":"Count projects (POST)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /project/count","href":"/api-reference/projects/count-projects-post"},{"title":"Query projects","deprecated":null,"version":null,"openapi":"/openapi.yaml post /project/query","href":"/api-reference/projects/query-projects"},{"title":"Group and count projects","deprecated":null,"version":null,"openapi":"/openapi.yaml post /project/group-and-count","href":"/api-reference/projects/group-and-count-projects"},{"title":"Update many projects","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /project/bulk","href":"/api-reference/projects/update-many-projects"},{"title":"Upsert many projects","deprecated":null,"version":null,"openapi":"/openapi.yaml put /project/bulk","href":"/api-reference/projects/upsert-many-projects"},{"title":"Delete many projects (not available)","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /project/bulk","href":"/api-reference/projects/delete-many-projects-not-available"}]},{"group":"Stages","pages":[{"title":"List stages","deprecated":null,"version":null,"openapi":"/openapi.yaml get /stage","href":"/api-reference/stages/list-stages"},{"title":"Create a stage","deprecated":null,"version":null,"openapi":"/openapi.yaml post /stage","href":"/api-reference/stages/create-a-stage"},{"title":"Get a stage","deprecated":null,"version":null,"openapi":"/openapi.yaml get /stage/{id}","href":"/api-reference/stages/get-a-stage"},{"title":"Update a stage","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /stage/{id}","href":"/api-reference/stages/update-a-stage"},{"title":"Upsert a stage","deprecated":null,"version":null,"openapi":"/openapi.yaml put /stage/{id}","href":"/api-reference/stages/upsert-a-stage"},{"title":"Delete a stage","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /stage/{id}","href":"/api-reference/stages/delete-a-stage"},{"title":"Count stages","deprecated":null,"version":null,"openapi":"/openapi.yaml get /stage/count","href":"/api-reference/stages/count-stages"},{"title":"Count stages (POST)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /stage/count","href":"/api-reference/stages/count-stages-post"},{"title":"Query stages","deprecated":null,"version":null,"openapi":"/openapi.yaml post /stage/query","href":"/api-reference/stages/query-stages"},{"title":"Group and count stages","deprecated":null,"version":null,"openapi":"/openapi.yaml post /stage/group-and-count","href":"/api-reference/stages/group-and-count-stages"},{"title":"Update many stages","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /stage/bulk","href":"/api-reference/stages/update-many-stages"},{"title":"Upsert many stages","deprecated":null,"version":null,"openapi":"/openapi.yaml put /stage/bulk","href":"/api-reference/stages/upsert-many-stages"},{"title":"Delete many stages (not available)","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /stage/bulk","href":"/api-reference/stages/delete-many-stages-not-available"}]},{"group":"Deliverables","pages":[{"title":"List deliverables","deprecated":null,"version":null,"openapi":"/openapi.yaml get /deliverable","href":"/api-reference/deliverables/list-deliverables"},{"title":"Create a deliverable","deprecated":null,"version":null,"openapi":"/openapi.yaml post /deliverable","href":"/api-reference/deliverables/create-a-deliverable"},{"title":"Get a deliverable","deprecated":null,"version":null,"openapi":"/openapi.yaml get /deliverable/{id}","href":"/api-reference/deliverables/get-a-deliverable"},{"title":"Update a deliverable","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /deliverable/{id}","href":"/api-reference/deliverables/update-a-deliverable"},{"title":"Upsert a deliverable","deprecated":null,"version":null,"openapi":"/openapi.yaml put /deliverable/{id}","href":"/api-reference/deliverables/upsert-a-deliverable"},{"title":"Delete a deliverable","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /deliverable/{id}","href":"/api-reference/deliverables/delete-a-deliverable"},{"title":"Count deliverables","deprecated":null,"version":null,"openapi":"/openapi.yaml get /deliverable/count","href":"/api-reference/deliverables/count-deliverables"},{"title":"Count deliverables (POST)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /deliverable/count","href":"/api-reference/deliverables/count-deliverables-post"},{"title":"Query deliverables","deprecated":null,"version":null,"openapi":"/openapi.yaml post /deliverable/query","href":"/api-reference/deliverables/query-deliverables"},{"title":"Group and count deliverables","deprecated":null,"version":null,"openapi":"/openapi.yaml post /deliverable/group-and-count","href":"/api-reference/deliverables/group-and-count-deliverables"},{"title":"Update many deliverables","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /deliverable/bulk","href":"/api-reference/deliverables/update-many-deliverables"},{"title":"Upsert many deliverables","deprecated":null,"version":null,"openapi":"/openapi.yaml put /deliverable/bulk","href":"/api-reference/deliverables/upsert-many-deliverables"},{"title":"Delete many deliverables (not available)","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /deliverable/bulk","href":"/api-reference/deliverables/delete-many-deliverables-not-available"},{"title":"Archive deliverables","deprecated":null,"version":null,"openapi":"/openapi.yaml post /deliverable/archive/batch","href":"/api-reference/deliverables/archive-deliverables"},{"title":"Get crew time for deliverables (deprecated)","deprecated":true,"version":null,"openapi":"/openapi.yaml get /deliverable/crew-time","href":"/api-reference/deliverables/get-crew-time-for-deliverables-deprecated"},{"title":"Get crew time for deliverables","deprecated":null,"version":null,"openapi":"/openapi.yaml post /deliverable/crew-time","href":"/api-reference/deliverables/get-crew-time-for-deliverables"},{"title":"Group deliverables by a dimension","deprecated":null,"version":null,"openapi":"/openapi.yaml post /deliverable/groups","href":"/api-reference/deliverables/group-deliverables-by-a-dimension"},{"title":"Reorder deliverables under a root","deprecated":null,"version":null,"openapi":"/openapi.yaml post /deliverable/reorder","href":"/api-reference/deliverables/reorder-deliverables-under-a-root"},{"title":"Restore deliverables","deprecated":null,"version":null,"openapi":"/openapi.yaml post /deliverable/restore/batch","href":"/api-reference/deliverables/restore-deliverables"},{"title":"Update deliverable progress","deprecated":null,"version":null,"openapi":"/openapi.yaml post /deliverable/root/{rootId}/progress/{id}","href":"/api-reference/deliverables/update-deliverable-progress"},{"title":"Schedule a deliverable","deprecated":null,"version":null,"openapi":"/openapi.yaml post /deliverable/root/{rootId}/schedule/{id}","href":"/api-reference/deliverables/schedule-a-deliverable"},{"title":"Schedule deliverables in a batch","deprecated":null,"version":null,"openapi":"/openapi.yaml post /deliverable/schedule/batch","href":"/api-reference/deliverables/schedule-deliverables-in-a-batch"},{"title":"Get a deliverable subtree","deprecated":null,"version":null,"openapi":"/openapi.yaml get /deliverable/{id}/hierarchy","href":"/api-reference/deliverables/get-a-deliverable-subtree"}]},{"group":"Work sessions","pages":[{"title":"List work sessions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /deliverable/work-sessions","href":"/api-reference/work-sessions/list-work-sessions"},{"title":"Create a work session","deprecated":null,"version":null,"openapi":"/openapi.yaml post /deliverable/work-sessions","href":"/api-reference/work-sessions/create-a-work-session"},{"title":"Get a work session","deprecated":null,"version":null,"openapi":"/openapi.yaml get /deliverable/work-sessions/{id}","href":"/api-reference/work-sessions/get-a-work-session"},{"title":"Update a work session","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /deliverable/work-sessions/{id}","href":"/api-reference/work-sessions/update-a-work-session"},{"title":"Upsert a work session","deprecated":null,"version":null,"openapi":"/openapi.yaml put /deliverable/work-sessions/{id}","href":"/api-reference/work-sessions/upsert-a-work-session"},{"title":"Delete a work session","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /deliverable/work-sessions/{id}","href":"/api-reference/work-sessions/delete-a-work-session"},{"title":"Count work sessions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /deliverable/work-sessions/count","href":"/api-reference/work-sessions/count-work-sessions"},{"title":"Count work sessions (POST)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /deliverable/work-sessions/count","href":"/api-reference/work-sessions/count-work-sessions-post"},{"title":"Query work sessions","deprecated":null,"version":null,"openapi":"/openapi.yaml post /deliverable/work-sessions/query","href":"/api-reference/work-sessions/query-work-sessions"},{"title":"Group and count work sessions","deprecated":null,"version":null,"openapi":"/openapi.yaml post /deliverable/work-sessions/group-and-count","href":"/api-reference/work-sessions/group-and-count-work-sessions"},{"title":"Update many work sessions","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /deliverable/work-sessions/bulk","href":"/api-reference/work-sessions/update-many-work-sessions"},{"title":"Upsert many work sessions","deprecated":null,"version":null,"openapi":"/openapi.yaml put /deliverable/work-sessions/bulk","href":"/api-reference/work-sessions/upsert-many-work-sessions"},{"title":"Delete many work sessions (not available)","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /deliverable/work-sessions/bulk","href":"/api-reference/work-sessions/delete-many-work-sessions-not-available"},{"title":"Find problem work sessions","deprecated":null,"version":null,"openapi":"/openapi.yaml post /deliverable/work-sessions/error-ids","href":"/api-reference/work-sessions/find-problem-work-sessions"},{"title":"Save work-session assignments","deprecated":null,"version":null,"openapi":"/openapi.yaml post /deliverable/work-sessions/save","href":"/api-reference/work-sessions/save-work-session-assignments"},{"title":"Stop work sessions","deprecated":null,"version":null,"openapi":"/openapi.yaml post /deliverable/work-sessions/stop","href":"/api-reference/work-sessions/stop-work-sessions"}]},{"group":"Dependencies","pages":[{"title":"List dependencies","deprecated":null,"version":null,"openapi":"/openapi.yaml get /deliverable/dependencies","href":"/api-reference/dependencies/list-dependencies"},{"title":"Create a dependency","deprecated":null,"version":null,"openapi":"/openapi.yaml post /deliverable/dependencies","href":"/api-reference/dependencies/create-a-dependency"},{"title":"Get a dependency","deprecated":null,"version":null,"openapi":"/openapi.yaml get /deliverable/dependencies/{id}","href":"/api-reference/dependencies/get-a-dependency"},{"title":"Update a dependency","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /deliverable/dependencies/{id}","href":"/api-reference/dependencies/update-a-dependency"},{"title":"Upsert a dependency","deprecated":null,"version":null,"openapi":"/openapi.yaml put /deliverable/dependencies/{id}","href":"/api-reference/dependencies/upsert-a-dependency"},{"title":"Delete a dependency","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /deliverable/dependencies/{id}","href":"/api-reference/dependencies/delete-a-dependency"},{"title":"Count dependencies","deprecated":null,"version":null,"openapi":"/openapi.yaml get /deliverable/dependencies/count","href":"/api-reference/dependencies/count-dependencies"},{"title":"Count dependencies (POST)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /deliverable/dependencies/count","href":"/api-reference/dependencies/count-dependencies-post"},{"title":"Query dependencies","deprecated":null,"version":null,"openapi":"/openapi.yaml post /deliverable/dependencies/query","href":"/api-reference/dependencies/query-dependencies"},{"title":"Group and count dependencies","deprecated":null,"version":null,"openapi":"/openapi.yaml post /deliverable/dependencies/group-and-count","href":"/api-reference/dependencies/group-and-count-dependencies"},{"title":"Update many dependencies","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /deliverable/dependencies/bulk","href":"/api-reference/dependencies/update-many-dependencies"},{"title":"Upsert many dependencies","deprecated":null,"version":null,"openapi":"/openapi.yaml put /deliverable/dependencies/bulk","href":"/api-reference/dependencies/upsert-many-dependencies"},{"title":"Delete many dependencies (not available)","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /deliverable/dependencies/bulk","href":"/api-reference/dependencies/delete-many-dependencies-not-available"},{"title":"Get dependencies in a subtree","deprecated":null,"version":null,"openapi":"/openapi.yaml get /deliverable/dependencies/{id}/hierarchy","href":"/api-reference/dependencies/get-dependencies-in-a-subtree"}]},{"group":"Documents","pages":[{"title":"List documents","deprecated":null,"version":null,"openapi":"/openapi.yaml get /document","href":"/api-reference/documents/list-documents"},{"title":"Get a document","deprecated":null,"version":null,"openapi":"/openapi.yaml get /document/{id}","href":"/api-reference/documents/get-a-document"},{"title":"Archive or restore a document","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /document/{id}","href":"/api-reference/documents/archive-or-restore-a-document"},{"title":"Delete a document","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /document/{id}","href":"/api-reference/documents/delete-a-document"},{"title":"Count documents","deprecated":null,"version":null,"openapi":"/openapi.yaml get /document/count","href":"/api-reference/documents/count-documents"},{"title":"Count documents (POST)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /document/count","href":"/api-reference/documents/count-documents-post"},{"title":"Query documents","deprecated":null,"version":null,"openapi":"/openapi.yaml post /document/query","href":"/api-reference/documents/query-documents"},{"title":"Group and count documents","deprecated":null,"version":null,"openapi":"/openapi.yaml post /document/group-and-count","href":"/api-reference/documents/group-and-count-documents"},{"title":"Archive or restore matching documents","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /document/bulk","href":"/api-reference/documents/archive-or-restore-matching-documents"},{"title":"Delete many documents (not available)","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /document/bulk","href":"/api-reference/documents/delete-many-documents-not-available"},{"title":"List Documents Hub records","deprecated":null,"version":null,"openapi":"/openapi.yaml get /document/hub","href":"/api-reference/documents/list-documents-hub-records"},{"title":"Register uploaded files","deprecated":null,"version":null,"openapi":"/openapi.yaml post /document/hub/bulk-upload","href":"/api-reference/documents/register-uploaded-files"},{"title":"Read document versions and links","deprecated":null,"version":null,"openapi":"/openapi.yaml get /document/{id}/hub-detail","href":"/api-reference/documents/read-document-versions-and-links"},{"title":"Create a document version","deprecated":null,"version":null,"openapi":"/openapi.yaml post /document/{id}/versions","href":"/api-reference/documents/create-a-document-version"},{"title":"Archive document version","deprecated":null,"version":null,"openapi":"/openapi.yaml post /document/{id}/versions/{versionId}/archive","href":"/api-reference/documents/archive-document-version"},{"title":"Set current document version","deprecated":null,"version":null,"openapi":"/openapi.yaml post /document/{id}/versions/{versionId}/set-current","href":"/api-reference/documents/set-current-document-version"},{"title":"Attach a document to a deliverable","deprecated":null,"version":null,"openapi":"/openapi.yaml post /document/{id}/links","href":"/api-reference/documents/attach-a-document-to-a-deliverable"},{"title":"Remove a document link","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /document/links/{linkId}","href":"/api-reference/documents/remove-a-document-link"},{"title":"Set document copy mode","deprecated":null,"version":null,"openapi":"/openapi.yaml post /document/{id}/copy-mode","href":"/api-reference/documents/set-document-copy-mode"},{"title":"Count documents on deliverables","description":"Available with or without Documents Hub. Counts only accessible deliverables.","deprecated":null,"version":null,"openapi":"/openapi.yaml post /document/counts-by-deliverable","href":"/api-reference/documents/count-documents-on-deliverables"}]},{"group":"Custom properties","pages":[{"title":"List custom properties","deprecated":null,"version":null,"openapi":"/openapi.yaml get /custom-property","href":"/api-reference/custom-properties/list-custom-properties"},{"title":"Create one or more custom properties","description":"Requires customPropertiesEnabled. Disabled organizations receive 403. Organization property definitions and values on orders. See the resource guide for ownership and lifecycle constraints.","deprecated":null,"version":null,"openapi":"/openapi.yaml post /custom-property","href":"/api-reference/custom-properties/create-one-or-more-custom-properties"},{"title":"Get a custom property","deprecated":null,"version":null,"openapi":"/openapi.yaml get /custom-property/{id}","href":"/api-reference/custom-properties/get-a-custom-property"},{"title":"Update a custom property","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /custom-property/{id}","href":"/api-reference/custom-properties/update-a-custom-property"},{"title":"Upsert a custom property","deprecated":null,"version":null,"openapi":"/openapi.yaml put /custom-property/{id}","href":"/api-reference/custom-properties/upsert-a-custom-property"},{"title":"Delete a custom property","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /custom-property/{id}","href":"/api-reference/custom-properties/delete-a-custom-property"},{"title":"Query custom properties","deprecated":null,"version":null,"openapi":"/openapi.yaml post /custom-property/query","href":"/api-reference/custom-properties/query-custom-properties"},{"title":"Count custom properties","deprecated":null,"version":null,"openapi":"/openapi.yaml get /custom-property/count","href":"/api-reference/custom-properties/count-custom-properties"},{"title":"Count custom properties with a request body","deprecated":null,"version":null,"openapi":"/openapi.yaml post /custom-property/count","href":"/api-reference/custom-properties/count-custom-properties-with-a-request-body"},{"title":"Group and count custom properties","deprecated":null,"version":null,"openapi":"/openapi.yaml post /custom-property/group-and-count","href":"/api-reference/custom-properties/group-and-count-custom-properties"},{"title":"Update matching custom properties","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /custom-property/bulk","href":"/api-reference/custom-properties/update-matching-custom-properties"},{"title":"Upsert multiple custom properties","deprecated":null,"version":null,"openapi":"/openapi.yaml put /custom-property/bulk","href":"/api-reference/custom-properties/upsert-multiple-custom-properties"}]},{"group":"QC","pages":[{"title":"List QC inspection sets","deprecated":null,"version":null,"openapi":"/openapi.yaml get /qc-inspection-set","href":"/api-reference/qc/list-qc-inspection-sets"},{"title":"Create a QC inspection set","deprecated":null,"version":null,"openapi":"/openapi.yaml post /qc-inspection-set","href":"/api-reference/qc/create-a-qc-inspection-set"},{"title":"Get a QC inspection set","deprecated":null,"version":null,"openapi":"/openapi.yaml get /qc-inspection-set/{id}","href":"/api-reference/qc/get-a-qc-inspection-set"},{"title":"Update a QC inspection set","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /qc-inspection-set/{id}","href":"/api-reference/qc/update-a-qc-inspection-set"},{"title":"Upsert a QC inspection set","deprecated":null,"version":null,"openapi":"/openapi.yaml put /qc-inspection-set/{id}","href":"/api-reference/qc/upsert-a-qc-inspection-set"},{"title":"Delete a QC inspection set","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /qc-inspection-set/{id}","href":"/api-reference/qc/delete-a-qc-inspection-set"},{"title":"Count QC inspection sets","deprecated":null,"version":null,"openapi":"/openapi.yaml get /qc-inspection-set/count","href":"/api-reference/qc/count-qc-inspection-sets"},{"title":"Count QC inspection sets (POST)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /qc-inspection-set/count","href":"/api-reference/qc/count-qc-inspection-sets-post"},{"title":"Query QC inspection sets","deprecated":null,"version":null,"openapi":"/openapi.yaml post /qc-inspection-set/query","href":"/api-reference/qc/query-qc-inspection-sets"},{"title":"Group and count QC inspection sets","deprecated":null,"version":null,"openapi":"/openapi.yaml post /qc-inspection-set/group-and-count","href":"/api-reference/qc/group-and-count-qc-inspection-sets"},{"title":"Update many QC inspection sets","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /qc-inspection-set/bulk","href":"/api-reference/qc/update-many-qc-inspection-sets"},{"title":"Upsert many QC inspection sets","deprecated":null,"version":null,"openapi":"/openapi.yaml put /qc-inspection-set/bulk","href":"/api-reference/qc/upsert-many-qc-inspection-sets"},{"title":"Delete many QC inspection sets (not available)","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /qc-inspection-set/bulk","href":"/api-reference/qc/delete-many-qc-inspection-sets-not-available"},{"title":"List QC template versions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /qc-template","href":"/api-reference/qc/list-qc-template-versions"},{"title":"Get a QC template version","deprecated":null,"version":null,"openapi":"/openapi.yaml get /qc-template/{id}","href":"/api-reference/qc/get-a-qc-template-version"},{"title":"Delete a QC template version","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /qc-template/{id}","href":"/api-reference/qc/delete-a-qc-template-version"},{"title":"Count QC template versions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /qc-template/count","href":"/api-reference/qc/count-qc-template-versions"},{"title":"Count QC template versions (POST)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /qc-template/count","href":"/api-reference/qc/count-qc-template-versions-post"},{"title":"Query QC template versions","deprecated":null,"version":null,"openapi":"/openapi.yaml post /qc-template/query","href":"/api-reference/qc/query-qc-template-versions"},{"title":"Group and count QC template versions","deprecated":null,"version":null,"openapi":"/openapi.yaml post /qc-template/group-and-count","href":"/api-reference/qc/group-and-count-qc-template-versions"}]},{"group":"People (Workers)","pages":[{"title":"List people","deprecated":null,"version":null,"openapi":"/openapi.yaml get /worker","href":"/api-reference/people-workers/list-people"},{"title":"Create a person","deprecated":null,"version":null,"openapi":"/openapi.yaml post /worker","href":"/api-reference/people-workers/create-a-person"},{"title":"Get a person","deprecated":null,"version":null,"openapi":"/openapi.yaml get /worker/{id}","href":"/api-reference/people-workers/get-a-person"},{"title":"Update a person","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /worker/{id}","href":"/api-reference/people-workers/update-a-person"},{"title":"Upsert a person","deprecated":null,"version":null,"openapi":"/openapi.yaml put /worker/{id}","href":"/api-reference/people-workers/upsert-a-person"},{"title":"Delete a person (not available)","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /worker/{id}","href":"/api-reference/people-workers/delete-a-person-not-available"},{"title":"Count people","deprecated":null,"version":null,"openapi":"/openapi.yaml get /worker/count","href":"/api-reference/people-workers/count-people"},{"title":"Count people (POST)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /worker/count","href":"/api-reference/people-workers/count-people-post"},{"title":"Query people","deprecated":null,"version":null,"openapi":"/openapi.yaml post /worker/query","href":"/api-reference/people-workers/query-people"},{"title":"Group and count people","deprecated":null,"version":null,"openapi":"/openapi.yaml post /worker/group-and-count","href":"/api-reference/people-workers/group-and-count-people"},{"title":"Update many people","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /worker/bulk","href":"/api-reference/people-workers/update-many-people"},{"title":"Upsert many people","deprecated":null,"version":null,"openapi":"/openapi.yaml put /worker/bulk","href":"/api-reference/people-workers/upsert-many-people"},{"title":"Delete many people (not available)","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /worker/bulk","href":"/api-reference/people-workers/delete-many-people-not-available"}]},{"group":"Timesheets","pages":[{"title":"List timesheet records","deprecated":null,"version":null,"openapi":"/openapi.yaml get /timesheet","href":"/api-reference/timesheets/list-timesheet-records"},{"title":"Get a timesheet record","deprecated":null,"version":null,"openapi":"/openapi.yaml get /timesheet/{id}","href":"/api-reference/timesheets/get-a-timesheet-record"},{"title":"Count timesheet records","deprecated":null,"version":null,"openapi":"/openapi.yaml get /timesheet/count","href":"/api-reference/timesheets/count-timesheet-records"},{"title":"Count timesheet records (POST)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /timesheet/count","href":"/api-reference/timesheets/count-timesheet-records-post"},{"title":"Query timesheet records","deprecated":null,"version":null,"openapi":"/openapi.yaml post /timesheet/query","href":"/api-reference/timesheets/query-timesheet-records"},{"title":"Group and count timesheet records","deprecated":null,"version":null,"openapi":"/openapi.yaml post /timesheet/group-and-count","href":"/api-reference/timesheets/group-and-count-timesheet-records"}]},{"group":"Codes","pages":[{"title":"List cost codes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /cost-code","href":"/api-reference/codes/list-cost-codes"},{"title":"Create a cost code","deprecated":null,"version":null,"openapi":"/openapi.yaml post /cost-code","href":"/api-reference/codes/create-a-cost-code"},{"title":"Get a cost code","deprecated":null,"version":null,"openapi":"/openapi.yaml get /cost-code/{id}","href":"/api-reference/codes/get-a-cost-code"},{"title":"Update a cost code","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /cost-code/{id}","href":"/api-reference/codes/update-a-cost-code"},{"title":"Upsert a cost code","deprecated":null,"version":null,"openapi":"/openapi.yaml put /cost-code/{id}","href":"/api-reference/codes/upsert-a-cost-code"},{"title":"Delete a cost code","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /cost-code/{id}","href":"/api-reference/codes/delete-a-cost-code"},{"title":"Count cost codes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /cost-code/count","href":"/api-reference/codes/count-cost-codes"},{"title":"Count cost codes (POST)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /cost-code/count","href":"/api-reference/codes/count-cost-codes-post"},{"title":"Query cost codes","deprecated":null,"version":null,"openapi":"/openapi.yaml post /cost-code/query","href":"/api-reference/codes/query-cost-codes"},{"title":"Group and count cost codes","deprecated":null,"version":null,"openapi":"/openapi.yaml post /cost-code/group-and-count","href":"/api-reference/codes/group-and-count-cost-codes"},{"title":"Update many cost codes","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /cost-code/bulk","href":"/api-reference/codes/update-many-cost-codes"},{"title":"Upsert many cost codes","deprecated":null,"version":null,"openapi":"/openapi.yaml put /cost-code/bulk","href":"/api-reference/codes/upsert-many-cost-codes"},{"title":"Delete many cost codes (not available)","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /cost-code/bulk","href":"/api-reference/codes/delete-many-cost-codes-not-available"},{"title":"List union codes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /union-code","href":"/api-reference/codes/list-union-codes"},{"title":"Create a union code","deprecated":null,"version":null,"openapi":"/openapi.yaml post /union-code","href":"/api-reference/codes/create-a-union-code"},{"title":"Get a union code","deprecated":null,"version":null,"openapi":"/openapi.yaml get /union-code/{id}","href":"/api-reference/codes/get-a-union-code"},{"title":"Update a union code","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /union-code/{id}","href":"/api-reference/codes/update-a-union-code"},{"title":"Upsert a union code","deprecated":null,"version":null,"openapi":"/openapi.yaml put /union-code/{id}","href":"/api-reference/codes/upsert-a-union-code"},{"title":"Delete a union code","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /union-code/{id}","href":"/api-reference/codes/delete-a-union-code"},{"title":"Count union codes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /union-code/count","href":"/api-reference/codes/count-union-codes"},{"title":"Count union codes (POST)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /union-code/count","href":"/api-reference/codes/count-union-codes-post"},{"title":"Query union codes","deprecated":null,"version":null,"openapi":"/openapi.yaml post /union-code/query","href":"/api-reference/codes/query-union-codes"},{"title":"Group and count union codes","deprecated":null,"version":null,"openapi":"/openapi.yaml post /union-code/group-and-count","href":"/api-reference/codes/group-and-count-union-codes"},{"title":"Update many union codes","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /union-code/bulk","href":"/api-reference/codes/update-many-union-codes"},{"title":"Upsert many union codes","deprecated":null,"version":null,"openapi":"/openapi.yaml put /union-code/bulk","href":"/api-reference/codes/upsert-many-union-codes"},{"title":"Delete many union codes (not available)","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /union-code/bulk","href":"/api-reference/codes/delete-many-union-codes-not-available"},{"title":"List per diem codes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /per-diem-code","href":"/api-reference/codes/list-per-diem-codes"},{"title":"Create a per diem code","deprecated":null,"version":null,"openapi":"/openapi.yaml post /per-diem-code","href":"/api-reference/codes/create-a-per-diem-code"},{"title":"Get a per diem code","deprecated":null,"version":null,"openapi":"/openapi.yaml get /per-diem-code/{id}","href":"/api-reference/codes/get-a-per-diem-code"},{"title":"Update a per diem code","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /per-diem-code/{id}","href":"/api-reference/codes/update-a-per-diem-code"},{"title":"Upsert a per diem code","deprecated":null,"version":null,"openapi":"/openapi.yaml put /per-diem-code/{id}","href":"/api-reference/codes/upsert-a-per-diem-code"},{"title":"Delete a per diem code","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /per-diem-code/{id}","href":"/api-reference/codes/delete-a-per-diem-code"},{"title":"Count per diem codes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /per-diem-code/count","href":"/api-reference/codes/count-per-diem-codes"},{"title":"Count per diem codes (POST)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /per-diem-code/count","href":"/api-reference/codes/count-per-diem-codes-post"},{"title":"Query per diem codes","deprecated":null,"version":null,"openapi":"/openapi.yaml post /per-diem-code/query","href":"/api-reference/codes/query-per-diem-codes"},{"title":"Group and count per diem codes","deprecated":null,"version":null,"openapi":"/openapi.yaml post /per-diem-code/group-and-count","href":"/api-reference/codes/group-and-count-per-diem-codes"},{"title":"Update many per diem codes","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /per-diem-code/bulk","href":"/api-reference/codes/update-many-per-diem-codes"},{"title":"Upsert many per diem codes","deprecated":null,"version":null,"openapi":"/openapi.yaml put /per-diem-code/bulk","href":"/api-reference/codes/upsert-many-per-diem-codes"},{"title":"Delete many per diem codes (not available)","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /per-diem-code/bulk","href":"/api-reference/codes/delete-many-per-diem-codes-not-available"}]},{"group":"Roles","pages":[{"title":"List roles","deprecated":null,"version":null,"openapi":"/openapi.yaml get /role","href":"/api-reference/roles/list-roles"},{"title":"Create a role","deprecated":null,"version":null,"openapi":"/openapi.yaml post /role","href":"/api-reference/roles/create-a-role"},{"title":"Get a role","deprecated":null,"version":null,"openapi":"/openapi.yaml get /role/{id}","href":"/api-reference/roles/get-a-role"},{"title":"Update a role","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /role/{id}","href":"/api-reference/roles/update-a-role"},{"title":"Upsert a role","deprecated":null,"version":null,"openapi":"/openapi.yaml put /role/{id}","href":"/api-reference/roles/upsert-a-role"},{"title":"Delete a role","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /role/{id}","href":"/api-reference/roles/delete-a-role"},{"title":"Count roles","deprecated":null,"version":null,"openapi":"/openapi.yaml get /role/count","href":"/api-reference/roles/count-roles"},{"title":"Count roles (POST)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /role/count","href":"/api-reference/roles/count-roles-post"},{"title":"Query roles","deprecated":null,"version":null,"openapi":"/openapi.yaml post /role/query","href":"/api-reference/roles/query-roles"},{"title":"Group and count roles","deprecated":null,"version":null,"openapi":"/openapi.yaml post /role/group-and-count","href":"/api-reference/roles/group-and-count-roles"},{"title":"Update many roles","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /role/bulk","href":"/api-reference/roles/update-many-roles"},{"title":"Upsert many roles","deprecated":null,"version":null,"openapi":"/openapi.yaml put /role/bulk","href":"/api-reference/roles/upsert-many-roles"},{"title":"Delete many roles (not available)","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /role/bulk","href":"/api-reference/roles/delete-many-roles-not-available"},{"title":"Duplicate a role","deprecated":null,"version":null,"openapi":"/openapi.yaml post /role/{id}/duplicate","href":"/api-reference/roles/duplicate-a-role"}]},{"group":"Users","pages":[{"title":"List users","deprecated":null,"version":null,"openapi":"/openapi.yaml get /organization-member","href":"/api-reference/users/list-users"},{"title":"Invite a user","deprecated":null,"version":null,"openapi":"/openapi.yaml post /organization-member","href":"/api-reference/users/invite-a-user"},{"title":"Get an user","deprecated":null,"version":null,"openapi":"/openapi.yaml get /organization-member/{id}","href":"/api-reference/users/get-an-user"},{"title":"Update an user","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /organization-member/{id}","href":"/api-reference/users/update-an-user"},{"title":"Upsert an user","deprecated":null,"version":null,"openapi":"/openapi.yaml put /organization-member/{id}","href":"/api-reference/users/upsert-an-user"},{"title":"Delete an user","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /organization-member/{id}","href":"/api-reference/users/delete-an-user"},{"title":"Count users","deprecated":null,"version":null,"openapi":"/openapi.yaml get /organization-member/count","href":"/api-reference/users/count-users"},{"title":"Count users (POST)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /organization-member/count","href":"/api-reference/users/count-users-post"},{"title":"Query users","deprecated":null,"version":null,"openapi":"/openapi.yaml post /organization-member/query","href":"/api-reference/users/query-users"},{"title":"Group and count users","deprecated":null,"version":null,"openapi":"/openapi.yaml post /organization-member/group-and-count","href":"/api-reference/users/group-and-count-users"},{"title":"Update many users","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /organization-member/bulk","href":"/api-reference/users/update-many-users"},{"title":"Upsert many users","deprecated":null,"version":null,"openapi":"/openapi.yaml put /organization-member/bulk","href":"/api-reference/users/upsert-many-users"},{"title":"Delete many users (not available)","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /organization-member/bulk","href":"/api-reference/users/delete-many-users-not-available"},{"title":"Deactivate a user","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /organization-member/{id}/deactivate","href":"/api-reference/users/deactivate-a-user"},{"title":"Resend a user invitation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /organization-member/{id}/invite/resend","href":"/api-reference/users/resend-a-user-invitation"},{"title":"Reactivate a user","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /organization-member/{id}/reactivate","href":"/api-reference/users/reactivate-a-user"}]},{"group":"Domain concepts","pages":[{"title":"Get the concept registry","deprecated":null,"version":null,"openapi":"/openapi.yaml get /concepts","href":"/api-reference/concepts/get-the-concept-registry"},{"title":"Create a deliverable with validation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /concepts/deliverables","href":"/api-reference/concepts/create-a-deliverable-with-validation"},{"title":"Update a deliverable with validation","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /concepts/deliverables/{id}","href":"/api-reference/concepts/update-a-deliverable-with-validation"},{"title":"Apply a route to a node","deprecated":null,"version":null,"openapi":"/openapi.yaml post /concepts/deliverables/{id}/apply-route","href":"/api-reference/concepts/apply-a-route-to-a-node"},{"title":"Create an order from a route","deprecated":null,"version":null,"openapi":"/openapi.yaml post /concepts/orders/from-route","href":"/api-reference/concepts/create-an-order-from-a-route"},{"title":"Get an order's context","deprecated":null,"version":null,"openapi":"/openapi.yaml get /concepts/orders/{id}/context","href":"/api-reference/concepts/get-an-orders-context"},{"title":"Apply a progress action","deprecated":null,"version":null,"openapi":"/openapi.yaml post /concepts/root/{rootId}/progress/{id}/apply","href":"/api-reference/concepts/apply-a-progress-action"},{"title":"Preview a progress action","deprecated":null,"version":null,"openapi":"/openapi.yaml post /concepts/root/{rootId}/progress/{id}/plan","href":"/api-reference/concepts/preview-a-progress-action"},{"title":"Get a route summary","deprecated":null,"version":null,"openapi":"/openapi.yaml get /concepts/routes/{id}","href":"/api-reference/concepts/get-a-route-summary"},{"title":"List stations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /concepts/stage-masters","href":"/api-reference/concepts/list-stations"}]},{"group":"Items","pages":[{"title":"List items","deprecated":null,"version":null,"openapi":"/openapi.yaml get /item","href":"/api-reference/items/list-items"},{"title":"Create one or more items","deprecated":null,"version":null,"openapi":"/openapi.yaml post /item","href":"/api-reference/items/create-one-or-more-items"},{"title":"Get an item","deprecated":null,"version":null,"openapi":"/openapi.yaml get /item/{id}","href":"/api-reference/items/get-an-item"},{"title":"Update an item","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /item/{id}","href":"/api-reference/items/update-an-item"},{"title":"Upsert an item","deprecated":null,"version":null,"openapi":"/openapi.yaml put /item/{id}","href":"/api-reference/items/upsert-an-item"},{"title":"Delete an item","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /item/{id}","href":"/api-reference/items/delete-an-item"},{"title":"Query items","deprecated":null,"version":null,"openapi":"/openapi.yaml post /item/query","href":"/api-reference/items/query-items"},{"title":"Count items","deprecated":null,"version":null,"openapi":"/openapi.yaml get /item/count","href":"/api-reference/items/count-items"},{"title":"Count items with a request body","deprecated":null,"version":null,"openapi":"/openapi.yaml post /item/count","href":"/api-reference/items/count-items-with-a-request-body"},{"title":"Group and count items","deprecated":null,"version":null,"openapi":"/openapi.yaml post /item/group-and-count","href":"/api-reference/items/group-and-count-items"},{"title":"Update matching items","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /item/bulk","href":"/api-reference/items/update-matching-items"},{"title":"Upsert multiple items","deprecated":null,"version":null,"openapi":"/openapi.yaml put /item/bulk","href":"/api-reference/items/upsert-multiple-items"},{"title":"Read availability in a department","deprecated":null,"version":null,"openapi":"/openapi.yaml get /item/shop-availability","href":"/api-reference/items/read-availability-in-a-department"}]},{"group":"Item vendors","pages":[{"title":"List item-vendor links","deprecated":null,"version":null,"openapi":"/openapi.yaml get /item-vendor","href":"/api-reference/item-vendors/list-item-vendor-links"},{"title":"Create one or more item-vendor links","deprecated":null,"version":null,"openapi":"/openapi.yaml post /item-vendor","href":"/api-reference/item-vendors/create-one-or-more-item-vendor-links"},{"title":"Get an item-vendor link","deprecated":null,"version":null,"openapi":"/openapi.yaml get /item-vendor/{id}","href":"/api-reference/item-vendors/get-an-item-vendor-link"},{"title":"Update an item-vendor link","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /item-vendor/{id}","href":"/api-reference/item-vendors/update-an-item-vendor-link"},{"title":"Upsert an item-vendor link","deprecated":null,"version":null,"openapi":"/openapi.yaml put /item-vendor/{id}","href":"/api-reference/item-vendors/upsert-an-item-vendor-link"},{"title":"Permanently delete an item-vendor link","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /item-vendor/{id}","href":"/api-reference/item-vendors/permanently-delete-an-item-vendor-link"},{"title":"Query item-vendor links","deprecated":null,"version":null,"openapi":"/openapi.yaml post /item-vendor/query","href":"/api-reference/item-vendors/query-item-vendor-links"},{"title":"Count item-vendor links","deprecated":null,"version":null,"openapi":"/openapi.yaml get /item-vendor/count","href":"/api-reference/item-vendors/count-item-vendor-links"},{"title":"Count item-vendor links with a request body","deprecated":null,"version":null,"openapi":"/openapi.yaml post /item-vendor/count","href":"/api-reference/item-vendors/count-item-vendor-links-with-a-request-body"},{"title":"Group and count item-vendor links","deprecated":null,"version":null,"openapi":"/openapi.yaml post /item-vendor/group-and-count","href":"/api-reference/item-vendors/group-and-count-item-vendor-links"},{"title":"Update matching item-vendor links","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /item-vendor/bulk","href":"/api-reference/item-vendors/update-matching-item-vendor-links"},{"title":"Upsert multiple item-vendor links","deprecated":null,"version":null,"openapi":"/openapi.yaml put /item-vendor/bulk","href":"/api-reference/item-vendors/upsert-multiple-item-vendor-links"}]},{"group":"Inventory stock","pages":[{"title":"List inventory stock rows","deprecated":null,"version":null,"openapi":"/openapi.yaml get /inventory-stock","href":"/api-reference/inventory-stock/list-inventory-stock-rows"},{"title":"Get an inventory stock row","deprecated":null,"version":null,"openapi":"/openapi.yaml get /inventory-stock/{id}","href":"/api-reference/inventory-stock/get-an-inventory-stock-row"},{"title":"Query inventory stock rows","deprecated":null,"version":null,"openapi":"/openapi.yaml post /inventory-stock/query","href":"/api-reference/inventory-stock/query-inventory-stock-rows"},{"title":"Count inventory stock rows","deprecated":null,"version":null,"openapi":"/openapi.yaml get /inventory-stock/count","href":"/api-reference/inventory-stock/count-inventory-stock-rows"},{"title":"Count inventory stock rows with a request body","deprecated":null,"version":null,"openapi":"/openapi.yaml post /inventory-stock/count","href":"/api-reference/inventory-stock/count-inventory-stock-rows-with-a-request-body"},{"title":"Group and count inventory stock rows","deprecated":null,"version":null,"openapi":"/openapi.yaml post /inventory-stock/group-and-count","href":"/api-reference/inventory-stock/group-and-count-inventory-stock-rows"},{"title":"Remove one empty stock row","deprecated":null,"version":null,"openapi":"/openapi.yaml post /inventory-stock/{id}/remove","href":"/api-reference/inventory-stock/remove-one-empty-stock-row"},{"title":"Remove empty stock rows at a location","deprecated":null,"version":null,"openapi":"/openapi.yaml post /inventory-stock/remove-empty","href":"/api-reference/inventory-stock/remove-empty-stock-rows-at-a-location"}]},{"group":"Inventory transactions","pages":[{"title":"List inventory transactions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /inventory-transaction","href":"/api-reference/inventory-transactions/list-inventory-transactions"},{"title":"Create one or more inventory transactions","deprecated":null,"version":null,"openapi":"/openapi.yaml post /inventory-transaction","href":"/api-reference/inventory-transactions/create-one-or-more-inventory-transactions"},{"title":"Get an inventory transaction","deprecated":null,"version":null,"openapi":"/openapi.yaml get /inventory-transaction/{id}","href":"/api-reference/inventory-transactions/get-an-inventory-transaction"},{"title":"Query inventory transactions","deprecated":null,"version":null,"openapi":"/openapi.yaml post /inventory-transaction/query","href":"/api-reference/inventory-transactions/query-inventory-transactions"},{"title":"Count inventory transactions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /inventory-transaction/count","href":"/api-reference/inventory-transactions/count-inventory-transactions"},{"title":"Count inventory transactions with a request body","deprecated":null,"version":null,"openapi":"/openapi.yaml post /inventory-transaction/count","href":"/api-reference/inventory-transactions/count-inventory-transactions-with-a-request-body"},{"title":"Group and count inventory transactions","deprecated":null,"version":null,"openapi":"/openapi.yaml post /inventory-transaction/group-and-count","href":"/api-reference/inventory-transactions/group-and-count-inventory-transactions"}]},{"group":"Inventory allocations","pages":[{"title":"List inventory allocations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /inventory-allocation","href":"/api-reference/inventory-allocations/list-inventory-allocations"},{"title":"Get an inventory allocation","deprecated":null,"version":null,"openapi":"/openapi.yaml get /inventory-allocation/{id}","href":"/api-reference/inventory-allocations/get-an-inventory-allocation"},{"title":"Query inventory allocations","deprecated":null,"version":null,"openapi":"/openapi.yaml post /inventory-allocation/query","href":"/api-reference/inventory-allocations/query-inventory-allocations"},{"title":"Count inventory allocations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /inventory-allocation/count","href":"/api-reference/inventory-allocations/count-inventory-allocations"},{"title":"Count inventory allocations with a request body","deprecated":null,"version":null,"openapi":"/openapi.yaml post /inventory-allocation/count","href":"/api-reference/inventory-allocations/count-inventory-allocations-with-a-request-body"},{"title":"Group and count inventory allocations","deprecated":null,"version":null,"openapi":"/openapi.yaml post /inventory-allocation/group-and-count","href":"/api-reference/inventory-allocations/group-and-count-inventory-allocations"}]},{"group":"BOM lines","pages":[{"title":"List BOM lines","deprecated":null,"version":null,"openapi":"/openapi.yaml get /bom-line","href":"/api-reference/bom-lines/list-bom-lines"},{"title":"Create one or more BOM lines","deprecated":null,"version":null,"openapi":"/openapi.yaml post /bom-line","href":"/api-reference/bom-lines/create-one-or-more-bom-lines"},{"title":"Get a BOM line","deprecated":null,"version":null,"openapi":"/openapi.yaml get /bom-line/{id}","href":"/api-reference/bom-lines/get-a-bom-line"},{"title":"Update a BOM line","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /bom-line/{id}","href":"/api-reference/bom-lines/update-a-bom-line"},{"title":"Upsert a BOM line","deprecated":null,"version":null,"openapi":"/openapi.yaml put /bom-line/{id}","href":"/api-reference/bom-lines/upsert-a-bom-line"},{"title":"Delete a BOM line","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /bom-line/{id}","href":"/api-reference/bom-lines/delete-a-bom-line"},{"title":"Query BOM lines","deprecated":null,"version":null,"openapi":"/openapi.yaml post /bom-line/query","href":"/api-reference/bom-lines/query-bom-lines"},{"title":"Count BOM lines","deprecated":null,"version":null,"openapi":"/openapi.yaml get /bom-line/count","href":"/api-reference/bom-lines/count-bom-lines"},{"title":"Count BOM lines with a request body","deprecated":null,"version":null,"openapi":"/openapi.yaml post /bom-line/count","href":"/api-reference/bom-lines/count-bom-lines-with-a-request-body"},{"title":"Group and count BOM lines","deprecated":null,"version":null,"openapi":"/openapi.yaml post /bom-line/group-and-count","href":"/api-reference/bom-lines/group-and-count-bom-lines"},{"title":"Update matching BOM lines","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /bom-line/bulk","href":"/api-reference/bom-lines/update-matching-bom-lines"},{"title":"Upsert multiple BOM lines","deprecated":null,"version":null,"openapi":"/openapi.yaml put /bom-line/bulk","href":"/api-reference/bom-lines/upsert-multiple-bom-lines"},{"title":"Prepopulate an order BOM","deprecated":null,"version":null,"openapi":"/openapi.yaml post /bom-line/order/{id}/prepopulate","href":"/api-reference/bom-lines/prepopulate-an-order-bom"},{"title":"Allocate materials for an order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /bom-line/order/{id}/allocate","href":"/api-reference/bom-lines/allocate-materials-for-an-order"},{"title":"Allocate materials for a project","deprecated":null,"version":null,"openapi":"/openapi.yaml post /bom-line/project/{id}/allocate","href":"/api-reference/bom-lines/allocate-materials-for-a-project"},{"title":"Get demand across accessible projects","deprecated":null,"version":null,"openapi":"/openapi.yaml get /bom-line/demand-rollup","href":"/api-reference/bom-lines/get-demand-across-accessible-projects"},{"title":"Get the material rollup for a project","deprecated":null,"version":null,"openapi":"/openapi.yaml get /bom-line/project/{projectId}/materials-rollup","href":"/api-reference/bom-lines/get-the-material-rollup-for-a-project"}]},{"group":"Production outputs","pages":[{"title":"List production outputs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /production-output","href":"/api-reference/production-outputs/list-production-outputs"},{"title":"Create one or more production outputs","deprecated":null,"version":null,"openapi":"/openapi.yaml post /production-output","href":"/api-reference/production-outputs/create-one-or-more-production-outputs"},{"title":"Get a production output","deprecated":null,"version":null,"openapi":"/openapi.yaml get /production-output/{id}","href":"/api-reference/production-outputs/get-a-production-output"},{"title":"Update a production output","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /production-output/{id}","href":"/api-reference/production-outputs/update-a-production-output"},{"title":"Upsert a production output","deprecated":null,"version":null,"openapi":"/openapi.yaml put /production-output/{id}","href":"/api-reference/production-outputs/upsert-a-production-output"},{"title":"Delete a production output","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /production-output/{id}","href":"/api-reference/production-outputs/delete-a-production-output"},{"title":"Query production outputs","deprecated":null,"version":null,"openapi":"/openapi.yaml post /production-output/query","href":"/api-reference/production-outputs/query-production-outputs"},{"title":"Count production outputs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /production-output/count","href":"/api-reference/production-outputs/count-production-outputs"},{"title":"Count production outputs with a request body","deprecated":null,"version":null,"openapi":"/openapi.yaml post /production-output/count","href":"/api-reference/production-outputs/count-production-outputs-with-a-request-body"},{"title":"Group and count production outputs","deprecated":null,"version":null,"openapi":"/openapi.yaml post /production-output/group-and-count","href":"/api-reference/production-outputs/group-and-count-production-outputs"},{"title":"Update matching production outputs","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /production-output/bulk","href":"/api-reference/production-outputs/update-matching-production-outputs"},{"title":"Upsert multiple production outputs","deprecated":null,"version":null,"openapi":"/openapi.yaml put /production-output/bulk","href":"/api-reference/production-outputs/upsert-multiple-production-outputs"},{"title":"Record produced output","deprecated":null,"version":null,"openapi":"/openapi.yaml post /production/produce","href":"/api-reference/production-outputs/record-produced-output"},{"title":"Record consumed inputs","deprecated":null,"version":null,"openapi":"/openapi.yaml post /production/consume","href":"/api-reference/production-outputs/record-consumed-inputs"},{"title":"Correct a recorded actual","deprecated":null,"version":null,"openapi":"/openapi.yaml post /production/adjust-actual","href":"/api-reference/production-outputs/correct-a-recorded-actual"},{"title":"Read order production status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /production/order/{id}/status","href":"/api-reference/production-outputs/read-order-production-status"},{"title":"Read order production entries","deprecated":null,"version":null,"openapi":"/openapi.yaml get /production/order/{id}/entries","href":"/api-reference/production-outputs/read-order-production-entries"}]},{"group":"Units of measure","pages":[{"title":"List units of measure","deprecated":null,"version":null,"openapi":"/openapi.yaml get /unit-measure","href":"/api-reference/units-of-measure/list-units-of-measure"},{"title":"Create one or more units of measure","deprecated":null,"version":null,"openapi":"/openapi.yaml post /unit-measure","href":"/api-reference/units-of-measure/create-one-or-more-units-of-measure"},{"title":"Get a unit of measure","deprecated":null,"version":null,"openapi":"/openapi.yaml get /unit-measure/{id}","href":"/api-reference/units-of-measure/get-a-unit-of-measure"},{"title":"Update a unit of measure","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /unit-measure/{id}","href":"/api-reference/units-of-measure/update-a-unit-of-measure"},{"title":"Upsert a unit of measure","deprecated":null,"version":null,"openapi":"/openapi.yaml put /unit-measure/{id}","href":"/api-reference/units-of-measure/upsert-a-unit-of-measure"},{"title":"Delete a unit of measure","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /unit-measure/{id}","href":"/api-reference/units-of-measure/delete-a-unit-of-measure"},{"title":"Query units of measure","deprecated":null,"version":null,"openapi":"/openapi.yaml post /unit-measure/query","href":"/api-reference/units-of-measure/query-units-of-measure"},{"title":"Count units of measure","deprecated":null,"version":null,"openapi":"/openapi.yaml get /unit-measure/count","href":"/api-reference/units-of-measure/count-units-of-measure"},{"title":"Count units of measure with a request body","deprecated":null,"version":null,"openapi":"/openapi.yaml post /unit-measure/count","href":"/api-reference/units-of-measure/count-units-of-measure-with-a-request-body"},{"title":"Group and count units of measure","deprecated":null,"version":null,"openapi":"/openapi.yaml post /unit-measure/group-and-count","href":"/api-reference/units-of-measure/group-and-count-units-of-measure"},{"title":"Update matching units of measure","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /unit-measure/bulk","href":"/api-reference/units-of-measure/update-matching-units-of-measure"},{"title":"Upsert multiple units of measure","deprecated":null,"version":null,"openapi":"/openapi.yaml put /unit-measure/bulk","href":"/api-reference/units-of-measure/upsert-multiple-units-of-measure"}]},{"group":"Vendors","pages":[{"title":"List vendors","deprecated":null,"version":null,"openapi":"/openapi.yaml get /vendor","href":"/api-reference/vendors/list-vendors"},{"title":"Create one or more vendors","deprecated":null,"version":null,"openapi":"/openapi.yaml post /vendor","href":"/api-reference/vendors/create-one-or-more-vendors"},{"title":"Get a vendor","deprecated":null,"version":null,"openapi":"/openapi.yaml get /vendor/{id}","href":"/api-reference/vendors/get-a-vendor"},{"title":"Update a vendor","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /vendor/{id}","href":"/api-reference/vendors/update-a-vendor"},{"title":"Upsert a vendor","deprecated":null,"version":null,"openapi":"/openapi.yaml put /vendor/{id}","href":"/api-reference/vendors/upsert-a-vendor"},{"title":"Delete a vendor","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /vendor/{id}","href":"/api-reference/vendors/delete-a-vendor"},{"title":"Query vendors","deprecated":null,"version":null,"openapi":"/openapi.yaml post /vendor/query","href":"/api-reference/vendors/query-vendors"},{"title":"Count vendors","deprecated":null,"version":null,"openapi":"/openapi.yaml get /vendor/count","href":"/api-reference/vendors/count-vendors"},{"title":"Count vendors with a request body","deprecated":null,"version":null,"openapi":"/openapi.yaml post /vendor/count","href":"/api-reference/vendors/count-vendors-with-a-request-body"},{"title":"Group and count vendors","deprecated":null,"version":null,"openapi":"/openapi.yaml post /vendor/group-and-count","href":"/api-reference/vendors/group-and-count-vendors"},{"title":"Update matching vendors","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /vendor/bulk","href":"/api-reference/vendors/update-matching-vendors"},{"title":"Upsert multiple vendors","deprecated":null,"version":null,"openapi":"/openapi.yaml put /vendor/bulk","href":"/api-reference/vendors/upsert-multiple-vendors"}]},{"group":"Locations","pages":[{"title":"List locations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /location","href":"/api-reference/locations/list-locations"},{"title":"Create one or more locations","deprecated":null,"version":null,"openapi":"/openapi.yaml post /location","href":"/api-reference/locations/create-one-or-more-locations"},{"title":"Get a location","deprecated":null,"version":null,"openapi":"/openapi.yaml get /location/{id}","href":"/api-reference/locations/get-a-location"},{"title":"Update a location","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /location/{id}","href":"/api-reference/locations/update-a-location"},{"title":"Upsert a location","deprecated":null,"version":null,"openapi":"/openapi.yaml put /location/{id}","href":"/api-reference/locations/upsert-a-location"},{"title":"Delete a location","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /location/{id}","href":"/api-reference/locations/delete-a-location"},{"title":"Query locations","deprecated":null,"version":null,"openapi":"/openapi.yaml post /location/query","href":"/api-reference/locations/query-locations"},{"title":"Count locations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /location/count","href":"/api-reference/locations/count-locations"},{"title":"Count locations with a request body","deprecated":null,"version":null,"openapi":"/openapi.yaml post /location/count","href":"/api-reference/locations/count-locations-with-a-request-body"},{"title":"Group and count locations","deprecated":null,"version":null,"openapi":"/openapi.yaml post /location/group-and-count","href":"/api-reference/locations/group-and-count-locations"},{"title":"Update matching locations","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /location/bulk","href":"/api-reference/locations/update-matching-locations"},{"title":"Upsert multiple locations","deprecated":null,"version":null,"openapi":"/openapi.yaml put /location/bulk","href":"/api-reference/locations/upsert-multiple-locations"}]},{"group":"Deliveries","pages":[{"title":"List deliveries","deprecated":null,"version":null,"openapi":"/openapi.yaml get /delivery","href":"/api-reference/deliveries/list-deliveries"},{"title":"Create one or more deliveries","deprecated":null,"version":null,"openapi":"/openapi.yaml post /delivery","href":"/api-reference/deliveries/create-one-or-more-deliveries"},{"title":"Get a delivery","deprecated":null,"version":null,"openapi":"/openapi.yaml get /delivery/{id}","href":"/api-reference/deliveries/get-a-delivery"},{"title":"Update a delivery","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /delivery/{id}","href":"/api-reference/deliveries/update-a-delivery"},{"title":"Upsert a delivery","deprecated":null,"version":null,"openapi":"/openapi.yaml put /delivery/{id}","href":"/api-reference/deliveries/upsert-a-delivery"},{"title":"Permanently delete a delivery","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /delivery/{id}","href":"/api-reference/deliveries/permanently-delete-a-delivery"},{"title":"Query deliveries","deprecated":null,"version":null,"openapi":"/openapi.yaml post /delivery/query","href":"/api-reference/deliveries/query-deliveries"},{"title":"Count deliveries","deprecated":null,"version":null,"openapi":"/openapi.yaml get /delivery/count","href":"/api-reference/deliveries/count-deliveries"},{"title":"Count deliveries with a request body","deprecated":null,"version":null,"openapi":"/openapi.yaml post /delivery/count","href":"/api-reference/deliveries/count-deliveries-with-a-request-body"},{"title":"Group and count deliveries","deprecated":null,"version":null,"openapi":"/openapi.yaml post /delivery/group-and-count","href":"/api-reference/deliveries/group-and-count-deliveries"},{"title":"Update matching deliveries","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /delivery/bulk","href":"/api-reference/deliveries/update-matching-deliveries"},{"title":"Upsert multiple deliveries","deprecated":null,"version":null,"openapi":"/openapi.yaml put /delivery/bulk","href":"/api-reference/deliveries/upsert-multiple-deliveries"},{"title":"Create an outbound or transfer trip","deprecated":null,"version":null,"openapi":"/openapi.yaml post /delivery/outbound","href":"/api-reference/deliveries/create-an-outbound-or-transfer-trip"},{"title":"Update outbound trip details","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /delivery/{id}/outbound","href":"/api-reference/deliveries/update-outbound-trip-details"},{"title":"Receive inbound materials","deprecated":null,"version":null,"openapi":"/openapi.yaml post /delivery/{id}/receive","href":"/api-reference/deliveries/receive-inbound-materials"},{"title":"Start delivery","deprecated":null,"version":null,"openapi":"/openapi.yaml post /delivery/{id}/start","href":"/api-reference/deliveries/start-delivery"},{"title":"Cancel delivery","deprecated":null,"version":null,"openapi":"/openapi.yaml post /delivery/{id}/cancel","href":"/api-reference/deliveries/cancel-delivery"},{"title":"Archive delivery","deprecated":null,"version":null,"openapi":"/openapi.yaml post /delivery/{id}/archive","href":"/api-reference/deliveries/archive-delivery"},{"title":"Restore delivery","deprecated":null,"version":null,"openapi":"/openapi.yaml post /delivery/{id}/restore","href":"/api-reference/deliveries/restore-delivery"},{"title":"Complete an outbound delivery","deprecated":null,"version":null,"openapi":"/openapi.yaml post /delivery/{id}/complete","href":"/api-reference/deliveries/complete-an-outbound-delivery"},{"title":"Read delivery itinerary","deprecated":null,"version":null,"openapi":"/openapi.yaml get /delivery/{id}/itinerary","href":"/api-reference/deliveries/read-delivery-itinerary"},{"title":"Read delivery cargo-plan","deprecated":null,"version":null,"openapi":"/openapi.yaml get /delivery/{id}/cargo-plan","href":"/api-reference/deliveries/read-delivery-cargo-plan"}]},{"group":"Delivery lines","pages":[{"title":"List delivery lines","deprecated":null,"version":null,"openapi":"/openapi.yaml get /delivery-line","href":"/api-reference/delivery-lines/list-delivery-lines"},{"title":"Create one or more delivery lines","deprecated":null,"version":null,"openapi":"/openapi.yaml post /delivery-line","href":"/api-reference/delivery-lines/create-one-or-more-delivery-lines"},{"title":"Get a delivery line","deprecated":null,"version":null,"openapi":"/openapi.yaml get /delivery-line/{id}","href":"/api-reference/delivery-lines/get-a-delivery-line"},{"title":"Update a delivery line","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /delivery-line/{id}","href":"/api-reference/delivery-lines/update-a-delivery-line"},{"title":"Upsert a delivery line","deprecated":null,"version":null,"openapi":"/openapi.yaml put /delivery-line/{id}","href":"/api-reference/delivery-lines/upsert-a-delivery-line"},{"title":"Delete a delivery line","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /delivery-line/{id}","href":"/api-reference/delivery-lines/delete-a-delivery-line"},{"title":"Query delivery lines","deprecated":null,"version":null,"openapi":"/openapi.yaml post /delivery-line/query","href":"/api-reference/delivery-lines/query-delivery-lines"},{"title":"Count delivery lines","deprecated":null,"version":null,"openapi":"/openapi.yaml get /delivery-line/count","href":"/api-reference/delivery-lines/count-delivery-lines"},{"title":"Count delivery lines with a request body","deprecated":null,"version":null,"openapi":"/openapi.yaml post /delivery-line/count","href":"/api-reference/delivery-lines/count-delivery-lines-with-a-request-body"},{"title":"Group and count delivery lines","deprecated":null,"version":null,"openapi":"/openapi.yaml post /delivery-line/group-and-count","href":"/api-reference/delivery-lines/group-and-count-delivery-lines"},{"title":"Update matching delivery lines","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /delivery-line/bulk","href":"/api-reference/delivery-lines/update-matching-delivery-lines"},{"title":"Upsert multiple delivery lines","deprecated":null,"version":null,"openapi":"/openapi.yaml put /delivery-line/bulk","href":"/api-reference/delivery-lines/upsert-multiple-delivery-lines"}]},{"group":"Trucks","pages":[{"title":"List trucks","deprecated":null,"version":null,"openapi":"/openapi.yaml get /truck","href":"/api-reference/trucks/list-trucks"},{"title":"Create one or more trucks","deprecated":null,"version":null,"openapi":"/openapi.yaml post /truck","href":"/api-reference/trucks/create-one-or-more-trucks"},{"title":"Get a truck","deprecated":null,"version":null,"openapi":"/openapi.yaml get /truck/{id}","href":"/api-reference/trucks/get-a-truck"},{"title":"Update a truck","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /truck/{id}","href":"/api-reference/trucks/update-a-truck"},{"title":"Upsert a truck","deprecated":null,"version":null,"openapi":"/openapi.yaml put /truck/{id}","href":"/api-reference/trucks/upsert-a-truck"},{"title":"Delete a truck","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /truck/{id}","href":"/api-reference/trucks/delete-a-truck"},{"title":"Query trucks","deprecated":null,"version":null,"openapi":"/openapi.yaml post /truck/query","href":"/api-reference/trucks/query-trucks"},{"title":"Count trucks","deprecated":null,"version":null,"openapi":"/openapi.yaml get /truck/count","href":"/api-reference/trucks/count-trucks"},{"title":"Count trucks with a request body","deprecated":null,"version":null,"openapi":"/openapi.yaml post /truck/count","href":"/api-reference/trucks/count-trucks-with-a-request-body"},{"title":"Group and count trucks","deprecated":null,"version":null,"openapi":"/openapi.yaml post /truck/group-and-count","href":"/api-reference/trucks/group-and-count-trucks"},{"title":"Update matching trucks","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /truck/bulk","href":"/api-reference/trucks/update-matching-trucks"},{"title":"Upsert multiple trucks","deprecated":null,"version":null,"openapi":"/openapi.yaml put /truck/bulk","href":"/api-reference/trucks/upsert-multiple-trucks"}]},{"group":"Contacts","pages":[{"title":"List contacts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /contact","href":"/api-reference/contacts/list-contacts"},{"title":"Create one or more contacts","deprecated":null,"version":null,"openapi":"/openapi.yaml post /contact","href":"/api-reference/contacts/create-one-or-more-contacts"},{"title":"Get a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml get /contact/{id}","href":"/api-reference/contacts/get-a-contact"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /contact/{id}","href":"/api-reference/contacts/update-a-contact"},{"title":"Upsert a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml put /contact/{id}","href":"/api-reference/contacts/upsert-a-contact"},{"title":"Delete a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /contact/{id}","href":"/api-reference/contacts/delete-a-contact"},{"title":"Query contacts","deprecated":null,"version":null,"openapi":"/openapi.yaml post /contact/query","href":"/api-reference/contacts/query-contacts"},{"title":"Count contacts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /contact/count","href":"/api-reference/contacts/count-contacts"},{"title":"Count contacts with a request body","deprecated":null,"version":null,"openapi":"/openapi.yaml post /contact/count","href":"/api-reference/contacts/count-contacts-with-a-request-body"},{"title":"Group and count contacts","deprecated":null,"version":null,"openapi":"/openapi.yaml post /contact/group-and-count","href":"/api-reference/contacts/group-and-count-contacts"},{"title":"Update matching contacts","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /contact/bulk","href":"/api-reference/contacts/update-matching-contacts"},{"title":"Upsert multiple contacts","deprecated":null,"version":null,"openapi":"/openapi.yaml put /contact/bulk","href":"/api-reference/contacts/upsert-multiple-contacts"}]},{"group":"Project contacts","pages":[{"title":"List project-contact links","deprecated":null,"version":null,"openapi":"/openapi.yaml get /project-contact","href":"/api-reference/project-contacts/list-project-contact-links"},{"title":"Create one or more project-contact links","deprecated":null,"version":null,"openapi":"/openapi.yaml post /project-contact","href":"/api-reference/project-contacts/create-one-or-more-project-contact-links"},{"title":"Get a project-contact link","deprecated":null,"version":null,"openapi":"/openapi.yaml get /project-contact/{id}","href":"/api-reference/project-contacts/get-a-project-contact-link"},{"title":"Update a project-contact link","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /project-contact/{id}","href":"/api-reference/project-contacts/update-a-project-contact-link"},{"title":"Upsert a project-contact link","deprecated":null,"version":null,"openapi":"/openapi.yaml put /project-contact/{id}","href":"/api-reference/project-contacts/upsert-a-project-contact-link"},{"title":"Permanently delete a project-contact link","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /project-contact/{id}","href":"/api-reference/project-contacts/permanently-delete-a-project-contact-link"},{"title":"Query project-contact links","deprecated":null,"version":null,"openapi":"/openapi.yaml post /project-contact/query","href":"/api-reference/project-contacts/query-project-contact-links"},{"title":"Count project-contact links","deprecated":null,"version":null,"openapi":"/openapi.yaml get /project-contact/count","href":"/api-reference/project-contacts/count-project-contact-links"},{"title":"Count project-contact links with a request body","deprecated":null,"version":null,"openapi":"/openapi.yaml post /project-contact/count","href":"/api-reference/project-contacts/count-project-contact-links-with-a-request-body"},{"title":"Group and count project-contact links","deprecated":null,"version":null,"openapi":"/openapi.yaml post /project-contact/group-and-count","href":"/api-reference/project-contacts/group-and-count-project-contact-links"},{"title":"Update matching project-contact links","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /project-contact/bulk","href":"/api-reference/project-contacts/update-matching-project-contact-links"},{"title":"Upsert multiple project-contact links","deprecated":null,"version":null,"openapi":"/openapi.yaml put /project-contact/bulk","href":"/api-reference/project-contacts/upsert-multiple-project-contact-links"}]},{"group":"Teams","pages":[{"title":"List teams","deprecated":null,"version":null,"openapi":"/openapi.yaml get /team","href":"/api-reference/teams/list-teams"},{"title":"Get a team","deprecated":null,"version":null,"openapi":"/openapi.yaml get /team/{id}","href":"/api-reference/teams/get-a-team"},{"title":"Query teams","deprecated":null,"version":null,"openapi":"/openapi.yaml post /team/query","href":"/api-reference/teams/query-teams"},{"title":"Count teams","deprecated":null,"version":null,"openapi":"/openapi.yaml get /team/count","href":"/api-reference/teams/count-teams"},{"title":"Count teams with a request body","deprecated":null,"version":null,"openapi":"/openapi.yaml post /team/count","href":"/api-reference/teams/count-teams-with-a-request-body"},{"title":"Group and count teams","deprecated":null,"version":null,"openapi":"/openapi.yaml post /team/group-and-count","href":"/api-reference/teams/group-and-count-teams"}]},{"group":"Shifts","pages":[{"title":"List shifts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /shift","href":"/api-reference/shifts/list-shifts"},{"title":"Get a shift","deprecated":null,"version":null,"openapi":"/openapi.yaml get /shift/{id}","href":"/api-reference/shifts/get-a-shift"},{"title":"Query shifts","deprecated":null,"version":null,"openapi":"/openapi.yaml post /shift/query","href":"/api-reference/shifts/query-shifts"},{"title":"Count shifts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /shift/count","href":"/api-reference/shifts/count-shifts"},{"title":"Count shifts with a request body","deprecated":null,"version":null,"openapi":"/openapi.yaml post /shift/count","href":"/api-reference/shifts/count-shifts-with-a-request-body"},{"title":"Group and count shifts","deprecated":null,"version":null,"openapi":"/openapi.yaml post /shift/group-and-count","href":"/api-reference/shifts/group-and-count-shifts"}]},{"group":"Departments (shops)","pages":[{"title":"List departments","deprecated":null,"version":null,"openapi":"/openapi.yaml get /shop","href":"/api-reference/departments-shops/list-departments"},{"title":"Get a department","deprecated":null,"version":null,"openapi":"/openapi.yaml get /shop/{id}","href":"/api-reference/departments-shops/get-a-department"},{"title":"Query departments","deprecated":null,"version":null,"openapi":"/openapi.yaml post /shop/query","href":"/api-reference/departments-shops/query-departments"},{"title":"Count departments","deprecated":null,"version":null,"openapi":"/openapi.yaml get /shop/count","href":"/api-reference/departments-shops/count-departments"},{"title":"Count departments with a request body","deprecated":null,"version":null,"openapi":"/openapi.yaml post /shop/count","href":"/api-reference/departments-shops/count-departments-with-a-request-body"},{"title":"Group and count departments","deprecated":null,"version":null,"openapi":"/openapi.yaml post /shop/group-and-count","href":"/api-reference/departments-shops/group-and-count-departments"}]}]}]},"basePath":"","title":"List custom properties - BuildingSwell API","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-BIYvYBgk.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js","Markdown-CEfymfIH.js","clsx-Dq9TQuNi.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-D2J8knkn.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BgZ2ThuU.js"]}