Help: 5. Account

Help Portal » Knowledgebase » WhisperGifts API » 5. Account

Review details about the authenticated user, including registry URL, names, and default values.

Read-only access to some account details is available via the API. This may be extended to read-write access at some point in the future - if you are interested in this functionality please let us know so that we can tailor this functionality to specific demand.

Data Model

Note that fields may be provided in any order in both requests and responses.

idInteger; unique identifier for this registry. Note that this is part of the API Authentication token.
name Text. Registry title, eg Sarah and Tim's Wedding Registry. Maximum 90 characters.
hostname Text / URL. Full hostname used to access this registry, eg http://demo.whispergifts.com. Could be a non-whispergifts domain if this registry uses a custom domain. Maximum 250 characters.
bride_firstname Text. First name provided for the person most identified as the bride. Note: Do not blindly refer to this person as a bride; see bride_title for a suitable title to ensure you properly cater for same-sex weddings or informal weddings that do not use the bride/groom nomenclature. Maximum 100 characters.
bride_surname Text. Surname provided for the bride; often used in searching for registries. Maximum 100 characters.
bride_title Text. How the "bride" identifies themselves. Maximum 100 characters, from a predefined WhisperGifts list including Bride, Groom, Bridegroom, Other bride, Woman, Lady, Man, Bloke, Sheila, etc
groom_firstname Text. First name provided for the person most identified as the groom. Note: Do not blindly refer to this person as a groom or male; see groom_title for a suitable title to ensure you properly cater for same-sex weddings or informal weddings that do not use the bride/groom nomenclature. Maximum 100 characters.
groom_surname Text. Surname provided for the groom; often used in searching for registries. Maximum 100 characters.
groom_title Text. How the "groom" identifies themselves. Maximum 100 characters, from the same predefined list as bride_title. Could be identical value to bride_title
weddingdate Datestamp. ie 2016-01-10. Date the wedding is taking place; public gift selection isn't possible after this date.
message Text. No fixed length. Shown to wedding guests when they select a gift.
contact_1_name Text. Optional. Primary contact for gift selection other than the bridal couple, for example the mother of the bride. Maximum 100 characters.
contact_1_phone Text. Optional. Phone number to get in touch with contact_1_name. Maximum 100 characters.
contact_2_name Text. Optional. Secondary contact for gift selection other than the bridal couple, for example the sister of the groom. Maximum 100 characters.
contact_2_phone Text. Optional. Phone number to get in touch with contact_2_name. Maximum 100 characters.
currency Text. Default is "Australian Dollars". Maximum 20 characters.
currency_symbol Text. Symbol representing the chosen currency, ie "$". Maximum 3 characters.

Detail

Returns details for the authenticated user. This dataset is read-only and other registry details cannot be requested.

Request

curl -X GET "https://www.whispergifts.com/api/v0/account/" -H "API-Auth: [user_id]:[api_key]"

Response

{
    contact_2_phone: "",
    name: "Sarah & Tim's Gift Registry",
    weddingdate: "2017-08-09",
    contact_2_name: "",
    groom_surname: "Brown",
    contact_1_phone: "",
    hostname: "http://demo.whispergifts.com/",
    contact_1_name: "",
    currency: "Australian Dollars",
    bride_firstname: "Sarah",
    groom_title: "Bridegroom",
    currency_symbol: "$",
    message: "Thanks for taking a look at our gift registry. We can't wait to see you at the end of March to help celebrate our special day!",
    bride_surname: "Jones",
    bride_title: "Bride",
    id: 26,
    groom_firstname: "Tim"
}