The /typelists endpoints

The Common API contains two /typelist endpoints:

  • common/v1/typelists - By default, this returns the names and descriptions of all typelists in ClaimCenter.
  • common/v1/typelists/{typelistName} - By default, this returns the non-retired typecodes in the named typelist.

In the base configuration, these endpoints are available only to callers who have been authenticated.

Including retired typecodes

By default, the common/v1/typelists/{typelistName} endpoint returns only non-retired typecodes. You can include retired typecodes by adding the following query parameter to the call:

?includeRetired=true