M3ter User API

Endpoints for creating/updating Users

GitHub OpenAPI

Operations 1

GET /organizations/{orgId}/users/me Retrieve current user information #

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-user-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-user-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: m3ter User 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: User
  description: Endpoints for creating/updating Users
paths:
  /organizations/{orgId}/users/me:
    get:
      tags:
      - User
      summary: Retrieve current user information
      description: Retrieve information about the current user
      operationId: GetMe
      parameters:
      - name: orgId
        in: path
        description: UUID of the organization
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: GetMe 200 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MeResponse'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
components:
  schemas:
    OrganizationType:
      type: string
      description: ''
      enum:
      - PRODUCTION
      - SANDBOX
    UserResponse:
      type: object
      description: ''
      allOf:
      - $ref: '#/components/schemas/AbstractResponse'
      - type: object
        properties:
          firstName:
            type: string
            description: The first name of the user.
          lastName:
            type: string
            description: 'The surname of the user. '
          contactNumber:
            type: string
            description: The user's contact telephone number.
          email:
            type: string
            description: 'The email address for this user. '
          organizations:
            type: array
            description: An array listing the Organizations where this user has access.
            items:
              type: string
          firstAcceptedTermsAndConditions:
            type: string
            description: 'The date and time *(in ISO 8601 format)* when this user first accepted the the m3ter terms and conditions.  '
            format: date-time
          lastAcceptedTermsAndConditions:
            type: string
            description: 'The date and time *(in ISO 8601 format)* when this user last accepted the the m3ter terms and conditions.  '
            format: date-time
          supportUser:
            type: boolean
            description: 'Indicates whether this is a m3ter Support user. '
          dtCreated:
            type: string
            description: The date and time *(in ISO-8601 format)* when the user was created.
            format: date-time
          dtLastModified:
            type: string
            description: The date and time *(in ISO-8601 format)* when the user was last modified.
            format: date-time
          createdBy:
            type: string
            description: The user who created this user.
          lastModifiedBy:
            type: string
            description: The unique identifier (UUID) of the user who last modified this user record.
    ServiceUserResponse:
      type: object
      description: ''
      allOf:
      - $ref: '#/components/schemas/AbstractResponse'
      - type: object
        properties:
          name:
            type: string
            description: ''
          dtCreated:
            type: string
            description: The DateTime when the service user was created.
            format: date-time
          dtLastModified:
            type: string
            description: The DateTime when the service user was last modified.
            format: date-time
          createdBy:
            type: string
            description: The id of the user who created this service user.
          lastModifiedBy:
            type: string
            description: The id of the user who last modified this service user.
    MeResponse:
      type: object
      properties:
        user:
          description: ''
          $ref: '#/components/schemas/UserResponse'
        serviceUser:
          description: ''
          $ref: '#/components/schemas/ServiceUserResponse'
        organization:
          description: ''
          $ref: '#/components/schemas/OrganizationResponse'
      description: ''
    OrganizationResponse:
      type: object
      description: ''
      allOf:
      - $ref: '#/components/schemas/AbstractResponse'
      - type: object
        properties:
          orgId:
            type: string
            description: ''
          customerId:
            type: string
            description: ''
          organizationName:
            type: string
            description: ''
          shortName:
            type: string
            description: ''
          addressLine1:
            type: string
            description: ''
          addressLine2:
            type: string
            description: ''
          addressLine3:
            type: string
            description: ''
          addressLine4:
            type: string
            description: ''
          locality:
            type: string
            description: ''
          region:
            type: string
            description: ''
          postCode:
            type: string
            description: ''
          country:
            type: string
            description: ''
          taxId:
            type: string
            description: ''
          purchaseOrderNumber:
            type: string
            description: ''
          invoiceGeneralReference:
            type: string
            description: ''
          billingContactUserId1:
            type: string
            description: ''
          billingContactUserId2:
            type: string
            description: ''
          billingContactUserId3:
            type: string
            description: ''
          type:
            description: ''
            $ref: '#/components/schemas/OrganizationType'
          status:
            description: ''
            $ref: '#/components/schemas/OrganizationStatus'
          dtCreated:
            type: string
            description: The DateTime when the organization was created.
            format: date-time
          dtLastModified:
            type: string
            description: The DateTime when the organization was last modified.
            format: date-time
          createdBy:
            type: string
            description: The id of the user who created this organization.
          lastModifiedBy:
            type: string
            description: The id of the user who last modified this organization.
    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: ''
    OrganizationStatus:
      type: string
      description: ''
      enum:
      - ACTIVE
      - ARCHIVED
  responses:
    Error:
      description: Error message
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
  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)