Returns a formula by its ID

GET /api/v1/formulas/{formulaId}

Retrieves the full configuration of a single formula by its ID.

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

Permission: Permissions.FORMULAS_FORMULA_READ


Request

Path Parameters

Parameter
Type
Required
Description

formulaId

string

Yes

Database ID of the formula to retrieve


Response

Success Response

Status: 200 OK

{
  "id": "63e3e5e8a01b3c001234abcd",
  "uuid": "c4a3b2d1-e5f6-7890-abcd-ef1234567890",
  "name": "Carbon Credit Calculator",
  "description": "Calculates carbon credits based on emission factors",
  "status": "PUBLISHED",
  "owner": "did:hedera:testnet:zHcDLGFNymFAJiMBKnpbHDgjvTn6yZnwkPPeFhtJBECH_0.0.4532001",
  "policyId": "63e3e5e8a01b3c001234abcd",
  "config": {}
}

Error Responses

Status
Description

401 Unauthorized

Missing or invalid token

403 Forbidden

Insufficient permissions

422 Unprocessable Entity

formulaId parameter is missing or empty

500 Internal Server Error

Unexpected server failure

Last updated

Was this helpful?