Skip to main content
GET
/
organizations
/
{orgId}
/
picklists
/
creditreasons
List Credit Reasons
curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/picklists/creditreasons \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "version": 123,
      "code": "<string>",
      "name": "<string>",
      "archived": true,
      "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

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

Query Parameters

​
pageSize
integer<int32>

Number of credit reasons to retrieve per page.

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

nextToken for multi page retrievals.

​
ids
string[]

List of Credit Reason IDs to retrieve.

​
codes
string[]

List of Credit Reason short codes to retrieve.

​
archived
boolean

TRUE / FALSE archived flag to filter the list. CreditReasons can be archived once they are obsolete.

  • TRUE includes archived CreditReasons.
  • FALSE excludes CreditReasons that are archived.

Response

List of CreditReasons

​
data
object[]
​
nextToken
string