Get an advertiser

GET /advertising/v1.0/advertisers/{advertiserId}

Endpoint for retrieving advertisers.

Path parameters

  • advertiserId string Required

    Id of an advertiser. It is either id that was provided in the response of the insert endpoint or it can be thirdPartyId, if it has been provided in the request body of the advertiser insert endpoint.

Responses

  • 200 application/json

    Advertiser successfully retrieved

    Hide response attributes Show response attributes object
    • success boolean Required
    • data object Required
      Hide data attributes Show data attributes object
      • id 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.

      • fullName string Required
      • email string Required
      • ico string | null
      • phoneNumbers array[string] Required
      • createdAt string(date-time) Required
      • updatedAt string(date-time)
      • 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.

  • Advertiser was not found.

GET /advertising/v1.0/advertisers/{advertiserId}
curl \
 -X GET http://apis.public-staging.reas.cz/advertising/v1.0/advertisers/63d9007e66fc41b2cd1057c6 \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "success": true,
  "data": {
    "id": "string",
    "thirdPartyId": "string",
    "tags": [
      "string"
    ],
    "advertisingCompanyId": "string",
    "advertisingCompanyThirdPartyId": "string",
    "fullName": "string",
    "email": "string",
    "profileImageUrl": "string",
    "ico": "string",
    "phoneNumbers": [
      "string"
    ],
    "createdAt": "2024-05-04T09:42:00+00:00",
    "updatedAt": "2024-05-04T09:42:00+00:00",
    "dic": "string",
    "location": "string",
    "locationAccuracy": "exact"
  }
}