Get reference data for an object — Guide

First-request guide for Get reference data for an object.

API GUIDE

Get reference data for an object

Get reference data for an object

GET/reference/{object}No request bodyAuthentication required

Overview

Returns tenant-specific reference values for the requested object. This B2B API route is backed by the Data Export API reference service and accepts B2B API credentials. Object names are case-insensitive.

Call the endpoint

Send a GET request to /reference/{object} with the required authentication and parameters.

Supply endpoint parameters

Review the parameter table to see which path, query, or header values the endpoint accepts.

Inspect the response

Use the success response shape to validate the fields your integration receives.

Quickstart

Follow these two steps to make a request and recognize a successful response.

STEP 1

Make a request

REQUEST
curl --request GET \
  --url https://uapi.demandbase.com/data/b2b/v1/reference/JobLevel \
  --header "Authorization: Bearer $DB_API_KEY" \
  --header "Accept: application/json"
STEP 2

Read the response

SUCCESS RESPONSE · HTTP 200
{
  "objectType": "JobLevel",
  "data": [
    {
      "id": 1,
      "name": "C Level"
    }
  ]
}

Request anatomy

Build the request from the method, path, parameters, and payload described below.

Parameters

NameLocationTypeRequiredDescription
objectpathstringRequiredReference object to retrieve.

Request body

This endpoint does not define a JSON request body.

Response anatomy

The endpoint returns 200 for the documented success case. Reference data fetched successfully.

The response schema does not enumerate fields; inspect the example response and status code.

Rules

  • Use GET with the path /reference/{object}.
  • Required inputs: object.
  • Authenticate every request with a valid Demandbase access token.
  • This endpoint does not require a JSON request body.

Filters

The published schema exposes the following endpoint inputs. Use the location column to place each value correctly.

NameLocationTypeRequiredDescription
objectpathstringRequiredReference object to retrieve.

Errors

Handle non-success responses explicitly so your integration can report actionable failures.

StatusMeaning
400The requested reference object is invalid.
401Unauthorized because the user is not authenticated.
403The API key does not have permission to access this resource.

Next steps

Try the quickstart

Start with the request example, then replace the sample values with your credentials and data.

Return to the API area

Back to reference-tables

Back to top