(Delivery · object | Material Creation · object | Material Processing · object | Material Application · object)[]
required
Delivery
Material Creation
Material Processing
Material Application
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Cula Docs","colors":{"primary":"#3772FF","light":"#6593FF","dark":"#1C3B84"},"logo":{"light":"https://mintcdn.com/culatechnologies/VBk50tt2s0Ltfxst/images/logo-dark.svg?fit=max\u0026auto=format\u0026n=VBk50tt2s0Ltfxst\u0026q=85\u0026s=461159ff3d23c746d71402d2feecf532","dark":"https://mintcdn.com/culatechnologies/VBk50tt2s0Ltfxst/images/logo-light.svg?fit=max\u0026auto=format\u0026n=VBk50tt2s0Ltfxst\u0026q=85\u0026s=66a21b9dc3090bdcf34e0d79ff9c3846"},"favicon":"https://mintcdn.com/culatechnologies/VBk50tt2s0Ltfxst/images/logo-dark.svg?fit=max\u0026auto=format\u0026n=VBk50tt2s0Ltfxst\u0026q=85\u0026s=461159ff3d23c746d71402d2feecf532","footer":{"socials":{"website":"https://cula.tech","linkedin":"https://www.linkedin.com/company/cula-technologies"}},"contextual":{"options":["copy","view","chatgpt","claude","download-spec"],"display":"header"},"interaction":{"drilldown":false},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"culatechnologies","hasAudioNarration":false,"actualSubdomain":"culatechnologies","customDomains":["docs.cula.tech"],"gitSource":{"type":"github","owner":"cula-technologies","repo":"cula-platform","deployBranch":"main","contentDirectory":"public-docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adf8972d13963272de949d8","collectionId":"d64c3bdf-da31-43be-aa1c-8d0130504c12","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adf8972d13963272de949d8"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{},"buildId":"6ae4bd45f0f0e506e2343d4c","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"API Reference","count":84},{"language":"default","tag":"Material Tracking","count":52},{"language":"default","tag":"General","count":16},{"language":"default","tag":"Machine Data","count":16},{"language":"default","tag":"Guides","count":14},{"language":"default","tag":"Deliveries","count":11},{"language":"default","tag":"Material Batches","count":11},{"language":"default","tag":"Machine Data Annotations","count":7},{"language":"default","tag":"Material Conversions","count":7},{"language":"default","tag":"Material Sourcings","count":7}]},"assistantConfig":{"enableStarterQuestions":false},"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":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/sinks/get-a-sink","slug":"/api-reference/sinks/get-a-sink","pageMetadata":{"title":"Get a sink","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json get /sinks/{id}","href":"/api-reference/sinks/get-a-sink","autogeneratedByOpenApi":true},"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 a sink","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json get /sinks/{id}","href":"/api-reference/sinks/get-a-sink","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"parameters":["58c1b302-7bea-47a5-920d-cc3ca2c6da1a","dd8fc06c-a2e4-435b-84c0-326435e2ae66"],"responses":{"200":"494e2886-2d17-4b1f-b7d7-d0292933f5e3","400":"b60e1068-4db0-4704-bef5-d329bbd7d6be","401":"4dcfb399-f9f0-49ba-9bc0-77a371fc6963","404":"3a359b91-b27c-4c5d-a5a8-c0bfc4b30816","429":"771226d0-df06-478f-99ef-9c41820077ac","500":"e90f4de0-4572-4570-9a1e-d8562aa02625"},"security":["527c3fe4-6832-425b-acde-3969ffb4a8b8"],"summary":"Get a sink","tags":["Sinks"],"method":"get","type":"path","servers":["66bbfecc-695b-4944-9986-0e06121643e7"],"path":"/sinks/{id}","baseUrlOptions":["https://api.demo.cula.earth/tracking/v1"],"title":"Get a sink","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"58c1b302-7bea-47a5-920d-cc3ca2c6da1a":{"name":"Cula-Organisation-Id","in":"header","description":"ID of the organisation the request operates on behalf of (e.g. `org_...`). Must be an organisation the API client has access to.","required":true,"schema":{"type":"string","example":"org_01k83mfmhgchya944v86ryvhpq","isRequired":true,"description":"ID of the organisation the request operates on behalf of (e.g. `org_...`). Must be an organisation the API client has access to.","uniqueKey":"","typeLabel":"string"}},"dd8fc06c-a2e4-435b-84c0-326435e2ae66":{"name":"id","required":true,"in":"path","schema":{"type":"string","example":"snk_01kpb4n7arexs9cjf0ffmdtjry","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"494e2886-2d17-4b1f-b7d7-d0292933f5e3":{"description":"Sink with tracking steps","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"snk_01kpb4n7arexs9cjf0ffmdtjry","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"owner_organisation_id":{"type":"string","example":"org_01k83mfmhgchya944v86ryvhpq","isRequired":true,"uniqueKey":"owner_organisation_id","typeLabel":"string"},"public_url":{"type":"string","format":"uri","description":"Public URL to view the sink on the Cula Carbon Hub.","example":"https://hub.cula.earth/globe/sink?id=snk_01kpb4n7arexs9cjf0ffmdtjry","isRequired":true,"uniqueKey":"public_url","typeLabel":"string\u003curi>"},"tracked_gross_co2e_removal_in_kg":{"type":"number","minimum":0,"example":6000.5,"isRequired":true,"uniqueKey":"tracked_gross_co2e_removal_in_kg","typeLabel":"number"},"tracked_net_co2e_removal_in_kg":{"type":"number","minimum":0,"example":5874.3,"isRequired":true,"uniqueKey":"tracked_net_co2e_removal_in_kg","typeLabel":"number"},"verified_net_co2e_removal_in_kg":{"oneOf":[{"type":"number","minimum":0,"example":5874.3,"isRequired":true,"uniqueKey":"verified_net_co2e_removal_in_kg.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"example":5874.3,"isRequired":true,"uniqueKey":"verified_net_co2e_removal_in_kg.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"verified_net_co2e_removal_in_kg","typeLabel":"number | null"},"registry_reference":{"oneOf":[{"type":"object","required":["registry_type","id","url"],"properties":{"registry_type":{"type":"string","enum":["csi","puro","isometric","rainbow","internal"],"example":"csi","isRequired":true,"uniqueKey":"registry_reference.oneOf.0.registry_type","typeLabel":"enum\u003cstring>"},"id":{"oneOf":[{"type":"string","example":"1234","isRequired":true,"uniqueKey":"registry_reference.oneOf.0.id.oneOf.0","typeLabel":"string"},{"type":"null","example":"1234","isRequired":true,"uniqueKey":"registry_reference.oneOf.0.id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"registry_reference.oneOf.0.id","typeLabel":"string | null"},"url":{"oneOf":[{"type":"string","format":"uri","example":"https://example.com?id=1234","isRequired":true,"uniqueKey":"registry_reference.oneOf.0.url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","example":"https://example.com?id=1234","isRequired":true,"uniqueKey":"registry_reference.oneOf.0.url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"registry_reference.oneOf.0.url","typeLabel":"string\u003curi> | null"}},"isRequired":true,"uniqueKey":"registry_reference.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"registry_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"registry_reference","typeLabel":"object | null"},"confirmation_document_id":{"oneOf":[{"type":"string","example":"doc_01kw9grq4tecva35wdpstzcj5z","isRequired":true,"uniqueKey":"confirmation_document_id.oneOf.0","typeLabel":"string"},{"type":"null","example":"doc_01kw9grq4tecva35wdpstzcj5z","isRequired":true,"uniqueKey":"confirmation_document_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"confirmation_document_id","typeLabel":"string | null"},"verified_at":{"oneOf":[{"type":"string","format":"date-time","description":"The day the removal was verified by the registry. Day-granular, so the time component is always midnight UTC.","example":"2025-10-10T00:00:00Z","isRequired":true,"uniqueKey":"verified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The day the removal was verified by the registry. Day-granular, so the time component is always midnight UTC.","example":"2025-10-10T00:00:00Z","isRequired":true,"uniqueKey":"verified_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"verified_at","typeLabel":"string\u003cdate-time> | null"},"created_at":{"type":"string","format":"date-time","example":"2025-10-10T21:03:58Z","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"material_application_tracking_step_id":{"type":"string","example":"stp_01kvv8692rjmch08b3e7hgdx3h","isRequired":true,"uniqueKey":"material_application_tracking_step_id","typeLabel":"string"},"tracking_steps":{"type":"array","items":{"oneOf":[{"type":"object","title":"Delivery","required":["id","previous_step_ids","document_ids","contribution_factor","created_at","type","source_site_id","target_site_id","transported_weight_in_kg","transportation_distance_in_km","transported_material_amounts"],"properties":{"id":{"type":"string","example":"stp_01k2rkq2yav2zev1b6f2ngzkqv","isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.0.id","typeLabel":"string"},"previous_step_ids":{"type":"array","items":{"type":"string","example":"xxx_01kwbp54c7fetvvct89ayajq31","uniqueKey":"tracking_steps.items.[INDEX].oneOf.0.previous_step_ids.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.0.previous_step_ids","typeLabel":"string[]"},"document_ids":{"type":"array","items":{"type":"string","example":"xxx_01kwbp54c7fetvvct89ayajq31","uniqueKey":"tracking_steps.items.[INDEX].oneOf.0.document_ids.items.[INDEX]","typeLabel":"string"},"description":"IDs of public documents attached to this step as evidence.","isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.0.document_ids","typeLabel":"string[]"},"contribution_factor":{"type":"number","description":"Fraction used to apportion emissions.","example":1,"isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.0.contribution_factor","typeLabel":"number"},"created_at":{"type":"string","format":"date-time","example":"2025-10-10T21:03:58Z","isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.0.created_at","typeLabel":"string\u003cdate-time>"},"type":{"type":"string","enum":["delivery"],"isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"source_site_id":{"type":"string","example":"ste_01k4ns532ex9pqr73mk97ph7jw","isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.0.source_site_id","typeLabel":"string"},"target_site_id":{"type":"string","example":"ste_01kncbmwc6ehhd7as62a8ezp1g","isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.0.target_site_id","typeLabel":"string"},"transported_weight_in_kg":{"type":"number","minimum":0,"example":2100,"isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.0.transported_weight_in_kg","typeLabel":"number"},"transportation_distance_in_km":{"type":"number","minimum":0,"example":42,"isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.0.transportation_distance_in_km","typeLabel":"number"},"transported_material_amounts":{"type":"array","items":{"type":"object","properties":{"material_name":{"type":"string","example":"EBC AgroBio","isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.0.transported_material_amounts.items.[INDEX].material_name","typeLabel":"string"},"weight_in_kg":{"type":"number","minimum":0,"example":600,"isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.0.transported_material_amounts.items.[INDEX].weight_in_kg","typeLabel":"number"}},"required":["material_name","weight_in_kg"],"uniqueKey":"tracking_steps.items.[INDEX].oneOf.0.transported_material_amounts.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.0.transported_material_amounts","typeLabel":"object[]"}},"uniqueKey":"tracking_steps.items.[INDEX].oneOf.0","typeLabel":"Delivery · object"},{"type":"object","title":"Material Creation","required":["id","previous_step_ids","document_ids","contribution_factor","created_at","type","site_id","output_material_amounts"],"properties":{"id":{"type":"string","example":"stp_01k2rkq2yav2zev1b6f2ngzkqv","isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.1.id","typeLabel":"string"},"previous_step_ids":{"type":"array","items":{"type":"string","example":"xxx_01kwbp54c7fetvvct89ayajq31","uniqueKey":"tracking_steps.items.[INDEX].oneOf.1.previous_step_ids.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.1.previous_step_ids","typeLabel":"string[]"},"document_ids":{"type":"array","items":{"type":"string","example":"xxx_01kwbp54c7fetvvct89ayajq31","uniqueKey":"tracking_steps.items.[INDEX].oneOf.1.document_ids.items.[INDEX]","typeLabel":"string"},"description":"IDs of public documents attached to this step as evidence.","isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.1.document_ids","typeLabel":"string[]"},"contribution_factor":{"type":"number","description":"Fraction used to apportion emissions.","example":1,"isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.1.contribution_factor","typeLabel":"number"},"created_at":{"type":"string","format":"date-time","example":"2025-10-10T21:03:58Z","isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.1.created_at","typeLabel":"string\u003cdate-time>"},"type":{"type":"string","enum":["material_creation"],"isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"site_id":{"type":"string","example":"ste_01k8g7aec6dt5zrtamc72ww446","isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.1.site_id","typeLabel":"string"},"output_material_amounts":{"type":"array","items":{"type":"object","properties":{"material_name":{"type":"string","example":"EBC AgroBio","isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.1.output_material_amounts.items.[INDEX].material_name","typeLabel":"string"},"weight_in_kg":{"type":"number","minimum":0,"example":600,"isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.1.output_material_amounts.items.[INDEX].weight_in_kg","typeLabel":"number"}},"required":["material_name","weight_in_kg"],"uniqueKey":"tracking_steps.items.[INDEX].oneOf.1.output_material_amounts.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.1.output_material_amounts","typeLabel":"object[]"}},"uniqueKey":"tracking_steps.items.[INDEX].oneOf.1","typeLabel":"Material Creation · object"},{"type":"object","title":"Material Processing","required":["id","previous_step_ids","document_ids","contribution_factor","created_at","type","site_id","input_material_amounts","output_material_amounts"],"properties":{"id":{"type":"string","example":"stp_01k2rkq2yav2zev1b6f2ngzkqv","isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.2.id","typeLabel":"string"},"previous_step_ids":{"type":"array","items":{"type":"string","example":"xxx_01kwbp54c7fetvvct89ayajq31","uniqueKey":"tracking_steps.items.[INDEX].oneOf.2.previous_step_ids.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.2.previous_step_ids","typeLabel":"string[]"},"document_ids":{"type":"array","items":{"type":"string","example":"xxx_01kwbp54c7fetvvct89ayajq31","uniqueKey":"tracking_steps.items.[INDEX].oneOf.2.document_ids.items.[INDEX]","typeLabel":"string"},"description":"IDs of public documents attached to this step as evidence.","isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.2.document_ids","typeLabel":"string[]"},"contribution_factor":{"type":"number","description":"Fraction used to apportion emissions.","example":1,"isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.2.contribution_factor","typeLabel":"number"},"created_at":{"type":"string","format":"date-time","example":"2025-10-10T21:03:58Z","isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.2.created_at","typeLabel":"string\u003cdate-time>"},"type":{"type":"string","enum":["material_processing"],"isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"site_id":{"type":"string","example":"ste_01k4ns532ex9pqr73mk97ph7jw","isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.2.site_id","typeLabel":"string"},"input_material_amounts":{"type":"array","items":{"type":"object","properties":{"material_name":{"type":"string","example":"EBC AgroBio","isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.2.input_material_amounts.items.[INDEX].material_name","typeLabel":"string"},"weight_in_kg":{"type":"number","minimum":0,"example":600,"isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.2.input_material_amounts.items.[INDEX].weight_in_kg","typeLabel":"number"}},"required":["material_name","weight_in_kg"],"uniqueKey":"tracking_steps.items.[INDEX].oneOf.2.input_material_amounts.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.2.input_material_amounts","typeLabel":"object[]"},"output_material_amounts":{"type":"array","items":{"type":"object","properties":{"material_name":{"type":"string","example":"EBC AgroBio","isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.2.output_material_amounts.items.[INDEX].material_name","typeLabel":"string"},"weight_in_kg":{"type":"number","minimum":0,"example":600,"isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.2.output_material_amounts.items.[INDEX].weight_in_kg","typeLabel":"number"}},"required":["material_name","weight_in_kg"],"uniqueKey":"tracking_steps.items.[INDEX].oneOf.2.output_material_amounts.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.2.output_material_amounts","typeLabel":"object[]"}},"uniqueKey":"tracking_steps.items.[INDEX].oneOf.2","typeLabel":"Material Processing · object"},{"type":"object","title":"Material Application","required":["id","previous_step_ids","document_ids","contribution_factor","created_at","type","site_id","input_material_amounts","application_description","end_user_name"],"properties":{"id":{"type":"string","example":"stp_01k2rkq2yav2zev1b6f2ngzkqv","isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.3.id","typeLabel":"string"},"previous_step_ids":{"type":"array","items":{"type":"string","example":"xxx_01kwbp54c7fetvvct89ayajq31","uniqueKey":"tracking_steps.items.[INDEX].oneOf.3.previous_step_ids.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.3.previous_step_ids","typeLabel":"string[]"},"document_ids":{"type":"array","items":{"type":"string","example":"xxx_01kwbp54c7fetvvct89ayajq31","uniqueKey":"tracking_steps.items.[INDEX].oneOf.3.document_ids.items.[INDEX]","typeLabel":"string"},"description":"IDs of public documents attached to this step as evidence.","isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.3.document_ids","typeLabel":"string[]"},"contribution_factor":{"type":"number","description":"Fraction used to apportion emissions.","example":1,"isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.3.contribution_factor","typeLabel":"number"},"created_at":{"type":"string","format":"date-time","example":"2025-10-10T21:03:58Z","isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.3.created_at","typeLabel":"string\u003cdate-time>"},"type":{"type":"string","enum":["material_application"],"isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"site_id":{"type":"string","example":"ste_01kncbmwc6ehhd7as62a8ezp1g","isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.3.site_id","typeLabel":"string"},"input_material_amounts":{"type":"array","items":{"type":"object","properties":{"material_name":{"type":"string","example":"EBC AgroBio","isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.3.input_material_amounts.items.[INDEX].material_name","typeLabel":"string"},"weight_in_kg":{"type":"number","minimum":0,"example":600,"isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.3.input_material_amounts.items.[INDEX].weight_in_kg","typeLabel":"number"}},"required":["material_name","weight_in_kg"],"uniqueKey":"tracking_steps.items.[INDEX].oneOf.3.input_material_amounts.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.3.input_material_amounts","typeLabel":"object[]"},"application_description":{"type":"string","example":"Agricultural soil","isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.3.application_description","typeLabel":"string"},"end_user_name":{"type":"string","example":"Poll GbR","isRequired":true,"uniqueKey":"tracking_steps.items.[INDEX].oneOf.3.end_user_name","typeLabel":"string"}},"uniqueKey":"tracking_steps.items.[INDEX].oneOf.3","typeLabel":"Material Application · object"}],"uniqueKey":"tracking_steps.items.[INDEX]","typeLabel":"Delivery · object | Material Creation · object | Material Processing · object | Material Application · object"},"isRequired":true,"uniqueKey":"tracking_steps","typeLabel":"(Delivery · object | Material Creation · object | Material Processing · object | Material Application · object)[]"}},"required":["id","owner_organisation_id","public_url","tracked_gross_co2e_removal_in_kg","tracked_net_co2e_removal_in_kg","verified_net_co2e_removal_in_kg","registry_reference","confirmation_document_id","verified_at","created_at","material_application_tracking_step_id","tracking_steps"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"snk_01kpb4n7arexs9cjf0ffmdtjry","owner_organisation_id":"org_01k83mfmhgchya944v86ryvhpq","public_url":"https://hub.cula.earth/globe/sink?id=snk_01kpb4n7arexs9cjf0ffmdtjry","tracked_gross_co2e_removal_in_kg":6000.5,"tracked_net_co2e_removal_in_kg":5874.3,"verified_net_co2e_removal_in_kg":5874.3,"registry_reference":{"registry_type":"csi","id":"1234","url":"https://example.com?id=1234"},"confirmation_document_id":"doc_01kw9grq4tecva35wdpstzcj5z","verified_at":"2025-10-10T00:00:00Z","created_at":"2025-10-10T21:03:58Z","material_application_tracking_step_id":"stp_01kvv8692rjmch08b3e7hgdx3h","tracking_steps":[{"id":"stp_01k2rkq2yav2zev1b6f2ngzkqv","previous_step_ids":["xxx_01kwbp54c7fetvvct89ayajq31"],"document_ids":["xxx_01kwbp54c7fetvvct89ayajq31"],"contribution_factor":1,"created_at":"2025-10-10T21:03:58Z","type":"delivery","source_site_id":"ste_01k4ns532ex9pqr73mk97ph7jw","target_site_id":"ste_01kncbmwc6ehhd7as62a8ezp1g","transported_weight_in_kg":2100,"transportation_distance_in_km":42,"transported_material_amounts":[{"material_name":"EBC AgroBio","weight_in_kg":600}]}]}}},"exampleType":"generated"}},"exampleType":"generated"},"b60e1068-4db0-4704-bef5-d329bbd7d6be":{"description":"Invalid request payload or parameters.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","example":"bad_request","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","example":"The field limit must not be greater than 50.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"","typeLabel":"object"},"example":{"code":"bad_request","message":"The field limit must not be greater than 50."},"examples":{"Example":{"title":"Example","value":{"code":"bad_request","message":"The field limit must not be greater than 50."}}},"exampleType":"examples"}},"exampleType":"examples"},"4dcfb399-f9f0-49ba-9bc0-77a371fc6963":{"description":"Missing or invalid access token.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","example":"bad_request","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","example":"The field limit must not be greater than 50.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"","typeLabel":"object"},"example":{"code":"unauthorized","message":"Invalid or expired token"},"examples":{"Example":{"title":"Example","value":{"code":"unauthorized","message":"Invalid or expired token"}}},"exampleType":"examples"}},"exampleType":"examples"},"3a359b91-b27c-4c5d-a5a8-c0bfc4b30816":{"description":"Object not found.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","example":"bad_request","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","example":"The field limit must not be greater than 50.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"","typeLabel":"object"},"example":{"code":"not_found","message":"Object with ID xyz_01k56g7aec6dt5zrtamc72vw446 could not be found."},"examples":{"Example":{"title":"Example","value":{"code":"not_found","message":"Object with ID xyz_01k56g7aec6dt5zrtamc72vw446 could not be found."}}},"exampleType":"examples"}},"exampleType":"examples"},"771226d0-df06-478f-99ef-9c41820077ac":{"description":"The API client sent more requests than its limit allows. Try again after the time given in the `Retry-After` header.","headers":{"Retry-After":{"description":"Seconds until the API client can send requests again.","schema":{"type":"integer","example":42}}},"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","example":"bad_request","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","example":"The field limit must not be greater than 50.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"","typeLabel":"object"},"example":{"code":"too_many_requests","message":"Too many requests. Try again after the time given in the Retry-After header."},"examples":{"Example":{"title":"Example","value":{"code":"too_many_requests","message":"Too many requests. Try again after the time given in the Retry-After header."}}},"exampleType":"examples"}},"exampleType":"examples"},"e90f4de0-4572-4570-9a1e-d8562aa02625":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","example":"bad_request","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","example":"The field limit must not be greater than 50.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"","typeLabel":"object"},"example":{"code":"internal_server_error","message":"Internal server error."},"examples":{"Example":{"title":"Example","value":{"code":"internal_server_error","message":"Internal server error."}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"527c3fe4-6832-425b-acde-3969ffb4a8b8":{"AccessToken":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.demo.cula.earth/oauth2/token","scopes":{}}},"description":"OAuth 2.0 client credentials. Exchange your client_id and client_secret for an access token scoped to the organisation that provides data access.","scopes":[],"schemeName":"AccessToken"}}},"servers":{"66bbfecc-695b-4944-9986-0e06121643e7":{"url":"https://api.demo.cula.earth/tracking/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.demo.cula.earth/oauth2/token","scopes":{}}},"description":"OAuth 2.0 client credentials. Exchange your client_id and client_secret for an access token scoped to the organisation that provides data access.","scopes":[],"schemeName":"AccessToken"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"OAuth 2.0 client credentials. Exchange your client_id and client_secret for an access token scoped to the organisation that provides data access.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"AccessToken","name":"Authorization"}],"title":"AccessToken"}]},"originalFileLocation":"openapi.json"},"subdomain":"culatechnologies","siteName":"Cula Docs","title":"Get a sink - Cula Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-30T15:52:44.640Z","originalFileLocation":"api-reference/sinks/get-a-sink.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=\"application-name\" content=\"Cula Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/culatechnologies/-_tSlJRddN-rDXo_/_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/culatechnologies/-_tSlJRddN-rDXo_/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/culatechnologies/-_tSlJRddN-rDXo_/_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/culatechnologies/-_tSlJRddN-rDXo_/_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/culatechnologies/-_tSlJRddN-rDXo_/_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/culatechnologies/-_tSlJRddN-rDXo_/_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/culatechnologies/-_tSlJRddN-rDXo_/_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/culatechnologies/-_tSlJRddN-rDXo_/_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/culatechnologies/-_tSlJRddN-rDXo_/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get a sink - Cula Docs\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Cula Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.cula.tech/api-reference/sinks/get-a-sink\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://culatechnologies.mintlify.app/_mintlify/api/og/v2?division=Sinks\u0026amp;title=Get+a+sink\u0026amp;theme=9a11bf9e401b5ff7ee13840b\u0026amp;signature=08cdabbe9362d9508fa9111097b395bfcd12fbc60645e49671be6d7d59be9a79\">\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 a sink - Cula Docs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://culatechnologies.mintlify.app/_mintlify/api/og/v2?division=Sinks\u0026amp;title=Get+a+sink\u0026amp;theme=9a11bf9e401b5ff7ee13840b\u0026amp;signature=08cdabbe9362d9508fa9111097b395bfcd12fbc60645e49671be6d7d59be9a79\">\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/culatechnologies/-_tSlJRddN-rDXo_/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Cula Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3772FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.cula.tech/api-reference/sinks/get-a-sink\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/sinks/get-a-sink.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.cula.tech/#organization\",\"name\":\"Cula Docs\",\"url\":\"https://docs.cula.tech\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/culatechnologies/VBk50tt2s0Ltfxst/images/logo-dark.svg?fit=max\u0026auto=format\u0026n=VBk50tt2s0Ltfxst\u0026q=85\u0026s=461159ff3d23c746d71402d2feecf532\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.cula.tech#website\",\"name\":\"Cula Docs\",\"url\":\"https://docs.cula.tech\",\"publisher\":{\"@id\":\"https://docs.cula.tech/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.cula.tech/api-reference/sinks/get-a-sink#webpage\",\"url\":\"https://docs.cula.tech/api-reference/sinks/get-a-sink\",\"name\":\"Get a sink\",\"dateModified\":\"2026-10-30T15:52:44.640Z\",\"isPartOf\":{\"@id\":\"https://docs.cula.tech#website\"},\"breadcrumb\":{\"@id\":\"https://docs.cula.tech/api-reference/sinks/get-a-sink#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.cula.tech/api-reference/sinks/get-a-sink#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Material Tracking\",\"item\":\"https://docs.cula.tech/api-reference/material-pools/list-material-pools\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Sinks\",\"item\":\"https://docs.cula.tech/api-reference/sinks/list-sinks\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get a sink\",\"item\":\"https://docs.cula.tech/api-reference/sinks/get-a-sink\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.cula.tech/api-reference/sinks/get-a-sink#apireference\",\"headline\":\"Get a sink\",\"name\":\"Get a sink\",\"url\":\"https://docs.cula.tech/api-reference/sinks/get-a-sink\",\"mainEntityOfPage\":{\"@id\":\"https://docs.cula.tech/api-reference/sinks/get-a-sink#webpage\"},\"dateModified\":\"2026-10-30T15:52:44.640Z\",\"publisher\":{\"@id\":\"https://docs.cula.tech/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.cula.tech#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Cula Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Cula Docs","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/introduction"}]},{"tab":"API Reference","groups":[{"group":"General","pages":[{"group":"Organisations","pages":[{"title":"List organisations","deprecated":null,"version":null,"openapi":"/openapi.json get /organisations","href":"/api-reference/organisations/list-organisations"},{"title":"Get an organisation","deprecated":null,"version":null,"openapi":"/openapi.json get /organisations/{id}","href":"/api-reference/organisations/get-an-organisation"},{"title":"Create an organisation","deprecated":null,"version":null,"openapi":"/openapi.json post /organisations","href":"/api-reference/organisations/create-an-organisation"}]},{"group":"Sites","pages":[{"title":"List sites","deprecated":null,"version":null,"openapi":"/openapi.json get /sites","href":"/api-reference/sites/list-sites"},{"title":"Get a site","deprecated":null,"version":null,"openapi":"/openapi.json get /sites/{id}","href":"/api-reference/sites/get-a-site"},{"title":"Create a site","deprecated":null,"version":null,"openapi":"/openapi.json post /sites","href":"/api-reference/sites/create-a-site"}]},{"group":"Files","pages":[{"title":"List files","deprecated":null,"version":null,"openapi":"/openapi.json get /files","href":"/api-reference/files/list-files"},{"title":"Get a file","deprecated":null,"version":null,"openapi":"/openapi.json get /files/{id}","href":"/api-reference/files/get-a-file"},{"title":"Download a file","deprecated":null,"version":null,"openapi":"/openapi.json get /files/{id}/contents","href":"/api-reference/files/download-a-file"},{"title":"Upload a file","deprecated":null,"version":null,"openapi":"/openapi.json post /files","href":"/api-reference/files/upload-a-file"}]},{"group":"Webhooks","pages":[{"title":"List webhooks","deprecated":null,"version":null,"openapi":"/openapi.json get /webhooks","href":"/api-reference/webhooks/list-webhooks"},{"title":"Get a webhook","deprecated":null,"version":null,"openapi":"/openapi.json get /webhooks/{id}","href":"/api-reference/webhooks/get-a-webhook"},{"title":"Create a webhook","deprecated":null,"version":null,"openapi":"/openapi.json post /webhooks","href":"/api-reference/webhooks/create-a-webhook"},{"title":"Delete a webhook","deprecated":null,"version":null,"openapi":"/openapi.json delete /webhooks/{id}","href":"/api-reference/webhooks/delete-a-webhook"},{"title":"Receive an event","version":null,"deprecated":null,"openapi":"/openapi.json webhook receiveEvent","href":"/api-reference/webhooks/receive-an-event"}]},{"group":"Deprecated Endpoints","pages":[{"title":"Get a document","deprecated":true,"version":null,"openapi":"/openapi.json get /documents/{id}","href":"/api-reference/documents/get-a-document"}]}]},{"group":"Material Tracking","pages":[{"group":"Material Pools","pages":[{"title":"List material pools","deprecated":null,"version":null,"openapi":"/openapi.json get /material-pools","href":"/api-reference/material-pools/list-material-pools"},{"title":"Get a material pool","deprecated":null,"version":null,"openapi":"/openapi.json get /material-pools/{id}","href":"/api-reference/material-pools/get-a-material-pool"},{"title":"Create a material pool","deprecated":null,"version":null,"openapi":"/openapi.json post /material-pools","href":"/api-reference/material-pools/create-a-material-pool"},{"title":"Update a material pool","deprecated":null,"version":null,"openapi":"/openapi.json patch /material-pools/{id}","href":"/api-reference/material-pools/update-a-material-pool"},{"title":"Delete a material pool","deprecated":null,"version":null,"openapi":"/openapi.json delete /material-pools/{id}","href":"/api-reference/material-pools/delete-a-material-pool"}]},{"group":"Material Batches","pages":[{"title":"List material batch configs","deprecated":null,"version":null,"openapi":"/openapi.json get /material-batch-configs","href":"/api-reference/material-batch-configs/list-material-batch-configs"},{"title":"Get a material batch config","deprecated":null,"version":null,"openapi":"/openapi.json get /material-batch-configs/{id}","href":"/api-reference/material-batch-configs/get-a-material-batch-config"},{"title":"List versions of a material batch config","deprecated":null,"version":null,"openapi":"/openapi.json get /material-batch-configs/{id}/versions","href":"/api-reference/material-batch-configs/list-versions-of-a-material-batch-config"},{"title":"Get a specific material batch config version","deprecated":null,"version":null,"openapi":"/openapi.json get /material-batch-configs/{id}/versions/{version_id}","href":"/api-reference/material-batch-configs/get-a-specific-material-batch-config-version"},{"title":"List material batches","deprecated":null,"version":null,"openapi":"/openapi.json get /material-batches","href":"/api-reference/material-batches/list-material-batches"},{"title":"Get a material batch","deprecated":null,"version":null,"openapi":"/openapi.json get /material-batches/{id}","href":"/api-reference/material-batches/get-a-material-batch"},{"title":"Create a material batch","deprecated":null,"version":null,"openapi":"/openapi.json post /material-batches","href":"/api-reference/material-batches/create-a-material-batch"},{"title":"Update a material batch","deprecated":null,"version":null,"openapi":"/openapi.json patch /material-batches/{id}","href":"/api-reference/material-batches/update-a-material-batch"},{"title":"Delete a material batch","deprecated":null,"version":null,"openapi":"/openapi.json delete /material-batches/{id}","href":"/api-reference/material-batches/delete-a-material-batch"},{"title":"Attach a file to a material batch","deprecated":null,"version":null,"openapi":"/openapi.json post /material-batches/{id}/files/{file_id}","href":"/api-reference/material-batches/attach-a-file-to-a-material-batch"},{"title":"Detach a file from a material batch","deprecated":null,"version":null,"openapi":"/openapi.json delete /material-batches/{id}/files/{file_id}","href":"/api-reference/material-batches/detach-a-file-from-a-material-batch"}]},{"group":"Material Containers","pages":[{"title":"List material containers","deprecated":null,"version":null,"openapi":"/openapi.json get /material-containers","href":"/api-reference/material-containers/list-material-containers"},{"title":"Get a material container","deprecated":null,"version":null,"openapi":"/openapi.json get /material-containers/{id}","href":"/api-reference/material-containers/get-a-material-container"}]},{"group":"Material Sourcings","pages":[{"title":"List material sourcing configs","deprecated":null,"version":null,"openapi":"/openapi.json get /material-sourcing-configs","href":"/api-reference/material-sourcing-configs/list-material-sourcing-configs"},{"title":"Get a material sourcing config","deprecated":null,"version":null,"openapi":"/openapi.json get /material-sourcing-configs/{id}","href":"/api-reference/material-sourcing-configs/get-a-material-sourcing-config"},{"title":"List versions of a material sourcing config","deprecated":null,"version":null,"openapi":"/openapi.json get /material-sourcing-configs/{id}/versions","href":"/api-reference/material-sourcing-configs/list-versions-of-a-material-sourcing-config"},{"title":"Get a specific material sourcing config version","deprecated":null,"version":null,"openapi":"/openapi.json get /material-sourcing-configs/{id}/versions/{version_id}","href":"/api-reference/material-sourcing-configs/get-a-specific-material-sourcing-config-version"},{"title":"List material sourcings","deprecated":null,"version":null,"openapi":"/openapi.json get /material-sourcings","href":"/api-reference/material-sourcings/list-material-sourcings"},{"title":"Get a material sourcing","deprecated":null,"version":null,"openapi":"/openapi.json get /material-sourcings/{id}","href":"/api-reference/material-sourcings/get-a-material-sourcing"},{"title":"Create a material sourcing","deprecated":null,"version":null,"openapi":"/openapi.json post /material-sourcings","href":"/api-reference/material-sourcings/create-a-material-sourcing"}]},{"group":"Material Conversions","pages":[{"title":"List material conversion configs","deprecated":null,"version":null,"openapi":"/openapi.json get /material-conversion-configs","href":"/api-reference/material-conversion-configs/list-material-conversion-configs"},{"title":"Get a material conversion config","deprecated":null,"version":null,"openapi":"/openapi.json get /material-conversion-configs/{id}","href":"/api-reference/material-conversion-configs/get-a-material-conversion-config"},{"title":"List versions of a material conversion config","deprecated":null,"version":null,"openapi":"/openapi.json get /material-conversion-configs/{id}/versions","href":"/api-reference/material-conversion-configs/list-versions-of-a-material-conversion-config"},{"title":"Get a specific material conversion config version","deprecated":null,"version":null,"openapi":"/openapi.json get /material-conversion-configs/{id}/versions/{version_id}","href":"/api-reference/material-conversion-configs/get-a-specific-material-conversion-config-version"},{"title":"List material conversions","deprecated":null,"version":null,"openapi":"/openapi.json get /material-conversions","href":"/api-reference/material-conversions/list-material-conversions"},{"title":"Get a material conversion","deprecated":null,"version":null,"openapi":"/openapi.json get /material-conversions/{id}","href":"/api-reference/material-conversions/get-a-material-conversion"},{"title":"Create a material conversion","deprecated":null,"version":null,"openapi":"/openapi.json post /material-conversions","href":"/api-reference/material-conversions/create-a-material-conversion"}]},{"group":"Material Utilizations","pages":[{"title":"List material utilization configs","deprecated":null,"version":null,"openapi":"/openapi.json get /material-utilization-configs","href":"/api-reference/material-utilization-configs/list-material-utilization-configs"},{"title":"Get a material utilization config","deprecated":null,"version":null,"openapi":"/openapi.json get /material-utilization-configs/{id}","href":"/api-reference/material-utilization-configs/get-a-material-utilization-config"},{"title":"List versions of a material utilization config","deprecated":null,"version":null,"openapi":"/openapi.json get /material-utilization-configs/{id}/versions","href":"/api-reference/material-utilization-configs/list-versions-of-a-material-utilization-config"},{"title":"Get a specific material utilization config version","deprecated":null,"version":null,"openapi":"/openapi.json get /material-utilization-configs/{id}/versions/{version_id}","href":"/api-reference/material-utilization-configs/get-a-specific-material-utilization-config-version"},{"title":"List material utilizations","deprecated":null,"version":null,"openapi":"/openapi.json get /material-utilizations","href":"/api-reference/material-utilizations/list-material-utilizations"},{"title":"Get a material utilization","deprecated":null,"version":null,"openapi":"/openapi.json get /material-utilizations/{id}","href":"/api-reference/material-utilizations/get-a-material-utilization"},{"title":"Create a material utilization","deprecated":null,"version":null,"openapi":"/openapi.json post /material-utilizations","href":"/api-reference/material-utilizations/create-a-material-utilization"}]},{"group":"Deliveries","pages":[{"title":"List delivery configs","deprecated":null,"version":null,"openapi":"/openapi.json get /delivery-configs","href":"/api-reference/delivery-configs/list-delivery-configs"},{"title":"Get a delivery config","deprecated":null,"version":null,"openapi":"/openapi.json get /delivery-configs/{id}","href":"/api-reference/delivery-configs/get-a-delivery-config"},{"title":"List versions of a delivery config","deprecated":null,"version":null,"openapi":"/openapi.json get /delivery-configs/{id}/versions","href":"/api-reference/delivery-configs/list-versions-of-a-delivery-config"},{"title":"Get a specific delivery config version","deprecated":null,"version":null,"openapi":"/openapi.json get /delivery-configs/{id}/versions/{version_id}","href":"/api-reference/delivery-configs/get-a-specific-delivery-config-version"},{"title":"List deliveries","deprecated":null,"version":null,"openapi":"/openapi.json get /deliveries","href":"/api-reference/deliveries/list-deliveries"},{"title":"Get a delivery","deprecated":null,"version":null,"openapi":"/openapi.json get /deliveries/{id}","href":"/api-reference/deliveries/get-a-delivery"},{"title":"Create a delivery","deprecated":null,"version":null,"openapi":"/openapi.json post /deliveries","href":"/api-reference/deliveries/create-a-delivery"},{"title":"Update a delivery","deprecated":null,"version":null,"openapi":"/openapi.json patch /deliveries/{id}","href":"/api-reference/deliveries/update-a-delivery"},{"title":"Delete a delivery","deprecated":null,"version":null,"openapi":"/openapi.json delete /deliveries/{id}","href":"/api-reference/deliveries/delete-a-delivery"},{"title":"Attach a file to a delivery","deprecated":null,"version":null,"openapi":"/openapi.json post /deliveries/{id}/files/{file_id}","href":"/api-reference/deliveries/attach-a-file-to-a-delivery"},{"title":"Detach a file from a delivery","deprecated":null,"version":null,"openapi":"/openapi.json delete /deliveries/{id}/files/{file_id}","href":"/api-reference/deliveries/detach-a-file-from-a-delivery"}]},{"group":"Sinks","pages":[{"title":"List sinks","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json get /sinks","href":"/api-reference/sinks/list-sinks"},{"title":"Get a sink","deprecated":null,"version":null,"openapi":"/openapi.json get /sinks/{id}","href":"/api-reference/sinks/get-a-sink"}]}]},{"group":"Machine Data","pages":[{"group":"Machine Data Sources","pages":[{"title":"List machine data sources","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json get /machine-data-sources","href":"/api-reference/machine-data-sources/list-machine-data-sources"},{"title":"Get a machine data source","deprecated":null,"version":null,"openapi":"/openapi.json get /machine-data-sources/{id}","href":"/api-reference/machine-data-sources/get-a-machine-data-source"}]},{"group":"Machines (deprecated)","pages":[{"title":"List machines","deprecated":true,"version":null,"openapi":"/openapi.json get /machines","href":"/api-reference/machines/list-machines"},{"title":"Get a machine","deprecated":true,"version":null,"openapi":"/openapi.json get /machines/{id}","href":"/api-reference/machines/get-a-machine"}]},{"group":"Machine Variables","pages":[{"title":"List machine variables","deprecated":null,"version":null,"openapi":"/openapi.json get /machine-variables","href":"/api-reference/machine-variables/list-machine-variables"},{"title":"Get a machine variable","deprecated":null,"version":null,"openapi":"/openapi.json get /machine-variables/{id}","href":"/api-reference/machine-variables/get-a-machine-variable"}]},{"group":"Machine Data Imports","pages":[{"title":"Import machine data","deprecated":null,"version":null,"openapi":"/openapi.json post /machine-data-imports","href":"/api-reference/machine-data-imports/import-machine-data"},{"title":"List machine data imports","deprecated":null,"version":null,"openapi":"/openapi.json get /machine-data-imports","href":"/api-reference/machine-data-imports/list-machine-data-imports"},{"title":"Get a machine data import","deprecated":null,"version":null,"openapi":"/openapi.json get /machine-data-imports/{id}","href":"/api-reference/machine-data-imports/get-a-machine-data-import"}]},{"group":"Machine Data Annotations","pages":[{"title":"List machine data annotations","deprecated":null,"version":null,"openapi":"/openapi.json get /machine-data-annotations","href":"/api-reference/machine-data-annotations/list-machine-data-annotations"},{"title":"Get a machine data annotation","deprecated":null,"version":null,"openapi":"/openapi.json get /machine-data-annotations/{id}","href":"/api-reference/machine-data-annotations/get-a-machine-data-annotation"},{"title":"Create a machine data annotation","deprecated":null,"version":null,"openapi":"/openapi.json post /machine-data-annotations","href":"/api-reference/machine-data-annotations/create-a-machine-data-annotation"},{"title":"Update a machine data annotation","deprecated":null,"version":null,"openapi":"/openapi.json patch /machine-data-annotations/{id}","href":"/api-reference/machine-data-annotations/update-a-machine-data-annotation"},{"title":"Delete a machine data annotation","deprecated":null,"version":null,"openapi":"/openapi.json delete /machine-data-annotations/{id}","href":"/api-reference/machine-data-annotations/delete-a-machine-data-annotation"},{"title":"Attach a machine variable to a machine data annotation","deprecated":null,"version":null,"openapi":"/openapi.json post /machine-data-annotations/{id}/machine-variables/{machine_variable_id}","href":"/api-reference/machine-data-annotations/attach-a-machine-variable-to-a-machine-data-annotation"},{"title":"Detach a machine variable from a machine data annotation","deprecated":null,"version":null,"openapi":"/openapi.json delete /machine-data-annotations/{id}/machine-variables/{machine_variable_id}","href":"/api-reference/machine-data-annotations/detach-a-machine-variable-from-a-machine-data-annotation"}]}]}]}]},"basePath":"","title":"Get a sink - Cula Docs","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B7XKH4J3.js","utils-lOYzL7z-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DF6jUUIM.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dpsj5f7C.js","snippetPresets-CYeiDe8v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CUFz1YZ_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D8H_iLS4.js","shallow-DdluZBHX.js","getApiPlaygroundDisplay-B9922vev.js","CodeSnippet-CMoRNGYs.js","CodeSnippets-DwyrPHuw.js","Page-DSVu9Ucl.js","getPastedJson-G-zIvlHh.js","icon-B03fnEy0.js","MethodPill-CW7teklc.js","DuplicateIcon-CtO8eekd.js","createIcon-DZTKdM_A.js","DynamicMarkdown-D5M2At0B.js","SectionHeading-C_2NaA2U.js","axios-vUo_bRtp.js","Markdown-D7QRHV3m.js","clsx-D1Z-ELXV.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-lvhuD9Du.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CKfC4ywL.js"]}