Users
Authorizations
Path parameters
idOrEntityIdstringRequired
Responses
200
OK
application/json
400
Bad Request
*/*
get
GET /v2/users/{idOrEntityId} HTTP/1.1
Host: api.badgr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"status": {
"success": true,
"description": "ok"
},
"result": [
{
"id": "5f16c84d1ff787222b6c4d15",
"entityType": "BadgeUser",
"entityId": "Hey7J-GRSJeu6FNnHQwNyw",
"firstName": "Jane",
"lastName": "Doe",
"emails": [
{
"email": "[email protected]",
"verified": true,
"primary": true,
"caseVariants": [
"text"
]
}
],
"url": [
"https://example.com"
],
"telephone": [
"text"
],
"badgrDomain": "badgrsupportgroup.badgr.com",
"agreedTermsVersion": 4,
"hasAgreedToLatestTermsVersion": true,
"marketingOptIn": true,
"hasPasswordSet": true,
"recipient": {
"identity": "[email protected]",
"type": "email"
}
}
],
"timestamp": "2025-07-24T05:36:11.289Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}
Authorizations
Path parameters
idOrEntityIdstringRequired
Body
firstNamestringOptionalExample:
Jane
lastNamestringOptionalExample:
Doe
marketingOptInbooleanOptionalExample:
true
Responses
200
OK
application/json
400
Bad Request
*/*
put
PUT /v2/users/{idOrEntityId} HTTP/1.1
Host: api.badgr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 59
{
"firstName": "Jane",
"lastName": "Doe",
"marketingOptIn": true
}
{
"status": {
"success": true,
"description": "ok"
},
"result": [
{
"id": "5f16c84d1ff787222b6c4d15",
"entityType": "BadgeUser",
"entityId": "Hey7J-GRSJeu6FNnHQwNyw",
"firstName": "Jane",
"lastName": "Doe",
"emails": [
{
"email": "[email protected]",
"verified": true,
"primary": true,
"caseVariants": [
"text"
]
}
],
"url": [
"https://example.com"
],
"telephone": [
"text"
],
"badgrDomain": "badgrsupportgroup.badgr.com",
"agreedTermsVersion": 4,
"hasAgreedToLatestTermsVersion": true,
"marketingOptIn": true,
"hasPasswordSet": true,
"recipient": {
"identity": "[email protected]",
"type": "email"
}
}
],
"timestamp": "2025-07-24T05:36:11.289Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}
Authorizations
Path parameters
idOrEntityIdstringRequired
Body
firstNamestringOptionalExample:
Jane
lastNamestringOptionalExample:
Doe
marketingOptInbooleanOptionalExample:
true
Responses
200
OK
application/json
400
Bad Request
*/*
patch
PATCH /v2/users/{idOrEntityId} HTTP/1.1
Host: api.badgr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 59
{
"firstName": "Jane",
"lastName": "Doe",
"marketingOptIn": true
}
{
"status": {
"success": true,
"description": "ok"
},
"result": [
{
"id": "5f16c84d1ff787222b6c4d15",
"entityType": "BadgeUser",
"entityId": "Hey7J-GRSJeu6FNnHQwNyw",
"firstName": "Jane",
"lastName": "Doe",
"emails": [
{
"email": "[email protected]",
"verified": true,
"primary": true,
"caseVariants": [
"text"
]
}
],
"url": [
"https://example.com"
],
"telephone": [
"text"
],
"badgrDomain": "badgrsupportgroup.badgr.com",
"agreedTermsVersion": 4,
"hasAgreedToLatestTermsVersion": true,
"marketingOptIn": true,
"hasPasswordSet": true,
"recipient": {
"identity": "[email protected]",
"type": "email"
}
}
],
"timestamp": "2025-07-24T05:36:11.289Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}
Authorizations
Responses
200
OK
application/json
400
Bad Request
*/*
get
GET /v2/users/self HTTP/1.1
Host: api.badgr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"status": {
"success": true,
"description": "ok"
},
"result": [
{
"id": "5f16c84d1ff787222b6c4d15",
"entityType": "BadgeUser",
"entityId": "Hey7J-GRSJeu6FNnHQwNyw",
"firstName": "Jane",
"lastName": "Doe",
"emails": [
{
"email": "[email protected]",
"verified": true,
"primary": true,
"caseVariants": [
"text"
]
}
],
"url": [
"https://example.com"
],
"telephone": [
"text"
],
"badgrDomain": "badgrsupportgroup.badgr.com",
"agreedTermsVersion": 4,
"hasAgreedToLatestTermsVersion": true,
"marketingOptIn": true,
"hasPasswordSet": true,
"recipient": {
"identity": "[email protected]",
"type": "email"
}
}
],
"timestamp": "2025-07-24T05:36:11.289Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}
Authorizations
Body
firstNamestringOptionalExample:
Jane
lastNamestringOptionalExample:
Doe
marketingOptInbooleanOptionalExample:
true
Responses
200
OK
application/json
400
Bad Request
*/*
put
PUT /v2/users/self HTTP/1.1
Host: api.badgr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 59
{
"firstName": "Jane",
"lastName": "Doe",
"marketingOptIn": true
}
{
"status": {
"success": true,
"description": "ok"
},
"result": [
{
"id": "5f16c84d1ff787222b6c4d15",
"entityType": "BadgeUser",
"entityId": "Hey7J-GRSJeu6FNnHQwNyw",
"firstName": "Jane",
"lastName": "Doe",
"emails": [
{
"email": "[email protected]",
"verified": true,
"primary": true,
"caseVariants": [
"text"
]
}
],
"url": [
"https://example.com"
],
"telephone": [
"text"
],
"badgrDomain": "badgrsupportgroup.badgr.com",
"agreedTermsVersion": 4,
"hasAgreedToLatestTermsVersion": true,
"marketingOptIn": true,
"hasPasswordSet": true,
"recipient": {
"identity": "[email protected]",
"type": "email"
}
}
],
"timestamp": "2025-07-24T05:36:11.289Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}
Authorizations
Body
firstNamestringOptionalExample:
Jane
lastNamestringOptionalExample:
Doe
marketingOptInbooleanOptionalExample:
true
Responses
200
OK
application/json
400
Bad Request
*/*
patch
PATCH /v2/users/self HTTP/1.1
Host: api.badgr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 59
{
"firstName": "Jane",
"lastName": "Doe",
"marketingOptIn": true
}
{
"status": {
"success": true,
"description": "ok"
},
"result": [
{
"id": "5f16c84d1ff787222b6c4d15",
"entityType": "BadgeUser",
"entityId": "Hey7J-GRSJeu6FNnHQwNyw",
"firstName": "Jane",
"lastName": "Doe",
"emails": [
{
"email": "[email protected]",
"verified": true,
"primary": true,
"caseVariants": [
"text"
]
}
],
"url": [
"https://example.com"
],
"telephone": [
"text"
],
"badgrDomain": "badgrsupportgroup.badgr.com",
"agreedTermsVersion": 4,
"hasAgreedToLatestTermsVersion": true,
"marketingOptIn": true,
"hasPasswordSet": true,
"recipient": {
"identity": "[email protected]",
"type": "email"
}
}
],
"timestamp": "2025-07-24T05:36:11.289Z",
"validationErrors": [
"text"
],
"nonFieldErrors": [
"text"
],
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"errorCode": "text",
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1
}
Last updated
Was this helpful?