GET /custom-data

List Custom Data

GET

/custom-data

List all custom-data entries, optionally filtered by a search string.

Executes an AQL query against the CustomData collection. When search
is provided, filters by case-insensitive substring match against both the
document _key and the description field. Results are sorted by _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

Query Parameters

search

Responses

Successful Response

Content-Type

application/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