latestOpenAPI 3.0.02026-08-12207455917.9 KB

bad0d2db9b7a

Terminology

Get contact-type terminology

Returns each stable contact-type code with its display label for your resolved context. You receive US labels when not opted in and Canadian labels when opted in (same resolution as the rest of the API; pass ?terminology=en-CA to opt in per request). The stable code is always returned alongside each label and never changes with terminology, so it is safe to key on. Responses are safe to cache keyed on your resolved preference.

Validation & Requirements

Required Parameters

  • None

Required JSON Body Fields

  • None

Validations

  • Invalid GUID values in *Guid/*Guids fields return 422 Unprocessable Entity.
  • Invalid date values in *date* fields return 422 Unprocessable Entity.
  • Missing required request body returns 422 Unprocessable Entity with Missing request body..
  • Additional business-rule validation may return 422 with details in the errors array.
get/api/terminology/contact-types

Response

warningsstring[] nullable