Get Metronome

GET/v1/metronomes/{metronomeId}

How to call this endpoint

Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.

Path, query, and header parameters

These parameters control which ACP object the endpoint acts on and how the request is processed.

Path parameters
NameLocationTypeRequiredDescription
metronomeIdpathstringYesMetronome workflow ID
Query parameters
None.

Body schema

This endpoint does not require a request body.

None.

What the API returns

Each response code below includes the documented payload shape for the ACP API.

200Metronome detailsapplication/json
FieldTypeRequiredDescription
dataobjectNo
data.idstringNoUnique identifier.
data.userIdstringNoUser ID.
data.namestringNoHuman-readable name.
data.descriptionstringNoHuman-readable description.
data.statusdraft | active | paused | archivedNoCurrent lifecycle status.
data.definitionobjectNo
data.definition.nodesobject[]No
data.definition.nodes[].idstringNoUnique identifier.
data.definition.nodes[].typestringNo
data.definition.nodes[].positionobjectNo
data.definition.nodes[].dataobjectNo
data.definition.nodes[].data.kindtrigger | condition | action | code | imagine | function | database | metronome | loop | approval | end | noteNo
data.definition.nodes[].data.subtypestringNo
data.definition.nodes[].data.labelstringNo
data.definition.nodes[].data.descriptionstringNoHuman-readable description.
data.definition.nodes[].data.configobjectNo
data.definition.edgesobject[]No
data.definition.edges[].idstringNoUnique identifier.
data.definition.edges[].sourcestringNo
data.definition.edges[].targetstringNo
data.definition.edges[].sourceHandlestringNo
data.definition.edges[].targetHandlestringNo
data.definition.edges[].labelstringNo
data.nodesobject[]No
data.nodes[].idstringNoUnique identifier.
data.nodes[].typestringNo
data.nodes[].positionobjectNo
data.nodes[].dataobjectNo
data.nodes[].data.kindtrigger | condition | action | code | imagine | function | database | metronome | loop | approval | end | noteNo
data.nodes[].data.subtypestringNo
data.nodes[].data.labelstringNo
data.nodes[].data.descriptionstringNoHuman-readable description.
data.nodes[].data.configobjectNo
data.edgesobject[]No
data.edges[].idstringNoUnique identifier.
data.edges[].sourcestringNo
data.edges[].targetstringNo
data.edges[].sourceHandlestringNo
data.edges[].targetHandlestringNo
data.edges[].labelstringNo
data.triggerSummarystringNo
data.lastRunAtstringNo
data.publishedAtstringNo
data.runsTodayintegerNo
data.waitingApprovalsintegerNo
data.metadataobjectNoFree-form metadata object.
data.createdAtstringNoISO 8601 timestamp.
data.updatedAtstringNoISO 8601 timestamp.
Get Metronome
Loading...
Response 200
Loading...
See the ACP quickstart and SDK flow