> ## Documentation Index
> Fetch the complete documentation index at: https://docs.m3ter.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Externalmappingconfiguration

## Retrieve External Entities from Destination

**Function name:** `m3ter_GetExternalMappingOptionsForDestination`
**Category:** READ
**HTTP method:** GET
**Destination:** m3ter

Retrieve a list of external entities from the specified destination system.

This endpoint enables you to retrieve a list of potential values for creating an External Mapping from a specified destination system. The list is only returned if the destination system has been authenticated successfully and it supports such functionality, otherwise, you will receive an empty response.

### Parameters

| Name                       | Label            | Type                    | Required | Description                                                                              | Constraints                                                           |
| -------------------------- | ---------------- | ----------------------- | :------: | ---------------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `integrationCredentialsId` | Credentials      | M3terEntityParameter    |    Yes   | The m3ter credentials to use.                                                            | m3terEntity: IntegrationCredentials, authType: M3TER\_SIGNED\_REQUEST |
| `destination`              | destination      | LookupParameter         |    Yes   | The name of the destination system from where the external entities are to be retrieved. | -                                                                     |
| `entityType`               | entityType       | LookupParameter         |    Yes   | The m3ter entity type.                                                                   | -                                                                     |
| `statePath`                | State Path       | StateVariableParameter  |    No    | State variable to store the response.                                                    | -                                                                     |
| `queryParams`              | Query Parameters | KeyValueLookupParameter |    No    | Query parameters to include in the request                                               | allowedValues: externalTable                                          |

### Exits

| Exit    | Description                                                                      |
| ------- | -------------------------------------------------------------------------------- |
| `NEXT`  | The API call succeeded.                                                          |
| `ERROR` | The API call failed. Error details are stored in the `m3shError` state variable. |

## Retrieve a list of external entities from the destination system for a particular credential

**Function name:** `m3ter_GetExternalMappingOptionsForDestinationForCredentialsId`
**Category:** READ
**HTTP method:** GET
**Destination:** m3ter

Retrieve a list of possible values to create an external mapping using a particular credential. These options are retrieved from the destination system if the system has been successfully authenticated and provides the mechanism to do so. Otherwise an empty response is returned.

### Parameters

| Name                       | Label                    | Type                    | Required | Description                                | Constraints                                                           |
| -------------------------- | ------------------------ | ----------------------- | :------: | ------------------------------------------ | --------------------------------------------------------------------- |
| `integrationCredentialsId` | Credentials              | M3terEntityParameter    |    Yes   | The m3ter credentials to use.              | m3terEntity: IntegrationCredentials, authType: M3TER\_SIGNED\_REQUEST |
| `destination`              | destination              | LookupParameter         |    Yes   | Name of the destination system             | -                                                                     |
| `entityType`               | entityType               | LookupParameter         |    Yes   | The m3ter entity type.                     | -                                                                     |
| `integrationCredentialsId` | integrationCredentialsId | LookupParameter         |    Yes   | The UUID of the credentials to use.        | -                                                                     |
| `statePath`                | State Path               | StateVariableParameter  |    No    | State variable to store the response.      | -                                                                     |
| `queryParams`              | Query Parameters         | KeyValueLookupParameter |    No    | Query parameters to include in the request | allowedValues: externalTable                                          |

### Exits

| Exit    | Description                                                                      |
| ------- | -------------------------------------------------------------------------------- |
| `NEXT`  | The API call succeeded.                                                          |
| `ERROR` | The API call failed. Error details are stored in the `m3shError` state variable. |

## Retrieve External Mapping Configuration

**Function name:** `m3ter_GetExternalMappingConfiguration`
**Category:** READ
**HTTP method:** GET
**Destination:** m3ter

Retrieve the global External Mapping configuration.

This endpoint retrieves the global External Mapping configuration for the specified Organization.

### Parameters

| Name                       | Label       | Type                   | Required | Description                           | Constraints                                                           |
| -------------------------- | ----------- | ---------------------- | :------: | ------------------------------------- | --------------------------------------------------------------------- |
| `integrationCredentialsId` | Credentials | M3terEntityParameter   |    Yes   | The m3ter credentials to use.         | m3terEntity: IntegrationCredentials, authType: M3TER\_SIGNED\_REQUEST |
| `statePath`                | State Path  | StateVariableParameter |    No    | State variable to store the response. | -                                                                     |

### Exits

| Exit    | Description                                                                      |
| ------- | -------------------------------------------------------------------------------- |
| `NEXT`  | The API call succeeded.                                                          |
| `ERROR` | The API call failed. Error details are stored in the `m3shError` state variable. |