/programs/{program_id}/frameworks/{framework_id}Retrieve framework details
Retrieves information about the specified framework.
A framework_id value has a br- prefix.
Each OptiTech program is initially created with a root and default framework named main.
A program can contain one or more frameworks.
A parent framework is identified by a parent_id value, which is the id of the parent framework.
For related information, see Manage frameworks.
Quick start
curl "https://api.optitech.com/v1/programs/$PROGRAM_ID/frameworks/$FRAMEWORK_ID" \
-H "Authorization: Bearer $OPTITECH_API_KEY"Every field below is optional. An empty body works too.
optitech branches get <id|name>Parameters
program_idThe OptiTech program ID
framework_idThe framework ID
Response
200Returned information about the specified framework
Errors
General error
This endpoint can return the standard OptiTech API error response.
Response fields
messageRequired. Human-readable error message.codeRequired. Machine-readable error code.request_idOptional. Request identifier for debugging. You can provide one with theX-Request-IDheader.
Retry guidance
If no response is returned, the request may still have reached the server. This is why retry safety depends on the method and status code.
Idempotent methods (GET, HEAD, OPTIONS) are generally safe to retry after a network error or timeout. Non-idempotent methods (POST, PATCH, DELETE, PUT) can change state, so avoid automatic retries unless your workflow can tolerate duplicate effects.
Responses with 423 Locked or 503 Service Unavailable are safe to retry. 423 Locked means the resource is temporarily locked, usually because another operation is in progress.