Skip to main content

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

    lookupKey stringrequired

    Lookup key. Read more about usergroup lookup keys

    lookupValue stringrequired

    The value of the key (id or sourceId)

Query Parameters

    expands string

    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​

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

Schema

    data

    object

    authorizeId string
    budget string
    budgetInherit string
    company string

    defaultobjectId

    object

    anyOf

    string

    department string
    id number
    inheritOrderList string
    inheritProductList string
    name string
    notes string
    office string
    orderListAllowAll string
    orderListManagerId string
    sources undefined[]
    userManagerId string
    messages undefined[]
    total number
Loading...