{
"error": {
"code": "STALE_REVISION",
"message": "The visit changed; read it again before editing",
"request_id": "example-request",
"details": []
}
}
Derived representation identified by team member and resolved period dates. Required period_date is a local calendar date. Includes a zero total when the member has no entries. Returns 400 for missing or unusable configuration and 404 for a missing or foreign member.
{
"error": {
"code": "STALE_REVISION",
"message": "The visit changed; read it again before editing",
"request_id": "example-request",
"details": []
}
}
Required company-local date within the desired configured period. Uses current company settings, even when time tracking is disabled. Returns 400 if no usable period configuration exists.
A derived member-period representation, identified by member ID and resolved period dates. No persisted ID or modification timestamp. Includes inactive and zero-entry current company members of every role.
Generation time and company timezone. generated_at is not a snapshot or synchronization token.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Breezy FSM API","description":"Build operational and financial reports with the Breezy field service management API.","colors":{"primary":"#0958D9","light":"#4096FF","dark":"#0958D9"},"logo":{"light":"https://mintcdn.com/breezy-fsm/oiZqxfHjJWgR4SxV/logo/breezy-light.svg?fit=max\u0026auto=format\u0026n=oiZqxfHjJWgR4SxV\u0026q=85\u0026s=0d4ab09c4ec7a4400a349d0f2977aab8","dark":"https://mintcdn.com/breezy-fsm/oiZqxfHjJWgR4SxV/logo/breezy-dark.svg?fit=max\u0026auto=format\u0026n=oiZqxfHjJWgR4SxV\u0026q=85\u0026s=4321d61497647cf95bd6a5699e865094"},"favicon":"https://mintcdn.com/breezy-fsm/oiZqxfHjJWgR4SxV/favicon.png?fit=max\u0026auto=format\u0026n=oiZqxfHjJWgR4SxV\u0026q=85\u0026s=b8d4bc0727520f5ee0ddbada48d37ce4","api":{"playground":{"display":"interactive","proxy":false,"credentials":false},"examples":{"defaults":"required","languages":["curl","python","javascript"],"prefill":false}},"appearance":{"default":"system","strict":false},"navbar":{"links":[{"href":"https://getbreezyapp.com","label":"Breezy"}],"primary":{"type":"button","label":"Open FSM","href":"https://dashboard.getbreezyapp.com"}},"seo":{"metatags":{"og:title":"Breezy FSM API","og:description":"Scheduling and operational and financial reporting: resources, pagination, business measures, and examples.","og:type":"website","twitter:card":"summary_large_image"},"indexing":"navigable"},"fonts":{"heading":{"family":"Poppins","weight":600}},"icons":{"library":"lucide"},"styling":{"codeblocks":{"theme":{"light":"github-light","dark":"github-dark"}},"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"breezy-fsm","hasAudioNarration":false,"actualSubdomain":"breezy-fsm","customDomains":["developers.getbreezyapp.com"],"gitSource":{"type":"github","owner":"breezy-software-inc","repo":"platform","deployBranch":"public-api-docs","contentDirectory":"docs/public-api","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ab55e44a89dca91c2c0530c","collectionId":"ef0d6133-1f75-47c3-a721-8ee620608de6","liveDeploymentHistoryId":"6ab55e44a89dca91c2c0530c","schemaVersion":"v3"},"entitlements":{},"buildId":"6ab55e44a89dca91c2c0530c","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"API reference","count":64},{"language":"default","tag":"Reporting guides","count":11},{"language":"default","tag":"Business measures","count":9},{"language":"default","tag":"Scheduling","count":9},{"language":"default","tag":"Start here","count":6},{"language":"default","tag":"Get started","count":6},{"language":"default","tag":"Reports","count":6},{"language":"default","tag":"Plan your reports","count":2},{"language":"default","tag":"Accounts","count":2},{"language":"default","tag":"BusinessUnits","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","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":"editor-v7-file-tree","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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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}],"isAtlas":false,"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"api-reference/timesheets/read-one-member’s-configured-period-timesheet","slug":"/api-reference/timesheets/read-one-member’s-configured-period-timesheet","pageMetadata":{"title":"Read one member’s configured-period timesheet","description":"Derived representation identified by team member and resolved period dates. Required period_date is a local calendar date. Includes a zero total when the member has no entries. Returns 400 for missing or unusable configuration and 404 for a missing or foreign member.","deprecated":null,"version":null,"openapi":"/openapi.json get /timesheets/{team_member_id}","href":"/api-reference/timesheets/read-one-member’s-configured-period-timesheet","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: \"Derived representation identified by team member and resolved period dates. Required period_date is a local calendar date. Includes a zero total when the member has no entries. Returns 400 for missing or unusable configuration and 404 for a missing or foreign member.\"\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":{"codeStyling":{"theme":{"light":"github-light","dark":"github-dark"}},"config":{},"pageMetadata":{"title":"Read one member’s configured-period timesheet","description":"Derived representation identified by team member and resolved period dates. Required period_date is a local calendar date. Includes a zero total when the member has no entries. Returns 400 for missing or unusable configuration and 404 for a missing or foreign member.","deprecated":null,"version":null,"openapi":"/openapi.json get /timesheets/{team_member_id}","href":"/api-reference/timesheets/read-one-member’s-configured-period-timesheet","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getTimesheet","tags":["Timesheets"],"summary":"Read one member’s configured-period timesheet","description":"Derived representation identified by team member and resolved period dates. Required period_date is a local calendar date. Includes a zero total when the member has no entries. Returns 400 for missing or unusable configuration and 404 for a missing or foreign member.","security":["a8ba010c-8478-4dd0-9cd1-29498a7f0532"],"parameters":["1da9ad6b-62ef-4766-b03a-cc4dc729ce66","0b3fdb74-d398-4561-bb8d-fb68a288b9f3"],"responses":{"200":"cfa5ec97-4df6-4b30-822a-34d7db076cb3","400":"ffce0f34-3232-415d-9552-9474b4b40c7f","401":"91925c27-7af8-4d90-9a93-dce5ed5a1549","404":"e4357bbc-0f0e-4a5c-ac80-0aeeafec2305","405":"548d05d2-a6d0-4971-8172-b441078c5dc3","409":"1c3bbe93-1e61-4c71-b249-bb53ebe88c95","413":"38423770-b5c8-47bd-80e5-db54494bc68f","429":"74871bdc-46e0-4fa5-b0fe-287a830c11fd","500":"74023670-775b-4571-822e-cce326ffec7c"},"method":"get","type":"path","servers":["d4239c0d-e8dd-49f6-b7f4-2b5a3ad6583c"],"path":"/timesheets/{team_member_id}","baseUrlOptions":["https://api.getbreezyapp.com/v1"],"title":"Read one member’s configured-period timesheet","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{"1da9ad6b-62ef-4766-b03a-cc4dc729ce66":{"schema":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"},"required":true,"name":"team_member_id","in":"path"},"0b3fdb74-d398-4561-bb8d-fb68a288b9f3":{"schema":{"type":"string","format":"date","description":"Required company-local date within the desired configured period. Uses current company settings, even when time tracking is disabled. Returns 400 if no usable period configuration exists.","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cdate>"},"required":true,"description":"Required company-local date within the desired configured period. Uses current company settings, even when time tracking is disabled. Returns 400 if no usable period configuration exists.","name":"period_date","in":"query"}},"responses":{"cfa5ec97-4df6-4b30-822a-34d7db076cb3":{"description":"Successful read. Clients ignore unrecognized response fields.","headers":{"Cache-Control":{"schema":{"type":"string"},"example":"private, no-store"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"team_member":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.team_member.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","isRequired":true,"uniqueKey":"data.team_member.name","typeLabel":"string"}},"required":["id","name"],"isRequired":true,"uniqueKey":"data.team_member","typeLabel":"object"},"period":{"type":"object","properties":{"start_date":{"type":"string","format":"date","description":"Inclusive company-local date under the current configured pay period.","isRequired":true,"uniqueKey":"data.period.start_date","typeLabel":"string\u003cdate>"},"end_date_exclusive":{"type":"string","format":"date","description":"Exclusive company-local date. Select this date as period_date to retrieve the next period.","isRequired":true,"uniqueKey":"data.period.end_date_exclusive","typeLabel":"string\u003cdate>"}},"required":["start_date","end_date_exclusive"],"isRequired":true,"uniqueKey":"data.period","typeLabel":"object"},"entry_count":{"type":"integer","minimum":0,"description":"Nondeleted entries whose effective start falls in this period, including open and nonpayable entries.","isRequired":true,"uniqueKey":"data.entry_count","typeLabel":"integer"},"open_entry_count":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"data.open_entry_count","typeLabel":"integer"},"unknown_activity_entry_count":{"type":"integer","minimum":0,"description":"Entries without one unambiguous owned activity; excluded from payable totals.","isRequired":true,"uniqueKey":"data.unknown_activity_entry_count","typeLabel":"integer"},"payable_minutes":{"type":"integer","minimum":0,"description":"Sum of daily payable minutes using existing timesheet rules; not payroll, overtime, or raw elapsed time.","isRequired":true,"uniqueKey":"data.payable_minutes","typeLabel":"integer"},"days":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date","isRequired":true,"uniqueKey":"data.days.items.[INDEX].date","typeLabel":"string\u003cdate>"},"payable_minutes":{"type":"integer","minimum":0,"maximum":1439,"isRequired":true,"uniqueKey":"data.days.items.[INDEX].payable_minutes","typeLabel":"integer"}},"required":["date","payable_minutes"],"uniqueKey":"data.days.items.[INDEX]","typeLabel":"object"},"description":"Every local date in the period, including zero-minute days. Closed, payable, nondeleted entries only; whole wall-clock minutes using the existing server timesheet calculation (including its daylight-saving behavior), capped at 1439 per day. Overnight entries stop at the end of their start day.","isRequired":true,"uniqueKey":"data.days","typeLabel":"object[]"}},"required":["team_member","period","entry_count","open_entry_count","unknown_activity_entry_count","payable_minutes","days"],"description":"A derived member-period representation, identified by member ID and resolved period dates. No persisted ID or modification timestamp. Includes inactive and zero-entry current company members of every role.","isRequired":true,"uniqueKey":"data","typeLabel":"object"},"meta":{"type":"object","properties":{"request_id":{"type":"string","isRequired":true,"uniqueKey":"meta.request_id","typeLabel":"string"},"generated_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"meta.generated_at","typeLabel":"string\u003cdate-time>"},"timezone":{"type":"string","isRequired":true,"uniqueKey":"meta.timezone","typeLabel":"string"}},"required":["request_id","generated_at","timezone"],"description":"Generation time and company timezone. generated_at is not a snapshot or synchronization token.","isRequired":true,"uniqueKey":"meta","typeLabel":"object"}},"required":["data","meta"],"uniqueKey":"","typeLabel":"object"},"example":{"data":{"team_member":{"id":"11111111-1111-4111-8111-000000000401","name":"Alex Example"},"period":{"start_date":"2026-09-07","end_date_exclusive":"2026-09-14"},"entry_count":1,"open_entry_count":0,"unknown_activity_entry_count":0,"payable_minutes":60,"days":[{"date":"2026-09-07","payable_minutes":0},{"date":"2026-09-08","payable_minutes":60},{"date":"2026-09-09","payable_minutes":0},{"date":"2026-09-10","payable_minutes":0},{"date":"2026-09-11","payable_minutes":0},{"date":"2026-09-12","payable_minutes":0},{"date":"2026-09-13","payable_minutes":0}]},"meta":{"request_id":"11111111-1111-4111-8111-000000009999","generated_at":"2026-09-08T19:00:00Z","timezone":"America/Los_Angeles"}},"examples":{"Example":{"title":"Example","value":{"data":{"team_member":{"id":"11111111-1111-4111-8111-000000000401","name":"Alex Example"},"period":{"start_date":"2026-09-07","end_date_exclusive":"2026-09-14"},"entry_count":1,"open_entry_count":0,"unknown_activity_entry_count":0,"payable_minutes":60,"days":[{"date":"2026-09-07","payable_minutes":0},{"date":"2026-09-08","payable_minutes":60},{"date":"2026-09-09","payable_minutes":0},{"date":"2026-09-10","payable_minutes":0},{"date":"2026-09-11","payable_minutes":0},{"date":"2026-09-12","payable_minutes":0},{"date":"2026-09-13","payable_minutes":0}]},"meta":{"request_id":"11111111-1111-4111-8111-000000009999","generated_at":"2026-09-08T19:00:00Z","timezone":"America/Los_Angeles"}}}},"exampleType":"examples"}},"exampleType":"examples"},"ffce0f34-3232-415d-9552-9474b4b40c7f":{"description":"Malformed input, unknown query parameter, unsupported combination or invalid cursor.","headers":{"Cache-Control":{"schema":{"type":"string"},"example":"private, no-store"}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_REQUEST","INVALID_CURSOR","SCHEDULE_TOO_LARGE","INVALID_SCHEDULE_EVENT","SCHEDULE_CONFLICT","STALE_REVISION","IDEMPOTENCY_CONFLICT","UNAUTHENTICATED","NOT_FOUND","METHOD_NOT_ALLOWED","RATE_LIMITED","INTERNAL_ERROR"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message","request_id","details"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"INVALID_REQUEST","message":"end_date must be later than start_date","request_id":"example-request","details":[]}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INVALID_REQUEST","message":"end_date must be later than start_date","request_id":"example-request","details":[]}}}},"exampleType":"examples"}},"exampleType":"examples"},"91925c27-7af8-4d90-9a93-dce5ed5a1549":{"description":"Missing, invalid or expired key, or invalid linked identity.","headers":{"Cache-Control":{"schema":{"type":"string"},"example":"private, no-store"},"WWW-Authenticate":{"schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_REQUEST","INVALID_CURSOR","SCHEDULE_TOO_LARGE","INVALID_SCHEDULE_EVENT","SCHEDULE_CONFLICT","STALE_REVISION","IDEMPOTENCY_CONFLICT","UNAUTHENTICATED","NOT_FOUND","METHOD_NOT_ALLOWED","RATE_LIMITED","INTERNAL_ERROR"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message","request_id","details"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"UNAUTHENTICATED","message":"A valid API key is required","request_id":"example-request","details":[]}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"UNAUTHENTICATED","message":"A valid API key is required","request_id":"example-request","details":[]}}}},"exampleType":"examples"}},"exampleType":"examples"},"e4357bbc-0f0e-4a5c-ac80-0aeeafec2305":{"description":"Missing resource or resource outside the authenticated company. Same response for both.","headers":{"Cache-Control":{"schema":{"type":"string"},"example":"private, no-store"}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_REQUEST","INVALID_CURSOR","SCHEDULE_TOO_LARGE","INVALID_SCHEDULE_EVENT","SCHEDULE_CONFLICT","STALE_REVISION","IDEMPOTENCY_CONFLICT","UNAUTHENTICATED","NOT_FOUND","METHOD_NOT_ALLOWED","RATE_LIMITED","INTERNAL_ERROR"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message","request_id","details"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"NOT_FOUND","message":"Resource not found","request_id":"example-request","details":[]}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"NOT_FOUND","message":"Resource not found","request_id":"example-request","details":[]}}}},"exampleType":"examples"}},"exampleType":"examples"},"548d05d2-a6d0-4971-8172-b441078c5dc3":{"description":"Unsupported methods return 405. See the operation list for supported scheduling writes.","headers":{"Cache-Control":{"schema":{"type":"string"},"example":"private, no-store"},"Allow":{"schema":{"type":"string"},"example":"GET, HEAD, OPTIONS"}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_REQUEST","INVALID_CURSOR","SCHEDULE_TOO_LARGE","INVALID_SCHEDULE_EVENT","SCHEDULE_CONFLICT","STALE_REVISION","IDEMPOTENCY_CONFLICT","UNAUTHENTICATED","NOT_FOUND","METHOD_NOT_ALLOWED","RATE_LIMITED","INTERNAL_ERROR"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message","request_id","details"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"METHOD_NOT_ALLOWED","message":"This resource supports GET","request_id":"example-request","details":[]}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"METHOD_NOT_ALLOWED","message":"This resource supports GET","request_id":"example-request","details":[]}}}},"exampleType":"examples"}},"exampleType":"examples"},"1c3bbe93-1e61-4c71-b249-bb53ebe88c95":{"description":"Stale revision, idempotency-key reuse with different input, scheduling conflict, or unsupported stored recurrence. Inspect error.code.","headers":{"Cache-Control":{"schema":{"type":"string"},"example":"private, no-store"}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_REQUEST","INVALID_CURSOR","SCHEDULE_TOO_LARGE","INVALID_SCHEDULE_EVENT","SCHEDULE_CONFLICT","STALE_REVISION","IDEMPOTENCY_CONFLICT","UNAUTHENTICATED","NOT_FOUND","METHOD_NOT_ALLOWED","RATE_LIMITED","INTERNAL_ERROR"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message","request_id","details"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"STALE_REVISION","message":"The visit changed; read it again before editing","request_id":"example-request","details":[]}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"STALE_REVISION","message":"The visit changed; read it again before editing","request_id":"example-request","details":[]}}}},"exampleType":"examples"}},"exampleType":"examples"},"38423770-b5c8-47bd-80e5-db54494bc68f":{"description":"Request body is too large.","headers":{"Cache-Control":{"schema":{"type":"string"},"example":"private, no-store"}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_REQUEST","INVALID_CURSOR","SCHEDULE_TOO_LARGE","INVALID_SCHEDULE_EVENT","SCHEDULE_CONFLICT","STALE_REVISION","IDEMPOTENCY_CONFLICT","UNAUTHENTICATED","NOT_FOUND","METHOD_NOT_ALLOWED","RATE_LIMITED","INTERNAL_ERROR"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message","request_id","details"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"INVALID_REQUEST","message":"Request body exceeds 64 KB","request_id":"example-request","details":[]}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INVALID_REQUEST","message":"Request body exceeds 64 KB","request_id":"example-request","details":[]}}}},"exampleType":"examples"}},"exampleType":"examples"},"74871bdc-46e0-4fa5-b0fe-287a830c11fd":{"description":"Company request budget exhausted; retry after the indicated delay.","headers":{"Cache-Control":{"schema":{"type":"string"},"example":"private, no-store"},"Retry-After":{"schema":{"type":"integer","minimum":1},"description":"Seconds before retrying.","example":30}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_REQUEST","INVALID_CURSOR","SCHEDULE_TOO_LARGE","INVALID_SCHEDULE_EVENT","SCHEDULE_CONFLICT","STALE_REVISION","IDEMPOTENCY_CONFLICT","UNAUTHENTICATED","NOT_FOUND","METHOD_NOT_ALLOWED","RATE_LIMITED","INTERNAL_ERROR"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message","request_id","details"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"RATE_LIMITED","message":"Request limit exceeded","request_id":"example-request","details":[]}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"RATE_LIMITED","message":"Request limit exceeded","request_id":"example-request","details":[]}}}},"exampleType":"examples"}},"exampleType":"examples"},"74023670-775b-4571-822e-cce326ffec7c":{"description":"Unexpected failure. Share request_id with support; no stack or provider secrets in response.","headers":{"Cache-Control":{"schema":{"type":"string"},"example":"private, no-store"}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_REQUEST","INVALID_CURSOR","SCHEDULE_TOO_LARGE","INVALID_SCHEDULE_EVENT","SCHEDULE_CONFLICT","STALE_REVISION","IDEMPOTENCY_CONFLICT","UNAUTHENTICATED","NOT_FOUND","METHOD_NOT_ALLOWED","RATE_LIMITED","INTERNAL_ERROR"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message","request_id","details"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"INTERNAL_ERROR","message":"Unable to complete request","request_id":"example-request","details":[]}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INTERNAL_ERROR","message":"Unable to complete request","request_id":"example-request","details":[]}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"a8ba010c-8478-4dd0-9cd1-29498a7f0532":{"apiKey":{"type":"http","scheme":"bearer","description":"Existing Breezy API key. Grants all published reads and scheduling writes in its associated company. No app permission scopes.","scopes":[]}}},"servers":{"d4239c0d-e8dd-49f6-b7f4-2b5a3ad6583c":{"url":"https://api.getbreezyapp.com/v1","description":"Breezy FSM production API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Existing Breezy API key. Grants all published reads and scheduling writes in its associated company. No app permission scopes.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Existing Breezy API key. Grants all published reads and scheduling writes in its associated company. No app permission scopes.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"}]},"originalFileLocation":"openapi.json"},"subdomain":"breezy-fsm","siteName":"Breezy FSM API","title":"Breezy FSM API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-24T17:30:52.691Z","originalFileLocation":"api-reference/timesheets/read-one-member’s-configured-period-timesheet.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=\"Derived representation identified by team member and resolved period dates. Required period_date is a local calendar date. Includes a zero total when the member has no entries. Returns 400 for missing or unusable configuration and 404 for a missing or foreign member.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Breezy FSM API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/breezy-fsm/dnF4NhhH8j4iUnof/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/breezy-fsm/dnF4NhhH8j4iUnof/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/breezy-fsm/dnF4NhhH8j4iUnof/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/breezy-fsm/dnF4NhhH8j4iUnof/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/breezy-fsm/dnF4NhhH8j4iUnof/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/breezy-fsm/dnF4NhhH8j4iUnof/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/breezy-fsm/dnF4NhhH8j4iUnof/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/breezy-fsm/dnF4NhhH8j4iUnof/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/breezy-fsm/dnF4NhhH8j4iUnof/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Breezy FSM API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Scheduling and operational and financial reporting: resources, pagination, business measures, and examples.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Breezy FSM API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.getbreezyapp.com/api-reference/timesheets/read-one-member’s-configured-period-timesheet\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://breezy-fsm.mintlify.app/_mintlify/api/og/v2?division=Timesheets\u0026amp;title=Read+one+member%E2%80%99s+configured-period+timesheet\u0026amp;description=Derived+representation+identified+by+team+member+and+resolved+period+dates.+Required+period_date+is+a+local+calendar+date.+Includes+a+zero+total+when+the+member\u0026amp;theme=eaf35dcff08c044ed1225cc1\u0026amp;signature=80d4566d8c877f5f0c3af24332ab61b9d974211b4702d559b2f085558e70c68d\">\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=\"Breezy FSM API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Scheduling and operational and financial reporting: resources, pagination, business measures, and examples.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://breezy-fsm.mintlify.app/_mintlify/api/og/v2?division=Timesheets\u0026amp;title=Read+one+member%E2%80%99s+configured-period+timesheet\u0026amp;description=Derived+representation+identified+by+team+member+and+resolved+period+dates.+Required+period_date+is+a+local+calendar+date.+Includes+a+zero+total+when+the+member\u0026amp;theme=eaf35dcff08c044ed1225cc1\u0026amp;signature=80d4566d8c877f5f0c3af24332ab61b9d974211b4702d559b2f085558e70c68d\">\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=\"/mintlify-assets/_mintlify/favicons/breezy-fsm/dnF4NhhH8j4iUnof/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Breezy FSM API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0958D9\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.getbreezyapp.com/api-reference/timesheets/read-one-member’s-configured-period-timesheet\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/timesheets/read-one-member%E2%80%99s-configured-period-timesheet.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.getbreezyapp.com/#organization\",\"name\":\"Breezy FSM API\",\"url\":\"https://developers.getbreezyapp.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/breezy-fsm/oiZqxfHjJWgR4SxV/logo/breezy-light.svg?fit=max\u0026auto=format\u0026n=oiZqxfHjJWgR4SxV\u0026q=85\u0026s=0d4ab09c4ec7a4400a349d0f2977aab8\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.getbreezyapp.com#website\",\"name\":\"Breezy FSM API\",\"url\":\"https://developers.getbreezyapp.com\",\"publisher\":{\"@id\":\"https://developers.getbreezyapp.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.getbreezyapp.com/api-reference/timesheets/read-one-member%E2%80%99s-configured-period-timesheet#webpage\",\"url\":\"https://developers.getbreezyapp.com/api-reference/timesheets/read-one-member%E2%80%99s-configured-period-timesheet\",\"name\":\"Read one member’s configured-period timesheet\",\"description\":\"Derived representation identified by team member and resolved period dates. Required period_date is a local calendar date. Includes a zero total when the member has no entries. Returns 400 for missing or unusable configuration and 404 for a missing or foreign member.\",\"dateModified\":\"2026-09-24T17:30:52.691Z\",\"isPartOf\":{\"@id\":\"https://developers.getbreezyapp.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.getbreezyapp.com/api-reference/timesheets/read-one-member%E2%80%99s-configured-period-timesheet#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.getbreezyapp.com/api-reference/timesheets/read-one-member%E2%80%99s-configured-period-timesheet#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Timesheets\",\"item\":\"https://developers.getbreezyapp.com/api-reference/timesheets/page-members-in-a-configured-timesheet-period\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Read one member’s configured-period timesheet\",\"item\":\"https://developers.getbreezyapp.com/api-reference/timesheets/read-one-member%E2%80%99s-configured-period-timesheet\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.getbreezyapp.com/api-reference/timesheets/read-one-member%E2%80%99s-configured-period-timesheet#apireference\",\"headline\":\"Read one member’s configured-period timesheet\",\"name\":\"Read one member’s configured-period timesheet\",\"description\":\"Derived representation identified by team member and resolved period dates. Required period_date is a local calendar date. Includes a zero total when the member has no entries. Returns 400 for missing or unusable configuration and 404 for a missing or foreign member.\",\"url\":\"https://developers.getbreezyapp.com/api-reference/timesheets/read-one-member%E2%80%99s-configured-period-timesheet\",\"mainEntityOfPage\":{\"@id\":\"https://developers.getbreezyapp.com/api-reference/timesheets/read-one-member%E2%80%99s-configured-period-timesheet#webpage\"},\"dateModified\":\"2026-09-24T17:30:52.691Z\",\"publisher\":{\"@id\":\"https://developers.getbreezyapp.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.getbreezyapp.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Breezy FSM API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Breezy FSM API","nav":{"global":null,"tabs":[{"tab":"Start here","pages":[{"title":"Start here","href":"/quickstart"}]},{"tab":"Reporting guides","pages":[{"title":"Reporting guides","href":"/choose-your-data"}]},{"tab":"API reference","groups":[{"group":"Scheduling","pages":[{"title":"Read a complete operational schedule","deprecated":null,"version":null,"openapi":"/openapi.json get /schedule","href":"/api-reference/scheduling/read-a-complete-operational-schedule"},{"title":"Read members, arrival windows and calendar display bounds","deprecated":null,"version":null,"openapi":"/openapi.json get /schedule/settings","href":"/api-reference/scheduling/read-members-arrival-windows-and-calendar-display-bounds"},{"title":"Read one visit with all assignments and its write revision","deprecated":null,"version":null,"openapi":"/openapi.json get /schedule/appointments/{id}","href":"/api-reference/scheduling/read-one-visit-with-all-assignments-and-its-write-revision"},{"title":"Create a visit for an existing job","deprecated":null,"version":null,"openapi":"/openapi.json post /job-appointments","href":"/api-reference/scheduling/create-a-visit-for-an-existing-job"},{"title":"Edit or reschedule a visit and its assignments atomically","deprecated":null,"version":null,"openapi":"/openapi.json patch /job-appointments/{id}","href":"/api-reference/scheduling/edit-or-reschedule-a-visit-and-its-assignments-atomically"},{"title":"Add one technician to a visit","deprecated":null,"version":null,"openapi":"/openapi.json post /job-assignments","href":"/api-reference/scheduling/add-one-technician-to-a-visit"},{"title":"Remove one assignment while retaining the visit","deprecated":null,"version":null,"openapi":"/openapi.json delete /job-assignments/{id}","href":"/api-reference/scheduling/remove-one-assignment-while-retaining-the-visit"},{"title":"Move or reassign one technician without replacing the visit","deprecated":null,"version":null,"openapi":"/openapi.json patch /job-assignments/{id}","href":"/api-reference/scheduling/move-or-reassign-one-technician-without-replacing-the-visit"},{"title":"Cancel a visit and remove its assignments","deprecated":null,"version":null,"openapi":"/openapi.json post /job-appointments/{id}/cancel","href":"/api-reference/scheduling/cancel-a-visit-and-remove-its-assignments"}]},{"group":"Company","pages":[{"title":"Read the company associated with this key","deprecated":null,"version":null,"openapi":"/openapi.json get /company","href":"/api-reference/company/read-the-company-associated-with-this-key"}]},{"group":"Invoices","pages":[{"title":"Page complete invoices","deprecated":null,"version":null,"openapi":"/openapi.json get /invoices","href":"/api-reference/invoices/page-complete-invoices"},{"title":"Read one complete invoice","deprecated":null,"version":null,"openapi":"/openapi.json get /invoices/{invoice_id}","href":"/api-reference/invoices/read-one-complete-invoice"}]},{"group":"Payments","pages":[{"title":"Page payments with their invoice allocations","deprecated":null,"version":null,"openapi":"/openapi.json get /payments","href":"/api-reference/payments/page-payments-with-their-invoice-allocations"},{"title":"Read one payment","deprecated":null,"version":null,"openapi":"/openapi.json get /payments/{payment_id}","href":"/api-reference/payments/read-one-payment"}]},{"group":"Refunds","pages":[{"title":"Page refunds using their own occurrence dates","deprecated":null,"version":null,"openapi":"/openapi.json get /refunds","href":"/api-reference/refunds/page-refunds-using-their-own-occurrence-dates"},{"title":"Read one refund","deprecated":null,"version":null,"openapi":"/openapi.json get /refunds/{refund_id}","href":"/api-reference/refunds/read-one-refund"}]},{"group":"Reports","pages":[{"title":"Summarize invoice activity by issue date","deprecated":null,"version":null,"openapi":"/openapi.json get /reports/invoice-activity","href":"/api-reference/reports/summarize-invoice-activity-by-issue-date"},{"title":"Summarize successful payments and refunds","deprecated":null,"version":null,"openapi":"/openapi.json get /reports/collections","href":"/api-reference/reports/summarize-successful-payments-and-refunds"},{"title":"Read current account aging","deprecated":null,"version":null,"openapi":"/openapi.json get /reports/receivables-aging","href":"/api-reference/reports/read-current-account-aging"},{"title":"Summarize recorded job profitability","deprecated":null,"version":null,"openapi":"/openapi.json get /reports/job-profitability","href":"/api-reference/reports/summarize-recorded-job-profitability"},{"title":"Summarize full-job profitability for assigned members","deprecated":null,"version":null,"openapi":"/openapi.json get /reports/technician-participation-profitability","href":"/api-reference/reports/summarize-full-job-profitability-for-assigned-members"},{"title":"Summarize recorded sold and earned credits by member","deprecated":null,"version":null,"openapi":"/openapi.json get /reports/revenue-attribution","href":"/api-reference/reports/summarize-recorded-sold-and-earned-credits-by-member"}]},{"group":"TeamMembers","pages":[{"title":"Page team members","deprecated":null,"version":null,"openapi":"/openapi.json get /team-members","href":"/api-reference/teammembers/page-team-members"},{"title":"Read one team member","deprecated":null,"version":null,"openapi":"/openapi.json get /team-members/{id}","href":"/api-reference/teammembers/read-one-team-member"}]},{"group":"Accounts","pages":[{"title":"Page accounts","deprecated":null,"version":null,"openapi":"/openapi.json get /accounts","href":"/api-reference/accounts/page-accounts"},{"title":"Read one account","deprecated":null,"version":null,"openapi":"/openapi.json get /accounts/{id}","href":"/api-reference/accounts/read-one-account"}]},{"group":"Contacts","pages":[{"title":"Page contacts","deprecated":null,"version":null,"openapi":"/openapi.json get /contacts","href":"/api-reference/contacts/page-contacts"},{"title":"Read one contact","deprecated":null,"version":null,"openapi":"/openapi.json get /contacts/{id}","href":"/api-reference/contacts/read-one-contact"}]},{"group":"Locations","pages":[{"title":"Page locations","deprecated":null,"version":null,"openapi":"/openapi.json get /locations","href":"/api-reference/locations/page-locations"},{"title":"Read one location","deprecated":null,"version":null,"openapi":"/openapi.json get /locations/{id}","href":"/api-reference/locations/read-one-location"}]},{"group":"Jobs","pages":[{"title":"Page jobs","deprecated":null,"version":null,"openapi":"/openapi.json get /jobs","href":"/api-reference/jobs/page-jobs"},{"title":"Read one job","deprecated":null,"version":null,"openapi":"/openapi.json get /jobs/{id}","href":"/api-reference/jobs/read-one-job"}]},{"group":"JobAppointments","pages":[{"title":"Page job appointments","deprecated":null,"version":null,"openapi":"/openapi.json get /job-appointments","href":"/api-reference/jobappointments/page-job-appointments"},{"title":"Read one job appointment","deprecated":null,"version":null,"openapi":"/openapi.json get /job-appointments/{id}","href":"/api-reference/jobappointments/read-one-job-appointment"}]},{"group":"JobAssignments","pages":[{"title":"Page job assignments","deprecated":null,"version":null,"openapi":"/openapi.json get /job-assignments","href":"/api-reference/jobassignments/page-job-assignments"},{"title":"Read one job assignment","deprecated":null,"version":null,"openapi":"/openapi.json get /job-assignments/{id}","href":"/api-reference/jobassignments/read-one-job-assignment"}]},{"group":"BusinessUnits","pages":[{"title":"Page business units","deprecated":null,"version":null,"openapi":"/openapi.json get /business-units","href":"/api-reference/businessunits/page-business-units"},{"title":"Read one business unit","deprecated":null,"version":null,"openapi":"/openapi.json get /business-units/{id}","href":"/api-reference/businessunits/read-one-business-unit"}]},{"group":"JobTypes","pages":[{"title":"Page job types","deprecated":null,"version":null,"openapi":"/openapi.json get /job-types","href":"/api-reference/jobtypes/page-job-types"},{"title":"Read one job type","deprecated":null,"version":null,"openapi":"/openapi.json get /job-types/{id}","href":"/api-reference/jobtypes/read-one-job-type"}]},{"group":"JobClasses","pages":[{"title":"Page job classes","deprecated":null,"version":null,"openapi":"/openapi.json get /job-classes","href":"/api-reference/jobclasses/page-job-classes"},{"title":"Read one job class","deprecated":null,"version":null,"openapi":"/openapi.json get /job-classes/{id}","href":"/api-reference/jobclasses/read-one-job-class"}]},{"group":"JobLifecycles","pages":[{"title":"Page job lifecycles","deprecated":null,"version":null,"openapi":"/openapi.json get /job-lifecycles","href":"/api-reference/joblifecycles/page-job-lifecycles"},{"title":"Read one job lifecycle","deprecated":null,"version":null,"openapi":"/openapi.json get /job-lifecycles/{id}","href":"/api-reference/joblifecycles/read-one-job-lifecycle"}]},{"group":"LeadSources","pages":[{"title":"Page lead sources","deprecated":null,"version":null,"openapi":"/openapi.json get /lead-sources","href":"/api-reference/leadsources/page-lead-sources"},{"title":"Read one lead source","deprecated":null,"version":null,"openapi":"/openapi.json get /lead-sources/{id}","href":"/api-reference/leadsources/read-one-lead-source"}]},{"group":"Tags","pages":[{"title":"Page tags","deprecated":null,"version":null,"openapi":"/openapi.json get /tags","href":"/api-reference/tags/page-tags"},{"title":"Read one tag","deprecated":null,"version":null,"openapi":"/openapi.json get /tags/{id}","href":"/api-reference/tags/read-one-tag"}]},{"group":"Estimates","pages":[{"title":"Page estimates","deprecated":null,"version":null,"openapi":"/openapi.json get /estimates","href":"/api-reference/estimates/page-estimates"},{"title":"Read one estimate","deprecated":null,"version":null,"openapi":"/openapi.json get /estimates/{id}","href":"/api-reference/estimates/read-one-estimate"}]},{"group":"JobLeads","pages":[{"title":"Page job leads","deprecated":null,"version":null,"openapi":"/openapi.json get /job-leads","href":"/api-reference/jobleads/page-job-leads"},{"title":"Read one job lead","deprecated":null,"version":null,"openapi":"/openapi.json get /job-leads/{id}","href":"/api-reference/jobleads/read-one-job-lead"}]},{"group":"Equipment","pages":[{"title":"Page equipment","deprecated":null,"version":null,"openapi":"/openapi.json get /equipment","href":"/api-reference/equipment/page-equipment"},{"title":"Read one equipment","deprecated":null,"version":null,"openapi":"/openapi.json get /equipment/{id}","href":"/api-reference/equipment/read-one-equipment"}]},{"group":"FormResponses","pages":[{"title":"Page form responses","deprecated":null,"version":null,"openapi":"/openapi.json get /form-responses","href":"/api-reference/formresponses/page-form-responses"},{"title":"Read one form response","deprecated":null,"version":null,"openapi":"/openapi.json get /form-responses/{id}","href":"/api-reference/formresponses/read-one-form-response"}]},{"group":"TimeEntries","pages":[{"title":"Page recorded time entries","deprecated":null,"version":null,"openapi":"/openapi.json get /time-entries","href":"/api-reference/timeentries/page-recorded-time-entries"},{"title":"Read one time entry","deprecated":null,"version":null,"openapi":"/openapi.json get /time-entries/{id}","href":"/api-reference/timeentries/read-one-time-entry"}]},{"group":"Timesheets","pages":[{"title":"Page members in a configured timesheet period","description":"Required period_date selects a current configured company-local period. All current company members, including inactive and zero-entry members, ordered by member ID. Effective-start-in-period entries contribute; open, deleted, nonpayable and unknown-activity entries do not contribute payable minutes. Existing server timesheet rules use wall-clock minutes, cap days at 1439, and stop overnight spans at the end of their starting day. No payroll or costing calculation. Current configuration applies to historical dates. Cursor scope includes resolved boundaries.","deprecated":null,"version":null,"openapi":"/openapi.json get /timesheets","href":"/api-reference/timesheets/page-members-in-a-configured-timesheet-period"},{"title":"Read one member’s configured-period timesheet","deprecated":null,"version":null,"openapi":"/openapi.json get /timesheets/{team_member_id}","href":"/api-reference/timesheets/read-one-member’s-configured-period-timesheet"}]},{"group":"JobFinancials","pages":[{"title":"Page jobs with recorded costs and costing revenue","description":"One resource per owned job, identified by job ID and ordered by ID ascending. Complete saved costs, qualifying invoice facts and distinct assigned company members. Disabled or untracked costing has null totals while saved facts remain readable. Date filters refer to job creation or the company-local financial report date. No financial updated_since or snapshot.","deprecated":null,"version":null,"openapi":"/openapi.json get /job-financials","href":"/api-reference/jobfinancials/page-jobs-with-recorded-costs-and-costing-revenue"},{"title":"Read the recorded financials of one job","deprecated":null,"version":null,"openapi":"/openapi.json get /job-financials/{id}","href":"/api-reference/jobfinancials/read-the-recorded-financials-of-one-job"}]},{"group":"RevenueAttributions","pages":[{"title":"Page jobs with complete saved sold and earned credits","deprecated":null,"version":null,"openapi":"/openapi.json get /revenue-attributions","href":"/api-reference/revenueattributions/page-jobs-with-complete-saved-sold-and-earned-credits"},{"title":"Read the complete saved revenue credits of one job","deprecated":null,"version":null,"openapi":"/openapi.json get /revenue-attributions/{id}","href":"/api-reference/revenueattributions/read-the-complete-saved-revenue-credits-of-one-job"}]}]}]},"title":"Breezy FSM API","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bbp7I60D.js","utils-C3RIvJha.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DqD-vLt8.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B31Loprg.js","snippetPresets-DKpk-b8t.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Cj65AhOR.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BXtn5gcC.js","shallow-RY2b03Cp.js","getApiPlaygroundDisplay-B0jeiPk3.js","CodeSnippet-CYgBjjwn.js","CodeSnippets-DOngDrYB.js","Page-n7I5XbKb.js","getPastedJson-DRQbJx-T.js","icon-CQiQCicY.js","MethodPill-BKTLdNtu.js","DuplicateIcon-B9jpAdat.js","createIcon-DCddRrXv.js","DynamicMarkdown-a8hUKrw6.js","SectionHeading-eECVV2eH.js","axios-vUo_bRtp.js","Markdown--GF7ZIpf.js","clsx-DZLdJUrt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-2LoAhjKH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Zwc0ZncM.js"]}