M3ter Lookup Table API

Endpoints for creating/updating/deleting Lookup Tables. Lookup Tables enable you to manage dynamic data mappings that your calculations reference. Use them for currency conversion, pricing tiers, discount rates, and similar scenarios where you require values to change operationally but for calculation logic to remain constant. **Beta Version!** The Lookup Table feature is currently available in Beta release version. See Feature Release Stages for Beta release definition. Lookup Table endpoints will only be available if Lookup Tables have been enabled for your Organization. For more details see Lookup Tables (Beta) in our main User documentation.

GitHub OpenAPI

Operations 5

GET /organizations/{orgId}/lookuptables List LookupTable #
POST /organizations/{orgId}/lookuptables Create LookupTable #
GET /organizations/{orgId}/lookuptables/{id} Get LookupTable #
PUT /organizations/{orgId}/lookuptables/{id} Update LookupTable #
DELETE /organizations/{orgId}/lookuptables/{id} Delete LookupTable #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/m3ter:m3ter-lookup-table-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

m3ter-lookup-table-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: m3ter Lookup Table API
  description: 'If you are using Postman, you can:

    - Use the **Download** button above to download the m3ter Open API spec JSON file and then import this file as the **m3ter API Collection** into your Workspace. See Importing the m3ter Open API in our main user Documentation for details. - Copy this link: m3ter-Template API Collection and use it to import the **m3ter-Template API Collection** into your Workspace. See Importing the m3ter Template API Collection in our main user Documentation for details. ---


    # Introduction

    The m3ter platform supports two HTTP-based REST APIs returning JSON encoded responses:

    - The **Ingest API**, which you can use for submitting raw data measurements. *(See the Submit Measurements endpoint in this API Reference.)*

    - The **Config API**, which you can use for configuration and management. *(All other endpoints in this API Reference.)*


    ## Authentication and Authorization

    Our APIs use an industry-standard authorization protocol known as the OAuth 2.0 specification. OAuth2 supports several grant types, each designed for a specific use case. m3ter uses the following two grant types:

    - **Authorization Code**: Used for human login access via the m3ter Console. - **Client Credentials**: Used for machine-to-machine communication and API access. Complete the following flow for API access:


    1. **Create a Service User and add Permissions**: Log in to the m3ter Console, go to **Settings**, **Access** then **Service Users** tab, and create a Service User. To enable API calls, grant the user **Administrator** permissions. 2. **Generate Access Keys**: In the Console, open the *Overview* page for the Service User by clicking on the name. Generate an **Access Key id** and **Api Secret**. Make sure you copy the **Api Secret** because it is only visible at the time of creation. See Service Authentication for detailed instructions and an example. 3. **Obtain a Bearer Token using Basic Auth**: We implement the OAuth 2.0 Client Credentials Grant authentication flow for Service User Authentication. Submit a request to the m3ter OAuth Client Credentials authentication flow, using your concatenated **Access Key id** and **Api Secret** to obtain a Bearer Token for your Service User. *See examples below.*


    4. **Bearer Token Usage**: Use the HTTP ''Authorization'' header with the bearer token to authorise all subsequent API requests. > Warning: The Bearer Token is valid for 18,000 seconds or 5 hours. When the token has expired, you must obtain a new one. Below are two examples for obtaining a Bearer Token using Basic Auth: the first in cURL and the second as a Python script. ### cURL Example

    1. Open your terminal or command prompt. 2. Use the following `cURL` command to obtain a Bearer Token:


    ```bash

    curl -X POST https://api.m3ter.com/oauth/token \

    -H ''Content-Type: application/x-www-form-urlencoded'' \

    -u your_access_key_id:your_api_secret \

    -d ''grant_type=client_credentials''

    ```


    Replace `your_access_key_id` and `your_api_secret` with your actual **Access Key id** and **Api Secret**. 3. Run the command, and if successful, it will return a JSON response containing the Bearer Token. The response will look like this:


    ```json

    {

    "access_token": "your_bearer_token",

    "token_type": "Bearer",

    "expires_in": 18000

    }

    ```


    You can then use the Bearer Token *(the value of `"access_token"`)* for subsequent API calls to m3ter. ### Python Example

    1. Install the `requests` library if you haven''t already:


    ```bash

    pip install requests

    ```


    2.'
  version: '1.0'
  x-logo:
    url: https://console.m3ter.com/m3ter-logo-black.svg
servers:
- url: https://api.m3ter.com
security:
- OAuth2: []
tags:
- name: Lookup Table
  description: 'Endpoints for creating/updating/deleting Lookup Tables.


    Lookup Tables enable you to manage dynamic data mappings that your calculations reference. Use them for currency conversion, pricing tiers, discount rates, and similar scenarios where you require values to change operationally but for calculation logic to remain constant.


    **Beta Version!** The Lookup Table feature is currently available in Beta release version. See Feature Release Stages for Beta release definition. Lookup Table endpoints will only be available if Lookup Tables have been enabled for your Organization. For more details see Lookup Tables (Beta) in our main User documentation.'
