younifyd
Menu

List External Products

List a site's external products

GET/external_products

Use it in a workflow

  1. Add a step and choose the Recurly connector.
  2. Pick the List External Products action (under external_products).
  3. Fill in the fields below, then reference the result from later steps as {{listExternalProducts.response.data}}.

Request

Query parameters

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"

Response

Returns 200 with an object. Read it in later steps with {{listExternalProducts.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

System-generated unique identifier for an external product ID, e.g. `e28zov4fw0v2`.

objectstring
namestring

Name to identify the external product in Recurly.

planobject4 fields

Just the important parts.

created_atstring (date-time)

When the external product was created in Recurly.

updated_atstring (date-time)

When the external product was updated in Recurly.

external_product_referencesarray<object>6 fields

List of external product references of the external product.

json
{
  "object": "string",
  "has_more": false,
  "next": "string",
  "data": [
    {
      "id": "string",
      "object": "string",
      "name": "string",
      "plan": {
        "id": "string",
        "object": "string",
        "code": "string",
        "name": "string"
      },
      "created_at": "2025-01-01T00:00:00Z",
      "updated_at": "2025-01-01T00:00:00Z",
      "external_product_references": [
        {
          "id": "string",
          "object": "string",
          "reference_code": "string",
          "external_connection_type": "string",
          "created_at": "2025-01-01T00:00:00Z",
          "updated_at": "2025-01-01T00:00:00Z"
        }
      ]
    }
  ]
}

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