Skip to main content

Get Customer by lookup key

GET 
/customers/:lookupKey/:lookupValue

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

Request​

Path Parameters

    lookupKey stringrequired

    Lookup key. Read more about customer 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 customers 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 customer can be a resource of type usergroup

Responses​

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

Response Headers

  • Alt-Svc

    string

  • Via

    string

  • alt-svc

    string

  • content-length

    string

  • date

    string

  • return-format

    string

  • x-request-id

    string

Schema

    data

    object

    abbreviation string
    dateOfBirth string
    debtorId string
    email string
    fax string
    firstName string
    gender string
    id number
    lastName string
    login string
    middleName string
    mobile string
    name 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

    object[]

  • Array [

    • language string
    source string
    sourceId string

  • ]

    • userManagerId string
    phone string
    pricelistAmount string
    pricelistPercentage string
    primaryLanguage string

    sources

    object[]

  • Array [

    • language string
    source string
    sourceId string

  • ]

    • ssn string
    title string
    messages undefined[]
    total number
Loading...