Companies

Changed on

Lists companies in the caller's network. Supports pagination, sorting, filtering, an unpaginated dropdown mode (isDropDown/hasGeojson), and a trigram-similarity duplicate-company search (findSimilar). Filter members are ANDed; a reserved $or group (filter={"$or":{"name":"x","internalCompanyCode":"x"}}) ORs its own members for a single search box spanning several columns.

get/api/companies

Request

  • Base URL
    https://api.retraced.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.retraced.com/api/companies
  • Auth
    none declared

Query parameters

pageinteger
countinteger
sortstring
filterstring
hasFeaturestring
boolean
OR
string
boolean
OR
string
companyIdsstring
excludeCompanyIdsstring
boolean
OR
string
boolean
OR
string
namestring
boolean
OR
string
boolean
OR
string

Response

Default Response

Changes

  • 46325ef4934dRevision changes
    • info

      for the query request parameter filter, the maxLength was increased from 512 to 2048

  • 97e51f27dc77Revision changes
    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • info

      response property data/items/city list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/items/country list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/items/internalCompanyCode list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/items/name list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/items/notes list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/items/officialName list-of-types was narrowed by removing types null from media type application/json of response 200