---
title: "List Credit Reasons"
method: GET
path: "/organizations/{orgId}/picklists/creditreasons"
tags: ["CreditReason"]
---

# List Credit Reasons

`GET /organizations/{orgId}/picklists/creditreasons`

## Request

- Base URL: `https://api.m3ter.com`
- URL: `https://api.m3ter.com/organizations/{orgId}/picklists/creditreasons`
- Auth: OAuth 2
  - Authorization code: `https://m3ter.auth.us-east-1.amazoncognito.com/oauth2/authorize`, token URL `https://m3ter.auth.us-east-1.amazoncognito.com/oauth2/token`
  - Client credentials, token URL `/oauth/token`
- TypeScript: <https://skmtc.dev/m3ter-com/apis/m3ter-api/docs/organizations/:orgId/picklists/creditreasons/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve a list of the Credit Reason entities created for your Organization. You can filter the list returned for the call by Credit Reason ID, Credit Reason short code, or by Archive status.

## Path parameters

- `orgId` string, required

## Query parameters

- `pageSize` integer
- `nextToken` string
- `ids` string[]
- `codes` string[]
- `archived` boolean

## Response `200`

List of CreditReasons

- PaginatedCreditReasonResponseData
  - `data` CreditReasonResponse[]
    - `id` string, required: The UUID of the entity.
    - `version` integer: 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.
    - `code` string: The short code of the data entity.
    - `name` string: The name of the data entity.
    - `archived` boolean: TRUE / FALSE flag indicating whether the data entity is archived. An entity can be archived if it is obsolete.
    - `dtCreated` string, date-time: The DateTime when the credit reason was created *(in ISO-8601 format)*.
    - `dtLastModified` string, date-time: The DateTime when the credit reason was last modified *(in ISO-8601 format)*.
    - `createdBy` string: The id of the user who created this credit reason.
    - `lastModifiedBy` string: The id of the user who last modified this credit reason.
  - `nextToken` string

## Other responses

- `4XX`: Error message
- `5XX`: Error message

## Changes

- **2026-10-16** `85c514abc692`: 2 breaking
  - the `data/items/allOf[#/components/schemas/AbstractPickListResponse]/allOf[subschema #2]/` response's property type changed from no type to `object` for status `200`
  - the `data/items/allOf[subschema #3]/` response's property type changed from no type to `object` for status `200`
- **2025-08-01** `9f9e5f3dbde7`: 1 breaking, 2 info
  - the response's body type changed from no type to `object` for status `200`
  - added the optional property `data` to the response with the `200` status
  - added the optional property `nextToken` to the response with the `200` status
- **2025-02-04** `9433593378b5`: 1 breaking, 2 warning
  - the response's body type changed from `object` to no type for status `200`
  - removed the optional property `data` from the response with the `200` status
  - removed the optional property `nextToken` from the response with the `200` status

[Operation history](https://skmtc.dev/m3ter-com/apis/m3ter-api/changes/organizations/:orgId/picklists/creditreasons/get.md)

---

[API](https://skmtc.dev/m3ter-com/apis/m3ter-api.md) - [All operations](https://skmtc.dev/m3ter-com/apis/m3ter-api/llms.txt) - [OpenAPI document](https://skmtc.dev/m3ter-com/apis/m3ter-api/revisions/85c514abc692?raw)