Get field mappings — Guide

First-request guide for Get field mappings.

API GUIDE

Get field mappings

Get field mappings

GET/integration/v1/custom-sources/{source_id}/field-mappings/{object_type}No request bodyAuthentication required

Overview

Returns the field mappings configured for the given source and object type.

Call the endpoint

Send a GET request to /integration/v1/custom-sources/{source_id}/field-mappings/{object_type} 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/integration/v1/custom-sources/1/field-mappings/account \
  --header "Authorization: Bearer $DB_API_KEY" \
  --header "Accept: application/json"
STEP 2

Read the response

SUCCESS RESPONSE · HTTP 200
{
  "fieldMappings": [
    {
      "sourceFieldLabel": "annual_revenue",
      "demandbaseFieldName": "annualRevenue",
      "dataType": "number"
    },
    {
      "sourceFieldLabel": "hq_country",
      "demandbaseFieldName": "country",
      "dataType": "string"
    }
  ]
}

Request anatomy

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

Parameters

NameLocationTypeRequiredDescription
valueOptional
valueOptional

Request body

This endpoint does not define a JSON request body.

Response anatomy

The endpoint returns 200 for the documented success case. Field mappings for the specified source and object type.

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

Rules

  • Use GET with the path /integration/v1/custom-sources/{source_id}/field-mappings/{object_type}.
  • Required inputs: No parameters are marked required in the published schema..
  • Authenticate every request with a valid Demandbase access token.
  • This endpoint does not require a JSON request body.

Filters

This endpoint has no additional filters or parameters beyond its authentication requirements.

NameLocationTypeRequiredDescription
valueOptional
valueOptional

Errors

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

StatusMeaning
400Request failed.
401Request failed.
404Request failed.
500Request failed.

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 field-mappings

Back to top