Returns Block ID by Tag

GET /policies/{policyId}/tag/{tagName}

Returns the block configuration (including block ID) for the block matching the given tag name within the specified policy.

Authentication: Bearer token required (Authorization: Bearer <token>)

Permission: Permissions.POLICIES_POLICY_EXECUTE or Permissions.POLICIES_POLICY_MANAGE


Request

Path Parameters

Parameter
Type
Required
Description

policyId

string

Yes

The policy ID (MongoDB ObjectId, e.g. 63e3e5e8a01b3c001234abcd)

tagName

string

Yes

The block tag name (e.g. submit_application)


Response

Success Response

Status: 200 OK

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "blockType": "requestVcDocumentBlock",
  "tag": "submit_application"
}

Error Responses

Status
Description

401 Unauthorized

Missing or invalid token

403 Forbidden

Insufficient permissions

404 Not Found

Policy or block with given tag not found

422 Unprocessable Entity

Tag lookup error

500 Internal Server Error

Unexpected server failure

Last updated

Was this helpful?