GET
/
components
/
v1
/
badge
/
{externalId}
cURL
curl --request GET \
  --url https://api-sandbox.appcharge.com/components/v1/badge/{externalId} \
  --header 'x-publisher-token: <api-key>'
{
  "id": "507f1f77bcf86cd799439011",
  "name": "New Year Celebration",
  "publisherBadgeId": "new_year_celebration",
  "type": "emblem",
  "badgeImageUrl": "https://cdn.appcharge.com/507f1f77bcf86cd799439011_emblem.png",
  "badgeExternalImageUrl": "https://example.com/images/new-year-emblem.png"
}

Authorizations

​
x-publisher-token
string
header
required

Publisher token, as displayed in the Publisher Dashboard.

Path Parameters

​
externalId
string
required

External ID that you defined.

Example:

"new_year_ribbon"

Response

Badge details retrieved successfully.

Response schema for an emblem badge.

​
id
string
required

Badge ID.

Example:

"507f1f77bcf86cd799439011"

​
name
string
required

Badge name.

Example:

"New Year Celebration"

​
publisherBadgeId
string
required

Badge ID that you defined.

Example:

"new_year_celebration"

​
type
enum<string>
required

Badge type.

Available options:
emblem
Example:

"emblem"

​
badgeImageUrl
string<url>
required

URL of badge image stored on Appcharge CDN.

Example:

"https://cdn.appcharge.com/507f1f77bcf86cd799439011_emblem.png"

​
badgeExternalImageUrl
string<url>

Original URL of the badge image if uploaded via external link.

Example:

"https://example.com/images/new-year-emblem.png"