Export API guide

Fetch export fields

Discover the fields that can be requested before you create an export job.

GET /v1/fields • Authentication: Bearer token

On this page: Quickstart Request anatomy Response anatomy Rules and constraints Empty results Errors and recovery Next steps

Before you start

Authenticate

Send Authorization: Bearer <token> on every request and keep tokens out of logs and source control.

Follow the workflow

Use the response to drive the next Export API call instead of hard-coding field or object names.

Use the code below

The cURL and JSON examples are copy-ready starting points. Replace IDs, dates, and tokens with values from your tenant.

Common workflows

Workflow 1

Call this first when building an account, person, activity, campaign, or creative export.

Workflow 2

For ad-report exports, include adReportType so the catalog matches the requested report shape.

Workflow 3

Copy returned name values into the create-job request; labels are for display.

Quickstart

Step 1 — Send the request

curl --request GET \

--url https://uapi.demandbase.com/data/export/v1/fields?entityType=account \

--header "Authorization: Bearer $DB_API_KEY" \

--header "Accept: application/json"

Step 2 — Read the response

[

{

"name": "{Account}.name",

"label": "Account Name",

"dataType": "STRING"

{

"name": "{Account}.industry",

"label": "Industry",

"dataType": "STRING"

}

]

Request anatomy

Part	Required	What to send
entityType	required	account, campaign, creative, opportunity, person, activity, accountBuyingGroup, or personBuyingGroupMember.
adReportType	conditional	Use for campaign or creative ad-report field catalogs.

Response anatomy

Field	Type / state	How to use it
name	string	Field token to place in a job request.
label	string	Human-readable field label.
dataType	string	Value type returned in the export.

Rules and constraints

The entity type must be one of the documented enum values.
Treat returned field names as opaque tokens; do not substitute display labels.
Fetch fields again when changing entity type or ad-report type.

Empty results

An empty field catalog usually means the entity type and optional ad-report type do not describe a supported combination. Confirm the query values before creating the job.

Errors and recovery

Handle these responses explicitly so your integration can report an actionable cause and next step.

Status	Meaning	Recovery
400	Invalid or missing query values.	Use a documented entityType and supply adReportType when required.
401	The bearer token is missing, expired, or invalid.	Refresh the token and send it in the Authorization header.
403	The token lacks export permission.	Verify tenant access and API product entitlement.