Skip to main content

List Conversion Types

GET /conversion-types

List all active conversion types for your account. Use the conversion type id when creating conversion events.

Each type includes a fields array defining the custom metadata fields expected when creating events — use the field key values as keys in the event's metadata object.

Example

curl https://api.getnexor.ai/api/public/conversion-types \
-H "X-API-Key: nxr_live_your_api_key"

Responses

200 — Successful response

{
"success": true,
"conversion_types": [
{
"id": "123e4567-e89b-12d3-a456-426614174100",
"name": "Reserva",
"description": "Initial reservation deposit",
"category": "intermediary",
"currency": "USD",
"fields": [
{ "key": "property_unit", "label": "Property / Unit", "type": "text" },
{ "key": "broker", "label": "Broker", "type": "text" },
{ "key": "commission", "label": "Commission", "type": "number" }
],
"workflow_id": "uuid",
"master_workflow_id": null,
"created_at": "2026-01-10T08:00:00Z"
}
]
}

Response Fields — Conversion Type

FieldTypeDescription
idstring (uuid)Unique conversion type identifier
namestringConversion type name
descriptionstring | nullConversion type description
category"intermediary" | "final"Whether this is an intermediary milestone or a final business outcome
currencystringDefault currency code for events of this type (e.g., USD, CLP, CLF)
fieldsarrayCustom field definitions (see below)
workflow_idstring (uuid) | nullWorkflow this type is scoped to. Events inherit this automatically
master_workflow_idstring (uuid) | nullMaster workflow this type is scoped to. Events inherit this automatically
created_atstring (date-time)When the type was created

Field Definition

FieldTypeDescription
keystringMachine-readable key used in the event's metadata object
labelstringHuman-readable label displayed in the UI
type"text" | "number"Data type of the field value

401 — Authentication error

See Authentication.

500 — Internal server error