---
title: "Describe user badge"
method: GET
path: "/orgs/{orgId}/users/{userId}/badge"
tags: ["orgs/users"]
---

# Describe user badge

`GET /orgs/{orgId}/users/{userId}/badge`

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

## Path parameters

- `orgId` integer, required
- `userId` integer, required

## Response `200`

Successful

- object
  - `data` object
    - `userBadgeNameConfig` 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
      - `label` string, nullable
      - `label2` string, nullable
      - `label3` string, nullable
    - `userBadgeCustomField1Config` 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
      - `label` string, nullable
    - `userBadgeCustomField2Config` 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
      - `label` string, nullable
    - `userBadgeExternalIdConfig` 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
      - `label` string, nullable
    - `userBadgeBackgroundConfig` object
      - `isEnabled` boolean, nullable
      - `backgroundColor` string, nullable
      - `centerX` number, nullable
      - `centerY` number, nullable
      - `width` number, nullable
      - `height` number, nullable
      - `src` string, nullable
    - `userBadgePhotoConfig` 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
      - `src` string, nullable
    - `userBadgeLogoConfig` 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
      - `src` string, nullable
    - `userBadgeBadgeWidth` number
    - `userBadgeBadgeHeight` number
    - `userBadgeBadgeBorderRadius` number
  - `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/versions/d8a888c114fa/schema)