List Sites

List sites

GET/sites

Use it in a workflow

Add a step and choose the Recurly connector.
Pick the List Sites action (under site).
Fill in the fields below, then reference the result from later steps as {{listSites.response.data}}.

Request

Query parameters

idsarray<string>

Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`. **Important notes:** * The `ids` parameter cannot be used with any other ordering or filtering parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc) * Invalid or unknown IDs will be ignored, so you should check that the results correspond to your request. * Records are returned in an arbitrary order. Since results are all returned at once you can sort the records yourself.

limitinteger

Limit number of records 1-200.

Default 20

orderstring

Sort order.

One ofascdescDefault "desc"

sortstring

Sort field. You *really* only want to sort by `updated_at` in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.

One ofcreated_atupdated_atDefault "created_at"

statestring

Filter by state.

One ofactiveinactive

Response

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

objectstring

Will always be List.

has_moreboolean

Indicates there are more results on subsequent pages.

nextstring

Path to subsequent page of results.

dataarray<object>

idstring

objectstring

subdomainstring

public_api_keystring

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

modestring

One ofdevelopmentproductionsandbox

addressobject8 fields

settingsobject3 fields

featuresarray<string>

A list of features enabled for the site.

created_atstring (date-time)

updated_atstring (date-time)

deleted_atstring (date-time)

json

{
  "object": "string",
  "has_more": false,
  "next": "string",
  "data": [
    {
      "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.

Was this page helpful?