Openpath orgs/badgeConfigs API
The orgs/badgeConfigs API from Openpath — 2 operation(s) for orgs/badgeconfigs.
OpenAPI Specification
swagger: '2.0'
info:
title: Openpath API Documentation auth orgs/badgeConfigs API
version: 1.0.0
description: Authentication and Login
host: api.openpath.com
schemes:
- https
consumes:
- application/json
produces:
- application/json
tags:
- name: orgs/badgeConfigs
paths:
/orgs/{orgId}/badgeConfigs:
get:
summary: List all badge configs
operationId: listBadgeConfigs
description: '__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'
parameters:
- type: integer
name: orgId
in: path
required: true
- type: integer
minimum: 1
maximum: 1000
name: limit
in: query
- type: integer
default: 0
minimum: 0
name: offset
in: query
- type: string
default: id
pattern: ^[a-zA-Z0-9.]+(,\s*[a-zA-Z0-9.]+)*$
name: sort
in: query
- type: string
default: asc
pattern: ^(asc|desc)+(,\s*(asc|desc)+)*$
name: order
in: query
- type: string
name: q
in: query
- type: string
name: filter
in: query
- type: string
name: preFilter
in: query
consumes:
- application/json
produces:
- application/json
tags:
- orgs/badgeConfigs
security:
- jwt: []
responses:
'200':
schema:
type: object
properties:
totalCount:
type: integer
filteredCount:
type: integer
data:
type: array
items:
type: object
properties:
id:
type: number
nameConfig:
x-nullable: true
type: object
properties:
isEnabled:
type: boolean
x-nullable: true
color:
type: string
x-nullable: true
fontFamily:
type: string
x-nullable: true
fontSize:
type: number
minimum: 0
maximum: 1
x-nullable: true
lineHeight:
type: number
minimum: 0
maximum: 1
x-nullable: true
fontWeight:
type: number
x-nullable: true
fontStyle:
x-nullable: true
type: string
enum:
- italic
- oblique
- none
textAlign:
x-nullable: true
type: string
enum:
- left
- center
- right
centerX:
type: number
minimum: 0
maximum: 1
x-nullable: true
centerY:
type: number
minimum: 0
maximum: 1
x-nullable: true
width:
type: number
minimum: 0
maximum: 1
x-nullable: true
height:
type: number
minimum: 0
maximum: 1
x-nullable: true
layout:
x-nullable: true
type: string
enum:
- threeLines
- twoLines
- oneLine
textTransform:
x-nullable: true
type: string
enum:
- none
- uppercase
- lowercase
- capitalize
customField1Config:
x-nullable: true
type: object
properties:
isEnabled:
type: boolean
x-nullable: true
color:
type: string
x-nullable: true
fontFamily:
type: string
x-nullable: true
fontSize:
type: number
minimum: 0
maximum: 1
x-nullable: true
lineHeight:
type: number
minimum: 0
maximum: 1
x-nullable: true
fontWeight:
type: number
x-nullable: true
textAlign:
x-nullable: true
type: string
enum:
- left
- center
- right
centerX:
type: number
minimum: 0
maximum: 1
x-nullable: true
centerY:
type: number
minimum: 0
maximum: 1
x-nullable: true
width:
type: number
minimum: 0
maximum: 1
x-nullable: true
height:
type: number
minimum: 0
maximum: 1
x-nullable: true
customField2Config:
x-nullable: true
type: object
properties:
isEnabled:
type: boolean
x-nullable: true
color:
type: string
x-nullable: true
fontFamily:
type: string
x-nullable: true
fontSize:
type: number
minimum: 0
maximum: 1
x-nullable: true
lineHeight:
type: number
minimum: 0
maximum: 1
x-nullable: true
fontWeight:
type: number
x-nullable: true
textAlign:
x-nullable: true
type: string
enum:
- left
- center
- right
centerX:
type: number
minimum: 0
maximum: 1
x-nullable: true
centerY:
type: number
minimum: 0
maximum: 1
x-nullable: true
width:
type: number
minimum: 0
maximum: 1
x-nullable: true
height:
type: number
minimum: 0
maximum: 1
x-nullable: true
backgroundConfig:
x-nullable: true
type: object
properties:
isEnabled:
type: boolean
x-nullable: true
backgroundColor:
type: string
x-nullable: true
centerX:
type: number
minimum: 0
maximum: 1
x-nullable: true
centerY:
type: number
minimum: 0
maximum: 1
x-nullable: true
width:
type: number
minimum: 0
maximum: 1
x-nullable: true
height:
type: number
minimum: 0
maximum: 1
x-nullable: true
photoConfig:
x-nullable: true
type: object
properties:
isEnabled:
type: boolean
x-nullable: true
backgroundColor:
type: string
x-nullable: true
centerX:
type: number
minimum: 0
maximum: 1
x-nullable: true
centerY:
type: number
minimum: 0
maximum: 1
x-nullable: true
width:
type: number
minimum: 0
maximum: 1
x-nullable: true
height:
type: number
minimum: 0
maximum: 1
x-nullable: true
borderRadius:
type: number
minimum: 0
maximum: 1
x-nullable: true
borderColor:
type: string
x-nullable: true
logoConfig:
x-nullable: true
type: object
properties:
isEnabled:
type: boolean
x-nullable: true
backgroundColor:
type: string
x-nullable: true
backgroundPosition:
type: string
x-nullable: true
label:
type: string
x-nullable: true
color:
type: string
x-nullable: true
fontFamily:
type: string
x-nullable: true
fontSize:
type: number
minimum: 0
maximum: 1
x-nullable: true
lineHeight:
type: number
minimum: 0
maximum: 1
x-nullable: true
fontWeight:
type: number
x-nullable: true
textAlign:
x-nullable: true
type: string
enum:
- left
- center
- right
centerX:
type: number
minimum: 0
maximum: 1
x-nullable: true
centerY:
type: number
minimum: 0
maximum: 1
x-nullable: true
width:
type: number
minimum: 0
maximum: 1
x-nullable: true
height:
type: number
minimum: 0
maximum: 1
x-nullable: true
externalIdConfig:
x-nullable: true
type: object
properties:
isEnabled:
type: boolean
x-nullable: true
color:
type: string
x-nullable: true
fontFamily:
type: string
x-nullable: true
fontSize:
type: number
minimum: 0
maximum: 1
x-nullable: true
lineHeight:
type: number
minimum: 0
maximum: 1
x-nullable: true
fontWeight:
type: number
x-nullable: true
textAlign:
x-nullable: true
type: string
enum:
- left
- center
- right
centerX:
type: number
minimum: 0
maximum: 1
x-nullable: true
centerY:
type: number
minimum: 0
maximum: 1
x-nullable: true
width:
type: number
minimum: 0
maximum: 1
x-nullable: true
height:
type: number
minimum: 0
maximum: 1
x-nullable: true
customField1:
x-nullable: true
type: object
properties:
id:
type: number
name:
type: string
required:
- id
customField2:
x-nullable: true
type: object
properties:
id:
type: number
name:
type: string
required:
- id
badgeDefaultConfig:
type: object
properties:
id:
type: integer
nameConfig:
type: object
properties:
isEnabled:
type: boolean
x-nullable: true
color:
type: string
x-nullable: true
fontFamily:
type: string
x-nullable: true
fontSize:
type: number
minimum: 0
maximum: 1
x-nullable: true
lineHeight:
type: number
minimum: 0
maximum: 1
x-nullable: true
fontWeight:
type: number
x-nullable: true
fontStyle:
x-nullable: true
type: string
enum:
- italic
- oblique
- none
textAlign:
x-nullable: true
type: string
enum:
- left
- center
- right
centerX:
type: number
minimum: 0
maximum: 1
x-nullable: true
centerY:
type: number
minimum: 0
maximum: 1
x-nullable: true
width:
type: number
minimum: 0
maximum: 1
x-nullable: true
height:
type: number
minimum: 0
maximum: 1
x-nullable: true
layout:
x-nullable: true
type: string
enum:
- threeLines
- twoLines
- oneLine
textTransform:
x-nullable: true
type: string
enum:
- none
- uppercase
- lowercase
- capitalize
customField1Config:
type: object
properties:
isEnabled:
type: boolean
x-nullable: true
color:
type: string
x-nullable: true
fontFamily:
type: string
x-nullable: true
fontSize:
type: number
minimum: 0
maximum: 1
x-nullable: true
lineHeight:
type: number
minimum: 0
maximum: 1
x-nullable: true
fontWeight:
type: number
x-nullable: true
textAlign:
x-nullable: true
type: string
enum:
- left
- center
- right
centerX:
type: number
minimum: 0
maximum: 1
x-nullable: true
centerY:
type: number
minimum: 0
maximum: 1
x-nullable: true
width:
type: number
minimum: 0
maximum: 1
x-nullable: true
height:
type: number
minimum: 0
maximum: 1
x-nullable: true
customField2Config:
type: object
properties:
isEnabled:
type: boolean
x-nullable: true
color:
type: string
x-nullable: true
fontFamily:
type: string
x-nullable: true
fontSize:
type: number
minimum: 0
maximum: 1
x-nullable: true
lineHeight:
type: number
minimum: 0
maximum: 1
x-nullable: true
fontWeight:
type: number
x-nullable: true
textAlign:
x-nullable: true
type: string
enum:
- left
- center
- right
centerX:
type: number
minimum: 0
maximum: 1
x-nullable: true
centerY:
type: number
minimum: 0
maximum: 1
x-nullable: true
width:
type: number
minimum: 0
maximum: 1
x-nullable: true
height:
type: number
minimum: 0
maximum: 1
x-nullable: true
backgroundConfig:
type: object
properties:
isEnabled:
type: boolean
x-nullable: true
backgroundColor:
type: string
x-nullable: true
centerX:
type: number
minimum: 0
maximum: 1
x-nullable: true
centerY:
type: number
minimum: 0
maximum: 1
x-nullable: true
width:
type: number
minimum: 0
maximum: 1
x-nullable: true
height:
type: number
minimum: 0
maximum: 1
x-nullable: true
photoConfig:
type: object
properties:
isEnabled:
type: boolean
x-nullable: true
backgroundColor:
type: string
x-nullable: true
centerX:
type: number
minimum: 0
maximum: 1
x-nullable: true
centerY:
type: number
minimum: 0
maximum: 1
x-nullable: true
width:
type: number
minimum: 0
maximum: 1
x-nullable: true
height:
type: number
minimum: 0
maximum: 1
x-nullable: true
borderRadius:
type: number
minimum: 0
maximum: 1
x-nullable: true
borderColor:
type: string
x-nullable: true
logoConfig:
type: object
properties:
isEnabled:
type: boolean
x-nullable: true
backgroundColor:
type: string
x-nullable: true
backgroundPosition:
type: string
x-nullable: true
label:
type: string
x-nullable: true
color:
type: string
x-nullable: true
fontFamily:
type: string
x-nullable: true
fontSize:
type: number
minimum: 0
maximum: 1
x-nullable: true
lineHeight:
type: number
minimum: 0
maximum: 1
x-nullable: true
fontWeight:
type: number
x-nullable: true
textAlign:
x-nullable: true
type: string
enum:
- left
- center
- right
centerX:
type: number
minimum: 0
maximum: 1
x-nullable: true
centerY:
type: number
minimum: 0
maximum: 1
x-nullable: true
width:
type: number
minimum: 0
maximum: 1
x-nullable: true
height:
type: number
minimum: 0
maximum: 1
x-nullable: true
externalIdConfig:
type: object
properties:
isEnabled:
type: boolean
x-nullable: true
color:
type: string
x-nullable: true
fontFamily:
type: string
x-nullable: true
fontSize:
type: number
minimum: 0
maximum: 1
x-nullable: true
lineHeight:
type: number
minimum: 0
maximum: 1
x-nullable: true
fontWeight:
type: number
x-nullable: true
textAlign:
x-nullable: true
type: string
enum:
- left
- center
- right
centerX:
type: number
minimum: 0
maximum: 1
x-nullable: true
centerY:
type: number
minimum: 0
maximum: 1
x-nullable: true
width:
type: number
minimum: 0
maximum: 1
x-nullable: true
height:
type: number
minimum: 0
maximum: 1
x-nullable: true
backgroundPicture:
x-nullable: true
type: object
properties:
contentType:
type: string
fileName:
type: string
url:
type: string
x-nullable: true
logoPicture:
x-nullable: true
type: object
properties:
contentType:
type: string
fileName:
type: string
url:
type: string
x-nullable: true
badgeWidth:
type: number
badgeHeight:
type: number
badgeBorderRadius:
type: number
printWidth
# --- truncated at 32 KB (123 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/openpath/refs/heads/main/openapi/openpath-orgs-badgeconfigs-api-openapi.yml