younifyd
Menu

List Accounts

List a site's accounts

GET/accounts

Use it in a workflow

  1. Add a step and choose the Recurly connector.
  2. Pick the List Accounts action (under account).
  3. Fill in the fields below, then reference the result from later steps as {{listAccounts.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"

begin_timestring (date-time)

Inclusively filter by begin_time when `sort=created_at` or `sort=updated_at`. **Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.

end_timestring (date-time)

Inclusively filter by end_time when `sort=created_at` or `sort=updated_at`. **Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.

emailstring

Filter for accounts with this exact email address. A blank value will return accounts with both `null` and `""` email addresses. Note that multiple accounts can share one email address.

subscriberboolean

Filter for accounts with or without a subscription in the `active`, `canceled`, or `future` state.

past_duestring

Filter for accounts with an invoice in the `past_due` state.

One oftrue

Response

Returns 200 with an object. Read it in later steps with {{listAccounts.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<any>
json
{
  "object": "string",
  "has_more": false,
  "next": "string",
  "data": [
    null
  ]
}

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

List Accounts — Recurly — Documentation