paths:
  /organizations/{orgId}/lookuptables:
    get:
      tags:
      - Lookup Table
      summary: List LookupTable
      description: 'Retrieve a list Lookup Tables created for the Organization:

        * Returned list can be filtered by Lookup Table `code` query parameter.

        * If you want to include any non-default fields for the returned Lookup Tables, use the additional query parameter to specify which you want to include in the response.'
      operationId: ListLookupTable
      parameters:
      - name: orgId
        in: path
        description: UUID of the Organization. The Organization represents your company as a direct customer of the m3ter service.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: pageSize
        in: query
        description: Number of Lookup Tables to retrieve per page.
        required: false
        allowEmptyValue: true
        style: form
        explode: true
        schema:
          maximum: 200
          minimum: 1
          type: integer
          format: int32
      - name: nextToken
        in: query
        description: Token to supply for multi page retrievals.
        required: false
        allowEmptyValue: true
        style: form
        explode: true
        schema:
          type: string
      - name: codes
        in: query
        description: List of Lookup Table codes to retrieve.
        required: false
        allowEmptyValue: true
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: additional
        in: query
        description: 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 each of the Lookup Tables returned, set `additional=activeRevision` in the query.
        required: false
        allowEmptyValue: true
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: List of Lookup Tables
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedLookupTableResponseData'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
    post:
      tags:
      - Lookup Table
      summary: Create LookupTable
      description: Create a new Lookup Table.
      operationId: PostLookupTable
      parameters:
      - name: orgId
        in: path
        description: UUID of the Organization. The Organization represents your company as a direct customer of the m3ter service.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LookupTableRequest'
        required: true
      responses:
        '200':
          description: Return the created Lookup Table
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LookupTableResponse'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
  /organizations/{orgId}/lookuptables/{id}:
    get:
      tags:
      - Lookup Table
      summary: Get LookupTable
      description: Retrieve a Lookup Table by UUID.
      operationId: GetLookupTable
      parameters:
      - name: orgId
        in: path
        description: UUID of the Organization. The Organization represents your company as a direct customer of the m3ter service.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: id
        in: path
        description: The UUID of the Lookup Table to retrieve.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: additional
        in: query
        description: 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.
        required: false
        allowEmptyValue: true
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: Return the requested Lookup Table
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LookupTableResponse'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
    put:
      tags:
      - Lookup Table
      summary: Update LookupTable
      description: Update the Lookup Table with the given UUID.
      operationId: PutLookupTable
      parameters:
      - name: orgId
        in: path
        description: UUID of the Organization. The Organization represents your company as a direct customer of the m3ter service.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: id
        in: path
        description: The UUID of the Lookup Table to update.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LookupTableRequest'
        required: true
      responses:
        '200':
          description: Return the updated Lookup Table.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LookupTableResponse'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
    delete:
      tags:
      - Lookup Table
      summary: Delete LookupTable
      description: Delete the Lookup Table with the given UUID.
      operationId: DeleteLookupTable
      parameters:
      - name: orgId
        in: path
        description: UUID of the Organization. The Organization represents your company as a direct customer of the m3ter service.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: id
        in: path
        description: The UUID of the Lookup Table to delete.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Return the deleted Lookup Table
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LookupTableResponse'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
components:
  responses:
    Error:
      description: Error message
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
  schemas:
    PaginatedLookupTableResponseData:
      type: object
      properties:
        data:
          type: array
          description: ''
          items:
            $ref: '#/components/schemas/LookupTableResponse'
        nextToken:
          type: string
          description: ''
      description: ''
    LookupTableRevisionStatus:
      type: string
      description: Status of a Lookup Table Revision
      enum:
      - DRAFT
      - PUBLISHED
      - ARCHIVED
    AbstractRequest:
      type: object
      properties:
        version:
          type: integer
          description: 'The version number of the entity:

            - **Create entity:** Not valid for initial insertion of new entity - *do not use for Create*. On initial Create, version is set at 1 and listed in the response.

            - **Update Entity:**  On Update, version is required and must match the existing version because a check is performed to ensure sequential versioning is preserved. Version is incremented by 1 and listed in the response.'
          format: int64
          x-stainless-terraform-configurability: computed
          x-stainless-terraform-always-send: true
      description: ''
    LookupTableResponse:
      type: object
      description: ''
      allOf:
      - $ref: '#/components/schemas/AbstractResponseWithCustomFields'
      - $ref: '#/components/schemas/AbstractResponse'
      - type: object
        properties:
          name:
            type: string
            description: The name of the Lookup Table
          code:
            type: string
            description: The code of the Lookup Table
          dtCreated:
            type: string
            description: The DateTime when the Lookup Table was created.
            format: date-time
          dtLastModified:
            type: string
            description: The DateTime when the Lookup Table was last modified.
            format: date-time
          createdBy:
            type: string
            description: The id of the user who created this Lookup Table.
          lastModifiedBy:
            type: string
            description: The id of the user who last modified this Lookup Table.
          activeRevision:
            description: ''
            allOf:
            - $ref: '#/components/schemas/LookupTableRevisionResponse'
    AbstractResponseWithCustomFields:
      type: object
      description: ''
      allOf:
      - $ref: '#/components/schemas/AbstractResponse'
      - type: object
        properties:
          customFields:
            type: object
            additionalProperties: true
            description: '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](https://www.m3ter.com/docs/guides/creating-and-managing-products/working-with-custom-fields) in the m3ter documentation for more information.'
    LookupTableRequest:
      required:
      - code
      - name
      type: object
      description: ''
      allOf:
      - $ref: '#/components/schemas/AbstractRequestWithCustomFields'
      - $ref: '#/components/schemas/AbstractRequest'
      - type: object
        properties:
          name:
            maxLength: 200
            minLength: 1
            type: string
            description: Descriptive name for the Lookup Table.
            x-size-message: Name cannot exceed 200 characters
          code:
            maxLength: 80
            minLength: 1
            pattern: ^([^[\p{Cntrl}\s]])|([^[\p{Cntrl}\s]][[^[\p{Cntrl}\s]] ]*[^[\p{Cntrl}\s]])$
            type: string
            description: 'Code of the Lookup Table - unique short code used to identify the Lookup Table.


              **NOTE:** Code has a maximum length of 80 characters and must not contain non-printable or whitespace characters (except space), and cannot start/end with whitespace.'
            x-pattern-message: Code must not contain non-printable or whitespace characters (except space), and cannot start/end with whitespace
            x-size-message: Code cannot exceed 80 characters
    AbstractResponse:
      required:
      - id
      type: object
      properties:
        id:
          type: string
          description: 'The UUID of the entity. '
        version:
          type: integer
          description: '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.'
          format: int64
          x-stainless-terraform-configurability: computed
          x-stainless-terraform-always-send: true
      description: ''
    AbstractRequestWithCustomFields:
      type: object
      description: ''
      allOf:
      - $ref: '#/components/schemas/AbstractRequest'
      - type: object
        properties:
          customFields:
            type: object
            description: '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](https://www.m3ter.com/docs/guides/creating-and-managing-products/working-with-custom-fields) in the m3ter documentation for more information.'
            allOf:
            - type: object
              additionalProperties: true
            - maxItems: 100
              type: object
    LookupTableRevisionFieldType:
      type: string
      description: Type of a Lookup Table Revision Field
      enum:
      - STRING
      - NUMBER
    LookupTableRevisionResponse:
      type: object
      properties:
        name:
          type: string
          description: The name of the Lookup Table Revision.
        status:
          description: ''
          allOf:
          - $ref: '#/components/schemas/LookupTableRevisionStatus'
        startDate:
          type: string
          description: The start date of the Lookup Table Revision
          format: date-time
        fields:
          type: array
          description: The list of fields of the Lookup Table Revision.
          items:
            $ref: '#/components/schemas/LookupTableRevisionField'
        keys:
          type: array
          description: The ordered keys of the Lookup Table Revision
          items:
            type: string
        dtCreated:
          type: string
          description: The DateTime when the Lookup Table Revision was created.
          format: date-time
        dtLastModified:
          type: string
          description: The DateTime when the Lookup Table Revision was last modified.
          format: date-time
        createdBy:
          type: string
          description: The id of the user who created the Lookup Table Revision.
        lastModifiedBy:
          type: string
          description: The id of the user who last modified the Lookup Table Revision.
        itemCount:
          type: integer
          description: ''
          format: int64
        lookupTableId:
          type: string
          description: The lookup table id associated with this revision
      description: Response containing a LookupTableRevision entity
      allOf:
      - $ref: '#/components/schemas/AbstractResponseWithCustomFields'
      - $ref: '#/components/schemas/AbstractResponse'
    LookupTableRevisionField:
      required:
      - type
      type: object
      properties:
        name:
          maxLength: 256
          pattern: ^[\p{L}_$][\p{L}_$0-9]*$
          type: string
          description: The name of the field
          example: lookuptablerevisionfieldkey
          x-pattern-message: Field names can only contain letters, numbers, underscore, and dollar, and must not start with a number
          x-size-message: The max allowed length of a Lookup Table Revision field name is 256 characters
        type:
          description: ''
          allOf:
          - $ref: '#/components/schemas/LookupTableRevisionFieldType'
          x-not-null-message: The Lookup Table Revision field type can not be null
      description: Field of a Lookup Table Revision
  securitySchemes:
    OAuth2:
      type: oauth2
      description: "m3ter supports machine to machine authentication using the `clientCredentials` OAuth2 flow.\n\nThe `authorizationCode` flow controls access for human users via the m3ter Console application. \n"
      flows:
        clientCredentials:
          tokenUrl: /oauth/token
          scopes:
            m3ter-resources/m3ter-scope: m3ter resources
        authorizationCode:
          authorizationUrl: https://m3ter.auth.us-east-1.amazoncognito.com/oauth2/authorize
          tokenUrl: https://m3ter.auth.us-east-1.amazoncognito.com/oauth2/token
          scopes:
            m3ter-resources/m3ter-scope: m3ter resources
            openid: OpenID
            email: email
x-provenance:
  method: harvested
  publisher: M3ter
  source: https://docs.m3ter.com/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)