Get Usergroup by lookup key
GET/usergroups/:lookupKey/:lookupValue
Use this endpoint to retrieve usergroup details by lookup key. If multiple usergroups with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the usergroup (e.g. source
and language
for lookup key source
).
Request
Path Parameters
Lookup key. Read more about usergroup lookup keys
The value of the key (id or sourceId)
Query Parameters
Use expands
as a query parameter to fetch additional information for usergroups like sources, etc.
sources
: if the expands
parameter contains this value, the response from the API will return additional source information descibing where this resource is imported from. If there are no sources for this resource then the sources
property in the response will be just an empty array.
Responses
- 200
- 400
- 404
Get Usergroup by Id - 200 / Get Usergroup by lookup key - 200 (expands: sources)
Response Headers
Connection
string
Content-Length
string
Date
string
Keep-Alive
string
Return-Format
string
- application/json
- Schema
- Example (from schema)
- Get Usergroup by Id - 200
- Get Usergroup by lookup key - 200 (expands: sources)
Schema
- MOD1
- MOD2
data
object
defaultobjectId
object
anyOf
string
number
{
"data": {
"authorizeId": "",
"budget": "N",
"budgetInherit": "Y",
"company": "",
"defaultobjectId": "",
"department": "",
"id": 213,
"inheritOrderList": "N",
"inheritProductList": "Y",
"name": "Netherlands",
"notes": "Usergroup created from API",
"office": "",
"orderListAllowAll": "U",
"orderListManagerId": "",
"sources": [],
"userManagerId": ""
},
"messages": [],
"total": 1
}
{
"data": {
"authorizeId": "",
"budget": "N",
"budgetInherit": "Y",
"company": "",
"defaultobjectId": "",
"department": "",
"id": 213,
"inheritOrderList": "N",
"inheritProductList": "Y",
"name": "Netherlands",
"notes": "Usergroup created from API",
"office": "",
"orderListAllowAll": "U",
"orderListManagerId": "",
"userManagerId": ""
},
"messages": [],
"total": 1
}
{
"data": {
"authorizeId": "",
"budget": "N",
"budgetInherit": "Y",
"company": "Whitepaper Download",
"defaultobjectId": 221701,
"department": "",
"id": 119,
"inheritOrderList": "Y",
"inheritProductList": "Y",
"name": "Whitepaper Download",
"notes": "",
"office": "",
"orderListAllowAll": "U",
"orderListManagerId": "",
"sources": [],
"userManagerId": ""
},
"messages": [],
"total": 1
}
Get Usergroup by lookup key - 400 (invalid lookup key)
Response Headers
Alt-Svc
string
Via
string
alt-svc
string
content-length
string
date
string
return-format
string
server
string
x-request-id
string
- application/json
- Schema
- Example (from schema)
- Get Usergroup by lookup key - 400 (invalid lookup key)
Schema
error
object
{
"error": {
"code": 10006,
"messages": [
"Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"
],
"moreInfo": "https://www.propel.us/docs/errors/10006",
"status": 400,
"type": "InvalidLookupKey"
}
}
{
"error": {
"code": 10006,
"messages": [
"Invalid lookup key [ids], key must contain one of the following values: [id,sourceId,]"
],
"moreInfo": "https://www.propel.us/docs/errors/10006",
"status": 400,
"type": "InvalidLookupKey"
}
}
Get Usergroup by lookup key - 404
Response Headers
Alt-Svc
string
Via
string
alt-svc
string
content-length
string
date
string
return-format
string
server
string
x-request-id
string
- application/json
- Schema
- Example (from schema)
- Get Usergroup by lookup key - 404
Schema
error
object
{
"error": {
"code": 20006,
"messages": [
"Usergroup with id [21315] not found"
],
"moreInfo": "https://www.propel.us/docs/errors/20006",
"status": 404,
"type": "UsergroupNotFound"
}
}
{
"error": {
"code": 20006,
"messages": [
"Usergroup with id [21315] not found"
],
"moreInfo": "https://www.propel.us/docs/errors/20006",
"status": 404,
"type": "UsergroupNotFound"
}
}