Skip to main content

Search Companies

POST 
/companies/search

> The companies search endpoint is only available on the Propeller cloud version.

Retrieves a list of companies by using the search fields below. Results will be paginated.

FieldType
dateCreatedDateFilter
dateModifiedDateFilter
offsetinteger
pageinteger

Date filter​

A date filter is a special date search object that can search through a range:

{
    "from": "2020-12-12T00:00:00",
    "to": "2022-12-12T00:00:00"
}

Request​

Query Parameters

    expands string

    Use expands as a query parameter to fetch additional information for companies like sources, parent, etc. sources: if the "expands" parameter contains this value, the response from the API will return additional source information describing 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.

Body

    dateCreated

    object

    from string
    to string

    dateModified

    object

    from string
    to string
    name string
    offset number
    page number

Responses​

Search Companies - 200

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[]

  • Array [

    • authorizeId string
    budget string
    budgetInherit string
    cocNumber string
    company string
    dateCreated string
    dateModified string

    defaultobjectId

    object

    anyOf

    string

    department string
    id number
    inheritOrderList string
    inheritProductList string
    name string
    notes string
    office string
    orderListAllowAll string
    orderListManagerId string
    taxNumber string
    userManagerId string

  • ]

    • end number
    itemsFound number
    messages string[]
    offset number
    page number
    pages number
    start number
    total number
Loading...