v10

latestOpenAPI 3.0.1raw.githubusercontent.com2025-12-033223581.2 MB

LookupTable

Get LookupTable

Retrieve a Lookup Table by UUID.

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

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.