{
"type": "https://brp.otark.team/errors/invalid_api_key",
"title": "Invalid API Key",
"status": 401
}
{
"type": "https://brp.otark.team/errors/insufficient_scopes",
"title": "Insufficient API Key Scopes",
"status": 403,
"detail": "Missing scope: customers:write. Please create a new API key with the required scopes."
}
{
"type": "https://brp.otark.team/errors/invalid_api_key",
"title": "Invalid API Key",
"status": 401
}
{
"type": "https://brp.otark.team/errors/insufficient_scopes",
"title": "Insufficient API Key Scopes",
"status": 403,
"detail": "Missing scope: customers:write. Please create a new API key with the required scopes."
}
The generating asset (only present when type is ppa and an asset is assigned)
Show child attributes
War diese Seite hilfreich?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Otark","colors":{"primary":"#2A3D6B","light":"#659CCF","dark":"#2A3D6B"},"logo":{"light":"https://mintcdn.com/otarkgmbh/xhAzCyAUS4guvN5Z/logo/light.svg?fit=max\u0026auto=format\u0026n=xhAzCyAUS4guvN5Z\u0026q=85\u0026s=249ae91335ccd7ecd647d66bfa3677fc","dark":"https://mintcdn.com/otarkgmbh/xhAzCyAUS4guvN5Z/logo/dark.svg?fit=max\u0026auto=format\u0026n=xhAzCyAUS4guvN5Z\u0026q=85\u0026s=67a2c4a73aed68d935d8a9af22305422"},"favicon":"https://mintcdn.com/otarkgmbh/xhAzCyAUS4guvN5Z/favicon.svg?fit=max\u0026auto=format\u0026n=xhAzCyAUS4guvN5Z\u0026q=85\u0026s=d9a22de5741385570c4bd695dcd1354f","appearance":{"default":"light","strict":true},"background":{"color":{"light":"#F9FAFB","dark":"#080808"}},"navbar":{"links":[{"href":"mailto:support@otark.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.otark.com"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/otark"}},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","default":true,"href":"customers/intro"},{"language":"de","href":"de/customers/intro"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"otarkgmbh","hasAudioNarration":false,"actualSubdomain":"otarkgmbh","customDomains":["docs.otark.com"],"gitSource":{"type":"github","owner":"otark-energy","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ab2345b18197827e7eab404","collectionId":"2116cb3b-9f6c-4151-be68-c450dbc2a9df","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ab2345b18197827e7eab404"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6ab2345b18197827e7eab404","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"en","tag":"BRP Connect","count":24},{"language":"de","tag":"BKV Connect","count":24},{"language":"en","tag":"Otark Platform","count":7},{"language":"de","tag":"Otark-Plattform","count":7},{"language":"en","tag":"Transactions","count":6},{"language":"de","tag":"Transactions","count":6},{"language":"en","tag":"Nominations","count":5},{"language":"de","tag":"Nominations","count":5},{"language":"en","tag":"SFTP","count":3},{"language":"en","tag":"Customer API","count":3},{"language":"en","tag":"Customers","count":3},{"language":"de","tag":"SFTP","count":3},{"language":"de","tag":"Kunden-API","count":3},{"language":"de","tag":"Customers","count":3},{"language":"en","tag":"BRP API","count":2},{"language":"en","tag":"Contracts","count":2},{"language":"de","tag":"BKV-API","count":2},{"language":"de","tag":"Contracts","count":2},{"language":"default","tag":"Otark-Plattform","count":2},{"language":"en","tag":"Webhooks","count":1},{"language":"de","tag":"Webhooks","count":1},{"language":"default","tag":"Assets","count":1},{"language":"default","tag":"Demands","count":1}]},"assistantConfig":{},"basePath":"","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":"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":"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":"billing-updated-9-15","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"de/brp/api/contracts/get-contract","slug":"/de/brp/api/contracts/get-contract","pageMetadata":{"title":"Get contract","description":"Retrieve a single contract by ID.\n\nRequired scope: `contracts:read`","deprecated":null,"version":null,"openapi":"/brp-openapi.yaml get /v1/contracts/{contract_id}","href":"/de/brp/api/contracts/get-contract","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Retrieve a single contract by ID.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Required scope: \", _jsx(_components.code, {\n children: \"contracts:read\"\n })]\n })]\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":"Get contract","description":"Retrieve a single contract by ID.\n\nRequired scope: `contracts:read`","deprecated":null,"version":null,"openapi":"/brp-openapi.yaml get /v1/contracts/{contract_id}","href":"/de/brp/api/contracts/get-contract","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getContract","summary":"Get contract","description":"Retrieve a single contract by ID.\n\nRequired scope: `contracts:read`","tags":["Contracts"],"security":["8cd4c38c-cde1-44b1-8e83-d5c60b032307"],"x-required-scopes":["contracts:read"],"parameters":["86620ddf-d9a0-4dc3-bc15-ba965031d10b"],"responses":{"200":"0d4c8fc7-629f-4be7-80d8-4f68d75ffd5b","401":"fcbef1a9-e9fb-4372-b299-ed2004a64660","403":"1bc1486c-3d8a-4128-b159-e2b2c0372784","404":"4364e08f-ff1f-429c-95eb-12335cf3fe9e"},"method":"get","type":"path","servers":["e8b6dd14-9e90-41f9-ba00-07444612346e"],"path":"/v1/contracts/{contract_id}","baseUrlOptions":["https://api.otark.energy"],"title":"Get contract","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"86620ddf-d9a0-4dc3-bc15-ba965031d10b":{"name":"contract_id","in":"path","required":true,"description":"Contract identifier","schema":{"type":"string","example":"con_a1b2c3d4","isRequired":true,"description":"Contract identifier","uniqueKey":"","typeLabel":"string"}}},"responses":{"0d4c8fc7-629f-4be7-80d8-4f68d75ffd5b":{"description":"Contract details","headers":{"x-ratelimit-limit":{"description":"Maximum number of requests allowed per window","schema":{"type":"integer","example":300}},"x-ratelimit-remaining":{"description":"Remaining requests in the current window","schema":{"type":"integer","example":299}},"x-ratelimit-reset":{"description":"Seconds until the rate limit window resets","schema":{"type":"integer","example":60}}},"content":{"application/json":{"schema":{"type":"object","description":"An energy contract. Contracts are polymorphic — the schema varies by `type`.","properties":{"id":{"type":"string","description":"Internal unique contract identifier","example":"con_a1b2c3d4","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"external_id":{"type":"string","description":"External reference identifier","example":"PPA-2025-0042","isRequired":true,"uniqueKey":"external_id","typeLabel":"string"},"type":{"type":"string","description":"Contract type","enum":["ppa","day_ahead","intraday"],"example":"ppa","isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"status":{"type":"string","description":"Contract status","enum":["pending","in_progress","completed"],"example":"in_progress","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"delivery_start":{"oneOf":[{"type":"string","format":"date-time","description":"ISO 8601 delivery start (UTC)","example":"2026-01-01T00:00:00Z","isRequired":true,"uniqueKey":"delivery_start.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"ISO 8601 delivery start (UTC)","example":"2026-01-01T00:00:00Z","isRequired":true,"uniqueKey":"delivery_start.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"delivery_start","typeLabel":"string\u003cdate-time> | null"},"delivery_end":{"oneOf":[{"type":"string","format":"date-time","description":"ISO 8601 delivery end (UTC)","example":"2026-03-31T23:45:00Z","isRequired":true,"uniqueKey":"delivery_end.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"ISO 8601 delivery end (UTC)","example":"2026-03-31T23:45:00Z","isRequired":true,"uniqueKey":"delivery_end.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"delivery_end","typeLabel":"string\u003cdate-time> | null"},"seller":{"type":"object","description":"A counterparty identified by EIC code","properties":{"name":{"type":"string","description":"Company or entity name","example":"GreenCo Energy BV","isRequired":true,"uniqueKey":"seller.name","typeLabel":"string"},"eic":{"type":"string","description":"EIC code (balance group)","example":"11YGREENENERGY-Z","isRequired":true,"uniqueKey":"seller.eic","typeLabel":"string"},"tso":{"type":"string","description":"TSO responsible for the balance group","enum":["DE_AMPRION","DE_TENNET","DE_TRANSNET_BW","DE_50HERTZ"],"example":"DE_TENNET","isRequired":true,"uniqueKey":"seller.tso","typeLabel":"enum\u003cstring>"}},"required":["name","eic","tso"],"isRequired":true,"uniqueKey":"seller","typeLabel":"object"},"buyer":{"type":"object","description":"A counterparty identified by EIC code","properties":{"name":{"type":"string","description":"Company or entity name","example":"GreenCo Energy BV","isRequired":true,"uniqueKey":"buyer.name","typeLabel":"string"},"eic":{"type":"string","description":"EIC code (balance group)","example":"11YGREENENERGY-Z","isRequired":true,"uniqueKey":"buyer.eic","typeLabel":"string"},"tso":{"type":"string","description":"TSO responsible for the balance group","enum":["DE_AMPRION","DE_TENNET","DE_TRANSNET_BW","DE_50HERTZ"],"example":"DE_TENNET","isRequired":true,"uniqueKey":"buyer.tso","typeLabel":"enum\u003cstring>"}},"required":["name","eic","tso"],"isRequired":true,"uniqueKey":"buyer","typeLabel":"object"},"created_at":{"oneOf":[{"type":"string","format":"date-time","description":"ISO 8601 creation timestamp","example":"2024-11-20T10:00:00Z","isRequired":true,"uniqueKey":"created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"ISO 8601 creation timestamp","example":"2024-11-20T10:00:00Z","isRequired":true,"uniqueKey":"created_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time> | null"},"ppa_type":{"oneOf":[{"type":"string","description":"PPA pricing/delivery type (only present when `type` is `ppa`)","enum":["forecasted","produced","consumed","baseload","shaped","peakload","indexed"],"example":"indexed","uniqueKey":"ppa_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"PPA pricing/delivery type (only present when `type` is `ppa`)","enum":["forecasted","produced","consumed","baseload","shaped","peakload","indexed"],"example":"indexed","uniqueKey":"ppa_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"ppa_type","typeLabel":"enum\u003cstring> | null"},"period":{"oneOf":[{"type":"string","description":"Contract period display name (only present when `type` is `ppa`)","example":"Q1-2026","uniqueKey":"period.oneOf.0","typeLabel":"string"},{"type":"null","description":"Contract period display name (only present when `type` is `ppa`)","example":"Q1-2026","uniqueKey":"period.oneOf.1","typeLabel":"null"}],"uniqueKey":"period","typeLabel":"string | null"},"delivery_profile":{"oneOf":[{"type":"string","description":"Delivery profile name (only present when `type` is `ppa`)","example":"ENWEX Solar 2026","uniqueKey":"delivery_profile.oneOf.0","typeLabel":"string"},{"type":"null","description":"Delivery profile name (only present when `type` is `ppa`)","example":"ENWEX Solar 2026","uniqueKey":"delivery_profile.oneOf.1","typeLabel":"null"}],"uniqueKey":"delivery_profile","typeLabel":"string | null"},"asset":{"type":"object","description":"The generating asset (only present when `type` is `ppa` and an asset is assigned)","required":["id","name","nominal_power","technology","tso"],"properties":{"id":{"type":"string","description":"Unique asset identifier","example":"ast_w1x2y3z4","isRequired":true,"uniqueKey":"asset.id","typeLabel":"string"},"name":{"type":"string","description":"Display name of the generating asset","example":"Zonnepark De Wilgen","isRequired":true,"uniqueKey":"asset.name","typeLabel":"string"},"nominal_power":{"type":"number","description":"Nominal power capacity in MW","example":25,"isRequired":true,"uniqueKey":"asset.nominal_power","typeLabel":"number"},"technology":{"type":"string","description":"Generation technology","enum":["solar","wind_onshore","wind_offshore"],"example":"solar","isRequired":true,"uniqueKey":"asset.technology","typeLabel":"enum\u003cstring>"},"tso":{"type":"string","description":"TSO responsible for the asset's grid connection","enum":["DE_AMPRION","DE_TENNET","DE_TRANSNET_BW","DE_50HERTZ"],"example":"DE_TENNET","isRequired":true,"uniqueKey":"asset.tso","typeLabel":"enum\u003cstring>"}},"uniqueKey":"asset","typeLabel":"object"}},"required":["id","external_id","type","status","delivery_start","delivery_end","seller","buyer","created_at"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"con_a1b2c3d4","external_id":"PPA-2025-0042","type":"ppa","status":"in_progress","delivery_start":"2026-01-01T00:00:00Z","delivery_end":"2026-03-31T23:45:00Z","seller":{"name":"GreenCo Energy BV","eic":"11YGREENENERGY-Z","tso":"DE_TENNET"},"buyer":{"name":"GreenCo Energy BV","eic":"11YGREENENERGY-Z","tso":"DE_TENNET"},"created_at":"2024-11-20T10:00:00Z","ppa_type":"indexed","period":"Q1-2026","delivery_profile":"ENWEX Solar 2026","asset":{"id":"ast_w1x2y3z4","name":"Zonnepark De Wilgen","nominal_power":25,"technology":"solar","tso":"DE_TENNET"}}}},"exampleType":"generated"}},"exampleType":"generated"},"fcbef1a9-e9fb-4372-b299-ed2004a64660":{"description":"Missing or invalid API key","content":{"application/problem+json":{"schema":{"type":"object","description":"Error response following [RFC 9457 — Problem Details for HTTP APIs](https://www.rfc-editor.org/rfc/rfc9457).","properties":{"type":{"type":"string","format":"uri","description":"Absolute URI identifying the problem class","example":"https://brp.otark.team/errors/balance_group_tso_not_enabled","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","description":"Short human-readable label (stable across occurrences of the same type)","example":"Balance Group TSO Not Enabled","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code","example":400,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"Human-readable explanation for this specific occurrence","example":"The requested TSO is not enabled for this balance group. Enable it via the balance group settings first.","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","description":"URI identifying the specific request","example":"/v1/customers/cust_r8s9t0u1","uniqueKey":"instance","typeLabel":"string"},"errors":{"type":"array","description":"Field-level validation errors (present on validation failures)","items":{"type":"object","description":"A single field-level validation error","properties":{"code":{"type":"string","description":"Machine-readable error code: `unknown_field`, `read_only_field`, `required`, `invalid_type`, `invalid_enum_value`, `invalid_format`, `invalid_literal`, `value_too_small`, `value_too_large`, or `validation_failed`","example":"invalid_enum_value","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable description of the issue","example":"Invalid enum value. Expected 'DE_AMPRION' | 'DE_TENNET' | 'DE_TRANSNET_BW' | 'DE_50HERTZ', received 'INVALID'","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"field":{"type":"string","description":"JSON path of the field that caused the error","example":"balance_group.tso","uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"required":["type","title","status"],"uniqueKey":"","typeLabel":"object"},"example":{"type":"https://brp.otark.team/errors/invalid_api_key","title":"Invalid API Key","status":401},"examples":{"Example":{"title":"Example","value":{"type":"https://brp.otark.team/errors/invalid_api_key","title":"Invalid API Key","status":401}}},"exampleType":"examples"}},"exampleType":"examples"},"1bc1486c-3d8a-4128-b159-e2b2c0372784":{"description":"API key lacks required scopes","content":{"application/problem+json":{"schema":{"type":"object","description":"Error response following [RFC 9457 — Problem Details for HTTP APIs](https://www.rfc-editor.org/rfc/rfc9457).","properties":{"type":{"type":"string","format":"uri","description":"Absolute URI identifying the problem class","example":"https://brp.otark.team/errors/balance_group_tso_not_enabled","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","description":"Short human-readable label (stable across occurrences of the same type)","example":"Balance Group TSO Not Enabled","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code","example":400,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"Human-readable explanation for this specific occurrence","example":"The requested TSO is not enabled for this balance group. Enable it via the balance group settings first.","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","description":"URI identifying the specific request","example":"/v1/customers/cust_r8s9t0u1","uniqueKey":"instance","typeLabel":"string"},"errors":{"type":"array","description":"Field-level validation errors (present on validation failures)","items":{"type":"object","description":"A single field-level validation error","properties":{"code":{"type":"string","description":"Machine-readable error code: `unknown_field`, `read_only_field`, `required`, `invalid_type`, `invalid_enum_value`, `invalid_format`, `invalid_literal`, `value_too_small`, `value_too_large`, or `validation_failed`","example":"invalid_enum_value","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable description of the issue","example":"Invalid enum value. Expected 'DE_AMPRION' | 'DE_TENNET' | 'DE_TRANSNET_BW' | 'DE_50HERTZ', received 'INVALID'","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"field":{"type":"string","description":"JSON path of the field that caused the error","example":"balance_group.tso","uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"required":["type","title","status"],"uniqueKey":"","typeLabel":"object"},"example":{"type":"https://brp.otark.team/errors/insufficient_scopes","title":"Insufficient API Key Scopes","status":403,"detail":"Missing scope: customers:write. Please create a new API key with the required scopes."},"examples":{"Example":{"title":"Example","value":{"type":"https://brp.otark.team/errors/insufficient_scopes","title":"Insufficient API Key Scopes","status":403,"detail":"Missing scope: customers:write. Please create a new API key with the required scopes."}}},"exampleType":"examples"}},"exampleType":"examples"},"4364e08f-ff1f-429c-95eb-12335cf3fe9e":{"description":"Resource does not exist or caller has no access","content":{"application/problem+json":{"schema":{"type":"object","description":"Error response following [RFC 9457 — Problem Details for HTTP APIs](https://www.rfc-editor.org/rfc/rfc9457).","properties":{"type":{"type":"string","format":"uri","description":"Absolute URI identifying the problem class","example":"https://brp.otark.team/errors/balance_group_tso_not_enabled","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","description":"Short human-readable label (stable across occurrences of the same type)","example":"Balance Group TSO Not Enabled","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code","example":400,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"Human-readable explanation for this specific occurrence","example":"The requested TSO is not enabled for this balance group. Enable it via the balance group settings first.","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","description":"URI identifying the specific request","example":"/v1/customers/cust_r8s9t0u1","uniqueKey":"instance","typeLabel":"string"},"errors":{"type":"array","description":"Field-level validation errors (present on validation failures)","items":{"type":"object","description":"A single field-level validation error","properties":{"code":{"type":"string","description":"Machine-readable error code: `unknown_field`, `read_only_field`, `required`, `invalid_type`, `invalid_enum_value`, `invalid_format`, `invalid_literal`, `value_too_small`, `value_too_large`, or `validation_failed`","example":"invalid_enum_value","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable description of the issue","example":"Invalid enum value. Expected 'DE_AMPRION' | 'DE_TENNET' | 'DE_TRANSNET_BW' | 'DE_50HERTZ', received 'INVALID'","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"field":{"type":"string","description":"JSON path of the field that caused the error","example":"balance_group.tso","uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"required":["type","title","status"],"uniqueKey":"","typeLabel":"object"},"example":{"type":"https://brp.otark.team/errors/customer_not_found","title":"Customer Not Found","status":404,"instance":"/v1/customers/cust_r8s9t0u1"},"examples":{"Example":{"title":"Example","value":{"type":"https://brp.otark.team/errors/customer_not_found","title":"Customer Not Found","status":404,"instance":"/v1/customers/cust_r8s9t0u1"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"8cd4c38c-cde1-44b1-8e83-d5c60b032307":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-Api-Key","scopes":[]}}},"servers":{"e8b6dd14-9e90-41f9-ba00-07444612346e":{"url":"https://api.otark.energy","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-Api-Key","scopes":[]},"schema":{"title":"X-Api-Key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"X-Api-Key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"brp-openapi.yaml"},"subdomain":"otarkgmbh","siteName":"Otark","title":"Get contract - Otark","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/brp/api/contracts/get-contract","matchLevel":1},"de":{"href":"/de/brp/api/contracts/get-contract","matchLevel":0}}},"lastModified":"2026-04-11T14:23:10.568Z","originalFileLocation":"de/brp/api/contracts/get-contract.mdx","locale":"de"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";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=\"light\"}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=\"Retrieve a single contract by ID. Required scope: contracts:read\">\u003cmeta data-mint-head name=\"application-name\" content=\"Otark\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/otarkgmbh/lQi-ThApZuNmjFZN/_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/otarkgmbh/lQi-ThApZuNmjFZN/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/otarkgmbh/lQi-ThApZuNmjFZN/_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/otarkgmbh/lQi-ThApZuNmjFZN/_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/otarkgmbh/lQi-ThApZuNmjFZN/_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/otarkgmbh/lQi-ThApZuNmjFZN/_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/otarkgmbh/lQi-ThApZuNmjFZN/_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/otarkgmbh/lQi-ThApZuNmjFZN/_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/otarkgmbh/lQi-ThApZuNmjFZN/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get contract - Otark\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve a single contract by ID. Required scope: contracts:read\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Otark\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.otark.com/de/brp/api/contracts/get-contract\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://otarkgmbh.mintlify.app/_mintlify/api/og/v2?division=Contracts\u0026amp;title=Get+contract\u0026amp;description=Retrieve+a+single+contract+by+ID.%0A%0ARequired+scope%3A+%60contracts%3Aread%60\u0026amp;theme=d98e9b8f4fbe93dd19a88fe6\u0026amp;signature=eb3fd78ff6e3980aa3ae9c1acacb777d8bf4eb72254566c88202c1fd6b55c3e9\">\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=\"Get contract - Otark\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve a single contract by ID. Required scope: contracts:read\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://otarkgmbh.mintlify.app/_mintlify/api/og/v2?division=Contracts\u0026amp;title=Get+contract\u0026amp;description=Retrieve+a+single+contract+by+ID.%0A%0ARequired+scope%3A+%60contracts%3Aread%60\u0026amp;theme=d98e9b8f4fbe93dd19a88fe6\u0026amp;signature=eb3fd78ff6e3980aa3ae9c1acacb777d8bf4eb72254566c88202c1fd6b55c3e9\">\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/otarkgmbh/lQi-ThApZuNmjFZN/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Otark\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2A3D6B\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.otark.com/de/brp/api/contracts/get-contract\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/de/brp/api/contracts/get-contract.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"de\" href=\"https://docs.otark.com/de/brp/api/contracts/get-contract\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.otark.com/brp/api/contracts/get-contract\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.otark.com/brp/api/contracts/get-contract\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.otark.com/#organization\",\"name\":\"Otark\",\"url\":\"https://docs.otark.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/otarkgmbh/xhAzCyAUS4guvN5Z/logo/light.svg?fit=max\u0026auto=format\u0026n=xhAzCyAUS4guvN5Z\u0026q=85\u0026s=249ae91335ccd7ecd647d66bfa3677fc\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.otark.com#website\",\"name\":\"Otark\",\"url\":\"https://docs.otark.com\",\"publisher\":{\"@id\":\"https://docs.otark.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.otark.com/de/brp/api/contracts/get-contract#webpage\",\"url\":\"https://docs.otark.com/de/brp/api/contracts/get-contract\",\"name\":\"Get contract\",\"description\":\"Retrieve a single contract by ID. Required scope: contracts:read\",\"dateModified\":\"2026-04-11T14:23:10.568Z\",\"isPartOf\":{\"@id\":\"https://docs.otark.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.otark.com/de/brp/api/contracts/get-contract#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.otark.com/de/brp/api/contracts/get-contract#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Contracts\",\"item\":\"https://docs.otark.com/de/brp/api/contracts/list-contracts\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get contract\",\"item\":\"https://docs.otark.com/de/brp/api/contracts/get-contract\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.otark.com/de/brp/api/contracts/get-contract#apireference\",\"headline\":\"Get contract\",\"name\":\"Get contract\",\"description\":\"Retrieve a single contract by ID. Required scope: contracts:read\",\"url\":\"https://docs.otark.com/de/brp/api/contracts/get-contract\",\"mainEntityOfPage\":{\"@id\":\"https://docs.otark.com/de/brp/api/contracts/get-contract#webpage\"},\"dateModified\":\"2026-04-11T14:23:10.568Z\",\"publisher\":{\"@id\":\"https://docs.otark.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.otark.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Otark\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Otark","nav":{"global":null,"languages":[{"language":"en","default":true,"pages":[{"title":"en","href":"/brp/api/contracts/get-contract"}]},{"language":"de","anchors":[{"anchor":"Otark-Plattform","icon":"square-terminal","pages":[{"title":"Otark-Plattform","href":"/de/customers/intro"}]},{"anchor":"BKV Connect","icon":"square-terminal","groups":[{"group":"BKV Connect","pages":[{"title":"Einführung für BKVs","sidebarTitle":"Einführung","href":"/de/brp/intro"}]},{"group":"SFTP","pages":[{"title":"SFTP-Server","href":"/de/brp/sftp-server"},{"title":"SFTP: Nominierungsdateiformate","sidebarTitle":"Dateiformate","href":"/de/brp/sftp-formats"},{"title":"SFTP: Nominierungsdateibeispiele","sidebarTitle":"Dateibeispiele","href":"/de/brp/sftp-examples"}]},{"group":"Webhooks","pages":[{"title":"BKV-Webhooks","sidebarTitle":"Webhooks","href":"/de/brp/webhooks"}]},{"group":"BKV-API","pages":[{"title":"BKV-API: Einführung","sidebarTitle":"Einführung","href":"/de/brp/api"},{"title":"BKV-API: Konventionen","sidebarTitle":"Konventionen","href":"/de/brp/api-conventions"}]},{"group":"Contracts","pages":[{"title":"List contracts","description":"List contracts accessible to the authenticated BRP. Supports filtering by status, type, EIC code, delivery period, and active date.\n\nRequired scope: `contracts:read`","deprecated":null,"version":null,"openapi":"/brp-openapi.yaml get /v1/contracts","href":"/de/brp/api/contracts/list-contracts"},{"title":"Get contract","deprecated":null,"version":null,"openapi":"/brp-openapi.yaml get /v1/contracts/{contract_id}","href":"/de/brp/api/contracts/get-contract"}]},{"group":"Transactions","pages":[{"title":"List contract transactions","description":"List transactions under a specific contract. Same filters as the global transactions endpoint, minus `contract_id` and `type`.\n\nRequired scopes: `contracts:read`, `transactions:read`","deprecated":null,"version":null,"openapi":"/brp-openapi.yaml get /v1/contracts/{contract_id}/transactions","href":"/de/brp/api/transactions/list-contract-transactions"},{"title":"List all transactions","deprecated":null,"version":null,"openapi":"/brp-openapi.yaml get /v1/transactions","href":"/de/brp/api/transactions/list-all-transactions"},{"title":"Get transaction","deprecated":null,"version":null,"openapi":"/brp-openapi.yaml get /v1/transactions/{transaction_id}","href":"/de/brp/api/transactions/get-transaction"},{"title":"Get transaction history","deprecated":null,"version":null,"openapi":"/brp-openapi.yaml get /v1/transactions/{transaction_id}/history","href":"/de/brp/api/transactions/get-transaction-history"},{"title":"Bulk get transactions","deprecated":null,"version":null,"openapi":"/brp-openapi.yaml get /v1/transactions/bulk","href":"/de/brp/api/transactions/bulk-get-transactions"},{"title":"Bulk get transactions (POST)","deprecated":null,"version":null,"openapi":"/brp-openapi.yaml post /v1/transactions/bulk","href":"/de/brp/api/transactions/bulk-get-transactions-post"}]},{"group":"Nominations","pages":[{"title":"List nominations","deprecated":null,"version":null,"openapi":"/brp-openapi.yaml get /v1/nominations","href":"/de/brp/api/nominations/list-nominations"},{"title":"Get nomination","deprecated":null,"version":null,"openapi":"/brp-openapi.yaml get /v1/nominations/{nomination_id}","href":"/de/brp/api/nominations/get-nomination"},{"title":"Get nomination history","deprecated":null,"version":null,"openapi":"/brp-openapi.yaml get /v1/nominations/{nomination_id}/history","href":"/de/brp/api/nominations/get-nomination-history"},{"title":"Bulk get nominations","deprecated":null,"version":null,"openapi":"/brp-openapi.yaml get /v1/nominations/bulk","href":"/de/brp/api/nominations/bulk-get-nominations"},{"title":"Bulk get nominations (POST)","deprecated":null,"version":null,"openapi":"/brp-openapi.yaml post /v1/nominations/bulk","href":"/de/brp/api/nominations/bulk-get-nominations-post"}]},{"group":"Customers","pages":[{"title":"List customers","deprecated":null,"version":null,"openapi":"/brp-openapi.yaml get /v1/customers","href":"/de/brp/api/customers/list-customers"},{"title":"Get customer","deprecated":null,"version":null,"openapi":"/brp-openapi.yaml get /v1/customers/{customer_id}","href":"/de/brp/api/customers/get-customer"},{"title":"Update customer","deprecated":null,"version":null,"openapi":"/brp-openapi.yaml patch /v1/customers/{customer_id}","href":"/de/brp/api/customers/update-customer"}]}]}]}]},"title":"Get contract - Otark","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","Page-CBCH2P7b.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","clsx-Cs6nMGht.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-zbf22OZA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C_fs-y5n.js"]}