Lookups REST Endpoints

Sort by

Task Path Method

Integrations/Lookups

Retrieve, create, update, and delete lookups.

Lookups are reusable tables that map the different terms used to describe the same item across your applications.

For example, one application uses a specific set of codes to describe countries, while another application uses a different set of codes to describe the same countries. Lookups can be used for items such as mapping gender codes, nationality codes, currency codes, or any type of information that your applications must share with each other but that they represent differently.

Clone a Lookup

Method: post

Path: /ic/api/integration/v1/lookups/{name}/clone

Create a Lookup

Method: post

Path: /ic/api/integration/v1/lookups

Delete a Lookup

Method: delete

Path: /ic/api/integration/v1/lookups/{name}

Export a Lookup

Method: get

Path: /ic/api/integration/v1/lookups/{name}/archive

Import(Add) a Lookup

Method: post

Path: /ic/api/integration/v1/lookups/archive

Import(Replace) a Lookup

Method: put

Path: /ic/api/integration/v1/lookups/archive

Retrieve a Lookup

Method: get

Path: /ic/api/integration/v1/lookups/{name}

Retrieve Lookups

Method: get

Path: /ic/api/integration/v1/lookups

Retrieve Usage of the Lookup

Method: get

Path: /ic/api/integration/v1/lookups/{name}/usage

Update a Lookup

Method: put

Path: /ic/api/integration/v1/lookups/{name}