Skip to main content

Get User by lookup key

GET 
/users/:lookupKey/:lookupValue

Use this endpoint to retrieve user details by lookup key. If multiple users with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the user (e.g. source and language for lookup key source).

Request​

Path Parameters

    lookupKey stringrequired

    Lookup key. Read more about user 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 users like sources, parent, 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. parent: use this value in the expands query parameter to get additional information about the container which this resource belongs to. In this particular scenario the parent of a user can be a resource of type usergroup

Responses​

Get User by id - 200 / Get User by lookup key - 200 (expands: sources, parent)

Response Headers

  • Connection

    string

  • Content-Length

    string

  • Date

    string

  • Keep-Alive

    string

  • Return-Format

    string

Schema

    data

    object

    abbreviation string
    company string
    dateOfBirth string
    debtorId string
    email string
    firstName string
    fullName string
    gender string
    id number
    lastName string
    login string
    middleName string
    mobile string

    parent

    object

    authorizeId string
    budget string
    budgetInherit string
    company string
    defaultobjectId number
    department string
    id number
    inheritOrderList string
    inheritProductList string
    name string
    notes string
    office string
    orderListAllowAll string
    orderListManagerId string
    sources undefined[]
    userManagerId string
    phone string
    sources undefined[]
    ssn string
    title string
    vatNumber string
    messages undefined[]
    total number
Loading...