Skip to main content
GET
/
v1
/
canonical-fields
List canonical fields
curl --request GET \
  --url http://localhost:3001/v1/canonical-fields
{
  "items": [
    {
      "path": "<string>",
      "model": "<string>",
      "label": "<string>",
      "description": "<string>",
      "requirement": "<string>",
      "storage": "<string>",
      "sourceTypes": [
        "<string>"
      ],
      "examples": [
        "<string>"
      ],
      "notes": "<string>"
    }
  ]
}

Query Parameters

sourceType
enum<string>
Available options:
client_transfer_report,
client_internal_ledger,
bank_statement,
onchain_report,
psp_report,
manual,
api_expectation
model
enum<string>
Available options:
PaymentIntent,
RawRecord,
FlowLeg,
FlowLegReference,
ReconciliationCase
importTargetsOnly
boolean
default:false
required

Response

Default Response

items
CanonicalFieldDefinitionResponse ยท object[]
required