Account8

AccountPlan6

Aggregation5

Auth1

BalanceChargeSchedule6

Balances8

BalanceTransactionSchedule6

Bill20

BillConfig2

BillGroupingKey5

BillJob5

Charge5

Commitments6

CompoundAggregation5

Contract6

Counter5

CounterAdjustments5

CounterPricing5

CreditReason5

Credits5

Currency5

CustomField2

DataExplorer20

DataExplorerV26

DebitReason5

Debits5

Events4

ExportAdHoc1

ExportDestination6

ExportJob2

ExportSchedule5

External Mapping8

ExternalMappings2

IntegrationConfigs12

IntegrationCredentials5

IntegrationDestinations22

IntegrationRuns7

IntegrationTransformations7

Invitations3

Line Item1

LookupTable5

LookupTableRevision6

LookupTableRevisionData13

Marketplace Integrations1

Measurements6

Meter5

MeterGroup5

Notifications6

OrganizationConfig2

OrgUsers6

PermissionPolicy13

Plan5

PlanGroup5

PlanGroupLink5

PlanTemplate5

Pricing5

Product5

ResourceGroup9

ScheduledEventConfigurations5

ServiceUser6

ServiceUserCredentials6

StatementDefinition5

StatementJob5

Support3

TransactionType5

User1

LookupTable

Get LookupTable

Changed on Oct 16, 2026

Retrieve a Lookup Table by UUID.

get/organizations/{orgId}/lookuptables/{id}

Request

Base URL
https://api.m3ter.com
Auth
OAuth 2
Authorization codehttps://m3ter.auth.us-east-1.amazoncognito.com/oauth2/authorize, token URL https://m3ter.auth.us-east-1.amazoncognito.com/oauth2/token
Client credentialsToken URL /oauth/token
TypeScript
https://skmtc.dev/m3ter-com/apis/m3ter-api/docs/organizations/:orgId/lookuptables/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

orgIdstring required

UUID of the Organization. The Organization represents your company as a direct customer of the m3ter service.

idstring required

The UUID of the Lookup Table to retrieve.

Query parameters

additionalstring[]

Comma separated list of additional non-default fields to be included in the response. For example,if you want to include the active Revision for the Lookup Tables returned, set additional=activeRevision in the query.

Response

Return the requested Lookup Table

idstring required

The UUID of the entity.

versioninteger

The version number:

Create: On initial Create to insert a new entity, the version is set at 1 in the response.
Update: On successful Update, the version is incremented by 1 in the response.

customFieldsobject

User defined fields enabling you to attach custom data. The value for a custom field can be either a string or a number.

If customFields can also be defined for this entity at the Organizational level,customField values defined at individual level override values of customFields with the same name defined at Organization level.

See Working with Custom Fields in the m3ter documentation for more information.

namestring

The name of the Lookup Table

codestring

The code of the Lookup Table

dtCreatedstring date-time

The DateTime when the Lookup Table was created.

dtLastModifiedstring date-time

The DateTime when the Lookup Table was last modified.

createdBystring

The id of the user who created this Lookup Table.

lastModifiedBystring

The id of the user who last modified this Lookup Table.

Example response

{
  "activeRevision": {
    "fields": [
      {
        "name": "lookuptablerevisionfieldkey"
      }
    ]
  }
}

Changes

Oct 16, 202685c514abc692 Revision changes
- breaking
  the //// response's property type changed from no type to object for status
- breaking
  the response's property type changed from no type to object for status
- breaking
  the ////////// response's property type changed from no type to object for status
- info
  added the optional property ////// to the response with the status
- info
  removed subschema #2 from the / response property allOf list for the response status
- info
  removed subschema #2 from the //////// response property allOf list for the response status
- info
  removed subschema #2 from the ////// response property allOf list for the response status
Dec 3, 2025ac93d1a9e6d9 Revision changes
- info
  endpoint added

Operation history