Companies

Create a new company. The structured address is required: city and addressLine1, plus zipCode unless the country has no postal codes; addressLine2 is optional. Without geojson, the pin falls back to the country centroid.

post/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

Request body

officialNamestring required
namestring
countrystring required
companySize'FROM_0_TO_1' | 'FROM_2_TO_10' | 'FROM_11_TO_50' | 'FROM_51_TO_200' | 'FROM_201_TO_500' | 'FROM_501_TO_1000' | 'FROM_1001_TO_5000' | 'FROM_5001_TO_10000' | 'FROM_10001_TO_INFINITE'
companyType'EDUCATIONAL_INSTITUTION' | 'GOVERNMENT_AGENCY' | 'NONPROFIT' | 'PARTNERSHIP' | 'PRIVATELY_HELD' | 'FAMILY_BUSINESS' | 'PUBLIC_COMPANY' | 'SELF_EMPLOYED' | 'SOLE_PROPRIETORSHIP'
facilityProcessesstring required
connectionType'SUPPLIER' | 'CLIENT' required
onBehalfOfCompanyIdstring
addressLine1string required
addressLine2string
citystring required
zipCodestring
geojsonunknown

Response

Default Response

Changes

    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property's minLength was increased from 0 to 1

    • breaking

      the request property's minLength was increased from 0 to 1

    • info

      added the new optional request property

    • info

      added the new optional request property

    • 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

    • 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

    • 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

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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