Skip to main content

Find a configuration

API operation: Open the endpoint in Scalar

Use GET /configs/{config} to obtain one configuration by its numeric identifier. The operation is Config.find.

The archived path named the final parameter config_id; the current contract names it config. Both represent the same configuration identifier in the same path position.

The route is restricted to server or administrator access. A protected configuration can be returned with its value replaced by PROTECT. Treat that marker as withheld data, not as the stored configuration value.

Use optional field selection when you need a smaller response.

Legacy SDK example​

const response = await ordering.configs(configId).get()

Confirm the SDK package and version before using this helper.

OpenAPI reference​

Operation: GET /configs/{config}

Path parameters

NameTypeRequiredDescription
configintegerYes—

Query parameters

NameTypeRequiredDescription
paramsstringNoComma-separated list of fields. It is intersected with the model’s $fillable; an empty or invalid list returns all fields.

Responses

CodeDescription
200OK (Envelope)
400Bad Request (ErrorResponse)
401Unauthorized
404Not Found
429Too Many Requests (ErrorResponse)
500Internal Server Error (ErrorResponse)
503Service Unavailable (ErrorResponse)
Open this operation in the API reference