younifyd
Menu

Get Site

Fetch a site

GET/sites/{site_id}

Use it in a workflow

  1. Add a step and choose the Recurly connector.
  2. Pick the Get Site action (under site).
  3. Fill in the fields below, then reference the result from later steps as {{getSite.response.data}}.

Request

Path parameters

site_idstringrequired

Site ID or subdomain. For ID no prefix is used e.g. `e28zov4fw0v2`. For subdomain use prefix `subdomain-`, e.g. `subdomain-recurly`.

Response

Returns 200 with an object. Read it in later steps with {{getSite.response.data.<field>}}.

idstring
objectstring
subdomainstring
public_api_keystring

This value is used to configure RecurlyJS to submit tokenized billing information.

modestring

One ofdevelopmentproductionsandbox

addressobject
phonestring
street1string
street2string
citystring
regionstring

State or province.

postal_codestring

Zip or postal code.

countrystring

Country, 2-letter ISO 3166-1 alpha-2 code.

geo_codestring

Code that represents a geographic entity (location or object). Only returned when Vertex or Avalara for Communications is enabled.

settingsobject
billing_address_requirementstring

- full: Full Address (Street, City, State, Postal Code and Country) - streetzip: Street and Postal Code only - zip: Postal Code only - none: No Address

One offullnonestreetzipzip

accepted_currenciesarray<string>
default_currencystring

The default 3-letter ISO 4217 currency code.

featuresarray<string>

A list of features enabled for the site.

created_atstring (date-time)
updated_atstring (date-time)
deleted_atstring (date-time)
json
{
  "id": "string",
  "object": "string",
  "subdomain": "string",
  "public_api_key": "string",
  "mode": "development",
  "address": {
    "phone": "string",
    "street1": "string",
    "street2": "string",
    "city": "string",
    "region": "string",
    "postal_code": "string",
    "country": "string",
    "geo_code": "string"
  },
  "settings": {
    "billing_address_requirement": "full",
    "accepted_currencies": [
      "string"
    ],
    "default_currency": "string"
  },
  "features": [
    "credit_memos"
  ],
  "created_at": "2025-01-01T00:00:00Z",
  "updated_at": "2025-01-01T00:00:00Z",
  "deleted_at": "2025-01-01T00:00:00Z"
}

Need more? See the Recurly guide for connection setup and behaviour shared by every action.