agreements

GoDaddy Domains v1 API. Accepts a Personal Access Token (Bearer) or a classic sso-key credential.

Overview

Name	agreements
Type	Resource
Id	godaddy.registration.agreements

Fields

The following fields are returned by SELECT queries:

list

Request was successful

Name	Datatype	Description
agreement_key	string	Unique identifier for the legal agreement (wire: agreementKey)
content	string	Contents of the legal agreement, suitable for embedding
title	string	Title of the legal agreement
url	string (url)	URL to a page containing the legal agreement

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	tlds, privacy	x_market_id, for_transfer	Returns the TLD-specific legal agreements that must be accepted before purchase or transfer. The agreementKeys from this response are required in the consent object.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
privacy	boolean	Whether or not privacy has been requested
tlds	array	list of TLDs whose legal agreements are to be retrieved
for_transfer	boolean	Whether or not domain tranfer has been requested (wire: forTransfer)
x_market_id	string (bcp-47)	Unique identifier of the Market used to retrieve/translate Legal Agreements (wire: X-Market-Id)

SELECT examples

list

Returns the TLD-specific legal agreements that must be accepted before purchase or transfer. The agreementKeys from this response are required in the consent object.

SELECT
agreement_key,
content,
title,
url
FROM godaddy.registration.agreements
WHERE tlds = '{{ tlds }}' -- required
AND privacy = '{{ privacy }}' -- required
AND x_market_id = '{{ x_market_id }}'
AND for_transfer = '{{ for_transfer }}'
;