Query parameters

• page number(float)

  Page

  Minimum value is 1. Default value is 1.

• tag string

Responses

• 200 application/json

  List of companies successfully retrieved

  Hide response attributes Show response attributes object

  • success boolean Required
  • data array[object] Required
    Hide data attributes Show data attributes object

    • id string Required
    • thirdPartyId string

      Optional custom id that can later be used instead of normal id in insert, update, delete etc. endpoints

    • name string Required
    • tags array[string] | null

      Tags are strings that can be used to categorize an entities and then filter them in the list endpoints. For example, if you have multiple companies or advertisers that are a part of a larger franchise, you can assign a tag that will refer to that franchise and then use it in the list endpoints to find only the entities that are a part of that franchise.

    • email string Required
    • websiteUrl string | null
    • phoneNumbers array[string]
    • profileImageUrl string
    • ico string | null
    • dic string | null
    • location string | null
    • locationAccuracy string | null

      Accuracy of the provided location. If not provided upon insertion, will default to exact.

      • If accuracy is missing or is set to exact we will display the exact location that was provided.
      • If accuracy is set to other value we will try to find the closest entity of provided type, if we don't find it we will display the nearest non-exact entity we can find (eg. street)

      Values are exact, street, municipality_part, municipality, cadastral_area, or nearest_non_exact_geo_entity.

    • Additional properties are NOT allowed
  • paginationInfo object Required
    Hide paginationInfo attributes Show paginationInfo attributes object

    • page number(float) Required
    • pages number(float) Required
    • Additional properties are NOT allowed
  • Additional properties are NOT allowed