Skip to main content
GET
/
organizations
/
{orgId}
/
accounts
List Accounts
curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/accounts \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "version": 123,
      "customFields": {},
      "name": "<string>",
      "code": "<string>",
      "address": {
        "addressLine1": "<string>",
        "addressLine2": "<string>",
        "addressLine3": "<string>",
        "addressLine4": "<string>",
        "locality": "<string>",
        "region": "<string>",
        "postCode": "<string>",
        "country": "<string>"
      },
      "emailAddress": "<string>",
      "parentAccountId": "<string>",
      "billEpoch": "2023-12-25",
      "purchaseOrderNumber": "<string>",
      "currency": "USD",
      "statementDefinitionId": "<string>",
      "dtCreated": "2023-11-07T05:31:56Z",
      "dtLastModified": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "lastModifiedBy": "<string>",
      "autoGenerateStatementMode": "NONE",
      "creditApplicationOrder": [
        "PREPAYMENT"
      ],
      "daysBeforeBillDue": 123
    }
  ],
  "nextToken": "<string>"
}

Authorizations

​
Authorization
string
header
required

m3ter supports machine to machine authentication using the clientCredentials OAuth2 flow.

The authorizationCode flow controls access for human users via the m3ter Console application.

Path Parameters

​
orgId
string
required

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

Query Parameters

​
pageSize
integer<int32>

Number of accounts to retrieve per page.

Required range: 1 <= x <= 100
​
nextToken
string

nextToken for multi-page retrievals.

​
ids
string[]

List of Account IDs to retrieve.

​
codes
string[]

List of Account Codes to retrieve. These are unique short codes for each Account.

Response

Returns the list of Accounts

​
data
object[]
​
nextToken
string