Skip to main content

Get Company by lookup key

GET 
/companies/:lookupKey/:lookupValue

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

Request​

Path Parameters

    lookupKey stringrequired

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

Responses​

Get Company by lookup key - 200 / Get Company by lookup key - 200 (expand: sources)

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

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