---
title: "List all badge configs"
method: GET
path: "/orgs/{orgId}/badgeConfigs"
tags: ["orgs/badgeConfigs"]
---

# List all badge configs

`GET /orgs/{orgId}/badgeConfigs`

__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-configurations:r,o{params.orgId}-badgePrinting:r,o{params.orgId}-badgePrinting:w,o{params.orgId}-mobileAppSettings:w,o{params.orgId}-mobileAppSettings:r,o{params.orgId}-user:w,o{params.orgId}-user:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listBadgeConfigs

## Path parameters

- `orgId` integer, required

## Query parameters

- `limit` integer
- `offset` integer
- `sort` string
- `order` string
- `q` string
- `filter` string
- `preFilter` string

## Response `200`

Successful

- object
  - `totalCount` integer
  - `filteredCount` integer
  - `data` object[]
    - `id` number, required
    - `nameConfig` object, nullable
      - `isEnabled` boolean, nullable
      - `color` string, nullable
      - `fontFamily` string, nullable
      - `fontSize` number, nullable
      - `lineHeight` number, nullable
      - `fontWeight` number, nullable
      - `fontStyle` 'italic' | 'oblique' | 'none', nullable
      - `textAlign` 'left' | 'center' | 'right', nullable
      - `centerX` number, nullable
      - `centerY` number, nullable
      - `width` number, nullable
      - `height` number, nullable
      - `layout` 'threeLines' | 'twoLines' | 'oneLine', nullable
      - `textTransform` 'none' | 'uppercase' | 'lowercase' | 'capitalize', nullable
    - `customField1Config` object, nullable
      - `isEnabled` boolean, nullable
      - `color` string, nullable
      - `fontFamily` string, nullable
      - `fontSize` number, nullable
      - `lineHeight` number, nullable
      - `fontWeight` number, nullable
      - `textAlign` 'left' | 'center' | 'right', nullable
      - `centerX` number, nullable
      - `centerY` number, nullable
      - `width` number, nullable
      - `height` number, nullable
    - `customField2Config` object, nullable
      - `isEnabled` boolean, nullable
      - `color` string, nullable
      - `fontFamily` string, nullable
      - `fontSize` number, nullable
      - `lineHeight` number, nullable
      - `fontWeight` number, nullable
      - `textAlign` 'left' | 'center' | 'right', nullable
      - `centerX` number, nullable
      - `centerY` number, nullable
      - `width` number, nullable
      - `height` number, nullable
    - `backgroundConfig` object, nullable
      - `isEnabled` boolean, nullable
      - `backgroundColor` string, nullable
      - `centerX` number, nullable
      - `centerY` number, nullable
      - `width` number, nullable
      - `height` number, nullable
    - `photoConfig` object, nullable
      - `isEnabled` boolean, nullable
      - `backgroundColor` string, nullable
      - `centerX` number, nullable
      - `centerY` number, nullable
      - `width` number, nullable
      - `height` number, nullable
      - `borderRadius` number, nullable
      - `borderColor` string, nullable
    - `logoConfig` object, nullable
      - `isEnabled` boolean, nullable
      - `backgroundColor` string, nullable
      - `backgroundPosition` string, nullable
      - `label` string, nullable
      - `color` string, nullable
      - `fontFamily` string, nullable
      - `fontSize` number, nullable
      - `lineHeight` number, nullable
      - `fontWeight` number, nullable
      - `textAlign` 'left' | 'center' | 'right', nullable
      - `centerX` number, nullable
      - `centerY` number, nullable
      - `width` number, nullable
      - `height` number, nullable
    - `externalIdConfig` object, nullable
      - `isEnabled` boolean, nullable
      - `color` string, nullable
      - `fontFamily` string, nullable
      - `fontSize` number, nullable
      - `lineHeight` number, nullable
      - `fontWeight` number, nullable
      - `textAlign` 'left' | 'center' | 'right', nullable
      - `centerX` number, nullable
      - `centerY` number, nullable
      - `width` number, nullable
      - `height` number, nullable
    - `customField1` object, nullable
      - `id` number, required
      - `name` string
    - `customField2` object, nullable
      - `id` number, required
      - `name` string
    - `badgeDefaultConfig` object
      - `id` integer, required
      - `nameConfig` object
        - `isEnabled` boolean, nullable
        - `color` string, nullable
        - `fontFamily` string, nullable
        - `fontSize` number, nullable
        - `lineHeight` number, nullable
        - `fontWeight` number, nullable
        - `fontStyle` 'italic' | 'oblique' | 'none', nullable
        - `textAlign` 'left' | 'center' | 'right', nullable
        - `centerX` number, nullable
        - `centerY` number, nullable
        - `width` number, nullable
        - `height` number, nullable
        - `layout` 'threeLines' | 'twoLines' | 'oneLine', nullable
        - `textTransform` 'none' | 'uppercase' | 'lowercase' | 'capitalize', nullable
      - `customField1Config` object
        - `isEnabled` boolean, nullable
        - `color` string, nullable
        - `fontFamily` string, nullable
        - `fontSize` number, nullable
        - `lineHeight` number, nullable
        - `fontWeight` number, nullable
        - `textAlign` 'left' | 'center' | 'right', nullable
        - `centerX` number, nullable
        - `centerY` number, nullable
        - `width` number, nullable
        - `height` number, nullable
      - `customField2Config` object
        - `isEnabled` boolean, nullable
        - `color` string, nullable
        - `fontFamily` string, nullable
        - `fontSize` number, nullable
        - `lineHeight` number, nullable
        - `fontWeight` number, nullable
        - `textAlign` 'left' | 'center' | 'right', nullable
        - `centerX` number, nullable
        - `centerY` number, nullable
        - `width` number, nullable
        - `height` number, nullable
      - `backgroundConfig` object
        - `isEnabled` boolean, nullable
        - `backgroundColor` string, nullable
        - `centerX` number, nullable
        - `centerY` number, nullable
        - `width` number, nullable
        - `height` number, nullable
      - `photoConfig` object
        - `isEnabled` boolean, nullable
        - `backgroundColor` string, nullable
        - `centerX` number, nullable
        - `centerY` number, nullable
        - `width` number, nullable
        - `height` number, nullable
        - `borderRadius` number, nullable
        - `borderColor` string, nullable
      - `logoConfig` object
        - `isEnabled` boolean, nullable
        - `backgroundColor` string, nullable
        - `backgroundPosition` string, nullable
        - `label` string, nullable
        - `color` string, nullable
        - `fontFamily` string, nullable
        - `fontSize` number, nullable
        - `lineHeight` number, nullable
        - `fontWeight` number, nullable
        - `textAlign` 'left' | 'center' | 'right', nullable
        - `centerX` number, nullable
        - `centerY` number, nullable
        - `width` number, nullable
        - `height` number, nullable
      - `externalIdConfig` object
        - `isEnabled` boolean, nullable
        - `color` string, nullable
        - `fontFamily` string, nullable
        - `fontSize` number, nullable
        - `lineHeight` number, nullable
        - `fontWeight` number, nullable
        - `textAlign` 'left' | 'center' | 'right', nullable
        - `centerX` number, nullable
        - `centerY` number, nullable
        - `width` number, nullable
        - `height` number, nullable
      - `backgroundPicture` object, nullable
        - `contentType` string
        - `fileName` string
        - `url` string, nullable
      - `logoPicture` object, nullable
        - `contentType` string
        - `fileName` string
        - `url` string, nullable
      - `badgeWidth` number
      - `badgeHeight` number
      - `badgeBorderRadius` number
      - `printWidth` number, nullable
      - `printHeight` number, nullable
      - `name` string
      - `isMobile` boolean
    - `backgroundPicture` object, nullable
      - `contentType` string
      - `fileName` string
      - `url` string, nullable
    - `logoPicture` object, nullable
      - `contentType` string
      - `fileName` string
      - `url` string, nullable
    - `name` string, nullable
    - `badgeBorderRadius` integer, nullable
    - `isOrgDefault` boolean, nullable
  - `meta` object
    - `accessToken` object, nullable
      - `scopeUpdatedAt` string, date
    - `siteSpecificAccess` object, nullable
      - `isSiteSpecific` boolean
      - `siteIds` integer[], nullable
      - `siteIdsByScope` object, nullable
        - `string` integer[], nullable

---

[API](https://skmtc.net/openpath/apis/openpath-api-documentation.md) · [All operations](https://skmtc.net/openpath/apis/openpath-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/openpath/openpath-api-documentation/revisions/d8a888c114fa/schema)