/programsList programs
Retrieves a list of programs for the specified organization.
If using a personal API key, include the org_id parameter to specify which organization to work with.
If using an org API key, org_id is automatically inferred from the key.
For more information, see Manage organizations using the OptiTech API
and Manage programs.
Quick start
curl "https://api.optitech.com/v1/programs" \
-H "Authorization: Bearer $OPTITECH_API_KEY"Every field below is optional. An empty body works too.
optitech projects listParameters
cursorSpecify the cursor value from the previous response to retrieve the next batch of programs.
limitSpecify a value from 1 to 400 to limit number of programs in the response.
searchSearch by program name or id. You can specify partial name or id values to filter results.
org_idSearch for programs by org_id.
timeoutSpecify an explicit timeout in milliseconds to limit response delay. After timing out, the incomplete list of program data fetched so far will be returned. Projects still being fetched when the timeout occurred are listed in the "unavailable" attribute of the response. If not specified, an implicit implementation defined timeout is chosen with the same behaviour as above
recoverableShow only deleted programs within the recovery window.
Response
200Returned a list of programs for the OptiTech account
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.