Skip to content

Get Resources by Tag

Endpoint: GET /api/metadata/tags/resources

Retrieves all resources associated with a specific tag key-value pair, filtered by resource type. Use this endpoint to identify which workflows, tasks, schedules, or other resources carry a given tag.

Query parameters

Parameter Description Type Required/Optional
tagKey The tag key to filter resources by. string Required.
tagValue The tag value to filter resources by. string Required.
resourceType The resource type to filter by. Supported values:
  • WORKFLOW_DEF - The workflow definitions.
  • TASK_DEF - The task definitions.
  • WORKFLOW_SCHEDULE - The workflow schedules
  • EVENT_HANDLER - The event handlers.
  • APPLICATION - The applications in Conductor.
  • SECRET_NAME - The secrets stored in Conductor.
  • ENV_VARIABLE - The environment variables stored in Conductor.
  • INTEGRATION_PROVIDER - The integrations in Conductor.
  • PROMPT - The AI prompts in Conductor.
  • USER_FORM_TEMPLATE - The user forms for human task inputs.
  • WEBHOOK - The webhooks in Conductor.
  • API_GATEWAY_SERVICE - The Gateway service definitions.
  • AUTH_CONFIG - The API Gateway authentication configuration.
 string Required.

Response

  • Returns 200 OK with an array of matching resources.
[
  {
    "id": "string",
    "displayName": "string"
  }
]
Field Description
id The resource identifier. For USER_FORM_TEMPLATE, this is formatted as templateName/version. For WEBHOOK, this is the webhook UUID. For all other resource types, this matches displayName.
displayName The human-readable name shown in the UI. For WEBHOOK and USER_FORM_TEMPLATE, this may differ from id. For all other resource types, id and displayName are the same.
  • Returns 400 Bad Request if an unsupported resourceType value is provided.
  • Returns 401 Unauthorized if valid credentials are not provided.

Examples

Get workflow schedules by tag

The following example retrieves all workflow schedules tagged with team:backend.

Request

curl -X 'GET' \
  'https://<YOUR-SERVER-URL>/api/metadata/tags/resources?tagKey=team&tagValue=backend&resourceType=WORKFLOW_SCHEDULE' \
  -H 'accept: */*' \
  -H 'X-Authorization: <TOKEN>'

Response

[
  {
    "id": "annual_upgrade",
    "displayName": "annual_upgrade"
  }
]
Get user forms by tag

The following example retrieves all user forms tagged with team:docs.

Request

curl -X 'GET' \
  'https://<YOUR-SERVER-URL>/api/metadata/tags/resources?tagKey=team&tagValue=docs&resourceType=USER_FORM_TEMPLATE' \
  -H 'accept: */*' \
  -H 'X-Authorization: <TOKEN>'

Response

[
  {
    "id": "ApprovalJohn/1",
    "displayName": "ApprovalJohn"
  },
  {
    "id": "InsuranceClaims/1",
    "displayName": "InsuranceClaims"
  }
]
Get webhooks by tag

The following example retrieves all webhooks tagged with team:docs.

Request

curl -X 'GET' \
  'https://<YOUR-SERVER-URL>/api/metadata/tags/resources?tagKey=team&tagValue=docs&resourceType=WEBHOOK' \
  -H 'accept: */*' \
  -H 'X-Authorization: <TOKEN>'

Response

[
  {
    "id": "897f37a7-f2a4-11f0-97ee-8e75126ccff4",
    "displayName": "CreateJiraTickets"
  }
]