get

HTTP Request

GET /workflows/:workflowReference/parameters/:parameterReference

Path parameters

Parameter

parameterReference

A scoped reference to the notebook. See referencing resources for more information.

workflowReference

A qualified reference to the parameter's workflow. See referencing resources for more information.

circle-info

This endpoint extends the general API structure.

Authorization

You must have read access to the underlying workflow, and hour access token must have one of the following scopes:

  • workflow.read

Learn more about authorization.

Request body

The request body must be empty.

Response body

The response body will contain a JSON representation of a parameter.get resource.

Was this helpful?