Get available reference objects — Guide

First-request guide for Get available reference objects.

Export API guide

List reference objects

Discover the lookup objects available to enrich or interpret Export data.

GET /v1/references   •   Authentication: Bearer token

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 once per integration startup or when discovering newly available reference objects.

Workflow 2

Select an objectType from the returned list rather than guessing a URL.

Workflow 3

Pass the selected object name to the support-object endpoint to retrieve its values.

Quickstart

Step 1 — Send the request

curl --request GET \
--url https://uapi.demandbase.com/data/export/v1/references \
--header "Authorization: Bearer $DB_API_KEY" \
--header "Accept: application/json"

Step 2 — Read the response

{
"refObjectsAvailable": [
{
"name": "IdealBuyingGroup",
"description": "Ideal Buying Group",
"href": "https://uapi.demandbase.com/data/export/v1/reference/IdealBuyingGroup"
},
{
"name": "IdealBuyingGroupPersonaRole",
"description": "Persona and Buyer roles associated with an ideal buying group.",
"href": "https://uapi.demandbase.com/data/export/v1/reference/IdealBuyingGroupPersonaRole"
},
{
"name": "BuyerRole",
"description": "Buyer roles reference data.",
"href": "https://uapi.demandbase.com/data/export/v1/reference/BuyerRole"
},
{
"name": "Persona",
"description": "Personas reference data.",
"href": "https://uapi.demandbase.com/data/export/v1/reference/Persona"
},
{
"name": "KeywordSet",
"description": "Keyword sets reference data.",
"href": "https://uapi.demandbase.com/data/export/v1/reference/KeywordSet"
},
{
"name": "KeywordSetMember",
"description": "Members (keywords) within a keyword set.",
"href": "https://uapi.demandbase.com/data/export/v1/reference/KeywordSetMember"
},
{
"name": "JobLevel",
"description": "Job levels reference data.",
"href": "https://uapi.demandbase.com/data/export/v1/reference/JobLevel"
},
{
"name": "JobFunction",
"description": "Job functions reference data.",
"href": "https://uapi.demandbase.com/data/export/v1/reference/JobFunction"
},
{
"name": "TopLevelIndustry",
"description": "Top Level Industry reference data.",
"href": "https://uapi.demandbase.com/data/export/v1/reference/TopLevelIndustry"
},
{
"name": "SubIndustry",
"description": "Sub Industry reference data.",
"href": "https://uapi.demandbase.com/data/export/v1/reference/SubIndustry"
}
]
}

Request anatomy

PartRequiredWhat to send
AuthorizationheaderBearer token with permission to read Export reference data.
bodynoneThis discovery request has no request body or query parameters.

Response anatomy

FieldType / stateHow to use it
refObjectsAvailablearrayReference objects available to this API version.
objectTypestringName accepted by the lookup endpoint.
hrefURLEndpoint for retrieving the object values.

Rules and constraints

  • Use the exact objectType and href returned by the API.
  • Cache discovery only for a period appropriate to your integration because availability can vary by version or tenant.
  • Do not treat the discovery list as the values themselves.

Empty results

If no reference objects are returned, continue without enrichment and verify tenant entitlements before treating it as an API failure.

Errors and recovery

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

StatusMeaningRecovery
401The bearer token is missing, expired, or invalid.Refresh the token and retry discovery.
403The caller cannot read reference data.Verify Export reference permissions for the tenant.

Next steps