Skip to main content
GET
/
organizations
/
{orgId}
/
contracts
List Contracts
curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/contracts \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "version": 123,
      "customFields": {},
      "accountId": "<string>",
      "name": "<string>",
      "code": "<string>",
      "description": "<string>",
      "purchaseOrderNumber": "<string>",
      "applyContractPeriodLimits": true,
      "usageFilters": [
        {
          "dimensionCode": "<string>",
          "value": "<string>",
          "mode": "INCLUDE"
        }
      ],
      "billGroupingKeyId": "<string>",
      "startDate": "2023-12-25",
      "endDate": "2023-12-25",
      "dtCreated": "2023-11-07T05:31:56Z",
      "dtLastModified": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "lastModifiedBy": "<string>"
    }
  ],
  "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

The unique identifier (UUID) for your Organization. The Organization represents your company as a direct customer of our service.

Query Parameters

​
pageSize
integer<int32>

Specifies the maximum number of Contracts to retrieve per page.

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

The nextToken for multi-page retrievals. It is used to fetch the next page of Contracts in a paginated list.

​
ids
string[]

An optional parameter to filter the list based on specific Contract unique identifiers (UUIDs).

​
codes
string[]

An optional parameter to retrieve specific Contracts based on their short codes.

​
accountId
string | null
Required string length: 36

Response

Returns a list of Contracts

​
data
object[]
​
nextToken
string