Need help? Call Live Support at +31 (0) 38 453 07 59

Attention! You're currently using the OT&E environment.

Get Brand

Used to get a brand

  • GETMethod
  • /v2/customers/customer/brands/handleURL
URL fields
Name Type Description Restrictions
customer String The handle of the customer
  • Regular expression: [a-zA-Z0-9\-_@\.]+
  • Minimum length: 3
  • Maximum length: 40
handle String The handle of the brand
  • Regular expression: [a-zA-Z0-9\-_@\.]+
  • Minimum length: 3
  • Maximum length: 40
Request parameters
Name Type Required / Optional Description Restrictions
fields String Optional Select fields to include in the response, comma separated list of field names. Requesting only the needed fields improves response time, especially when omitting relation fields. Identifying field(s) are always included.

Successful request

Brand has been retrieved successfully
  • 200 OKHTTP Status
  • application/jsonContent-Type
Response fields
Name Type Required / Optional Description
hideOptionalTerms Boolean Optional Indicates whether contact validations should hide optional terms if they fall under this brand.
customer String Required The customer handle
handle String Required The brand handle
locale Enum Required

Possible values:

  • en-US: English (US)
  • nl-NL: Dutch (NL)
  • ko-KR: Korean (KR)
  • tr-TR: Turkish (TR)
  • it-IT: Italian (IT)
  • fr-FR: French (FR)
  • uk-UA: Ukrainian (UA)
  • da-DK: Danish (DK)
  • es-ES: Spanish (ES)
organization String Required The name of the organization
addressLine List <String> Required The address lines
postalCode String Required Postal code
city String Required The city
state String Optional The state
country String Required The ISO 3166-1 alpha2 country code
email String Required The email address
url String Optional The webiste address
voice String Required The voice telephone number
fax String Optional The fax telephone number
privacyContact String Optional The handle of the contact used for domains with privacy protect
abuseContact String Optional The handle of the contact to be exposed publicly in the WHOIS/RDAP for abuse cases
createdDate Timestamp Required The date the brand was created
updatedDate Timestamp Optional The date the brand was last updated

Failed requests

Generic errors can be expected.

URL fields
The handle of the customer
The handle of the brand
Request parameters
Select fields to include in the response, comma separated list of field names. Requesting only the needed fields improves response time, especially when omitting relation fields. Identifying field(s) are always included.
Request

GET /v2/customers/customer/brands/handle

Response