Skip to content

GET /custom-data/

Get Custom Data

GET
/custom-data/{key}

Retrieve a single custom-data entry by key.

Looks up the CustomData document with _key == key. Returns 404 if
no document exists for that key.

Emits: (direct transaction — no event class)

Required scope: admin:custom-data:read

Authorizations

OAuth2PasswordBearer
password Flow
Token URL"/api/auth"
Scopes:
  • "admin"User can access and edit users and system settings
  • "library"User can access and edit products
  • "production"User can access and edit production plans
  • "operator"User can access the operator panel and make production declarations

Parameters

Path Parameters

key*
Type
string
Required

Responses

Successful Response

application/json
JSON
{
  
"_id": "string",
  
"_key": "string",
  
"_rev": "string",
  
"value": "https://erp.example.com/api/v2",
  
"description": "Base URL of the ERP integration endpoint, used by the sync workflow."
}

Samples

Powered by VitePress OpenAPI

Released under the Apache 2.0 License.