Activity Type Lookup — Guide

First-request guide for Activity Type Lookup.

API GUIDE

Activity Type Lookup

Activity Type Lookup

GET/activity_type/{identifier}No request bodyAuthentication required

Overview

Retrieve details of an activity type for data import.

Call the endpoint

Send a GET request to /activity_type/{identifier} 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/import/v1/activity_type/example \
  --header "Authorization: Bearer $DB_API_KEY" \
  --header "Accept: application/json"
STEP 2

Read the response

SUCCESS RESPONSE · HTTP 200
{
  "activityType": {
    "name": "example",
    "label": "example",
    "description": "example"
  },
  "fields": [
    {
      "fieldName": "example",
      "fieldDataType": "example",
      "defaultField": true,
      "isRequiredForCsvImport": true
    }
  ]
}

Request anatomy

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

Parameters

NameLocationTypeRequiredDescription
identifierpathstringRequiredThe unique identifier for the activity type. This should be the activity type ID.

Request body

This endpoint does not define a JSON request body.

Response anatomy

The endpoint returns 200 for the documented success case. Inspect the response fields below.

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

Rules

  • Use GET with the path /activity_type/{identifier}.
  • Required inputs: identifier.
  • 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
identifierpathstringRequiredThe unique identifier for the activity type. This should be the activity type ID.

Errors

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

StatusMeaning
400Request 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 activities-management

Back to top