How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

American Express Global Business Travel Custom Data Fields (CDF) API

CDF APIs to retrieve Definitions and Manage Values.

American Express Global Business Travel Custom Data Fields (CDF) API is one of 26 APIs that American Express Global Business Travel publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Custom Data Fields (CDF). The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and authentication docs.

This API exposes 7 operations across 4 paths, and defines 11 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://apis.egencia.com/openconnect/api.

7 operations 4 paths 11 schemas 1 DELETE3 GET1 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://apis.egencia.com/openconnect/api
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

American Express Global Business Travel Custom Data Fields (CDF) API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the clientCredentials flow.

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 3 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Custom Data Fields (CDF) 7

CDF APIs to retrieve Definitions and Manage Values.

GET
/v1/companies/{companyId}/cdfs
Fetch all CDF definitions for a company or corresponding to a CDF name
getCdfDefinitions 2 params → 200400401403404422500
GET
/v1/companies/{companyId}/cdfs/{definitionId}/values
Fetch all CDF values for a company and a CDF definition or corresponding to a CDF value
getCdfValues 5 params → 200400401403404422500
POST
/v1/companies/{companyId}/cdfs/{definitionId}/values
Create a new CDF value for a CDF of field type List
createCdfValue 2 params body → 201400401403404422500
DELETE
/v1/companies/{companyId}/cdfs/{definitionId}/values/{valueId}
Delete a CDF value for a CDF of field type List
deleteCdfValue 3 params → 204401403404500
GET
/v1/companies/{companyId}/cdfs/{definitionId}/values/{valueId}
Fetch all linked CDF values
getCdfLinkedValue 6 params → 200400401403404422500
PUT
/v1/companies/{companyId}/cdfs/{definitionId}/values/{valueId}
Update a CDF value for a CDF of field type List
updateCdfValue 3 params body → 204400401403404422500
PATCH
/v1/companies/{companyId}/cdfs/{definitionId}/values/{valueId}/link
Update CDF Value by adding or removing child/parent links. This endpoint is available for CC1/CC2 linking for offices in EU/APAC.
patchCdfValue 3 params body → 204400401403404415422500

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are Link (8 properties), CdfDefinition (7 properties), CdfValueLinks (6 properties), CdfValue (5 properties). Each schema is shown below with its type and property counts.

CdfDefinition
object
CDF Definition
7 properties
CdfValuesResponse
object
CDF values response based on different user filters
2 properties
Links
object
CdfLinkValue
object
Link values
2 properties
CdfDefinitions
object
CDF Definitions
1 property
JsonPatchRequest
object
3 properties
CdfDefinitionRule
object
4 properties 1 required
Link
object
8 properties
CdfValue
object
CDF value response based on different user filters
5 properties 1 required
CdfValueLinks
object
Linked CDF value response based on different user filters
6 properties 1 required
CdfLinks
object
Linked CDF value
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amex-gbt-custom-data-fields-cdf-api-openapi.yml Raw ↑

Other APIs American Express Global Business Travel publishes across the network.

American Express Global Business Travel Agent Assist Notes API
American Express Global Business Travel Approval API
American Express Global Business Travel Availability Probes Controller API
American Express Global Business Travel bookings v1 API
American Express Global Business Travel bookings v2 API
American Express Global Business Travel Company Details API
American Express Global Business Travel Custom Data Field Cleanup Controller API
American Express Global Business Travel Doc Audit Clean Up Controller API
American Express Global Business Travel DutyOfCare Data API
American Express Global Business Travel Ecommerce Settings Controller API
American Express Global Business Travel Expense SPI API
American Express Global Business Travel Gdpr Controller API
Where this information came from

This is an independent, third-party profile of American Express Global Business Travel Custom Data Fields (CDF) API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.