List Account Notes

List an account's notes

GET/accounts/{account_id}/notes

Use it in a workflow

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

Request

Path parameters

account_idstringrequired

Account ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-bob`.

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.

Response

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

account_idstring

userobject8 fields

messagestringrequired

created_atstring (date-time)

json

{
  "object": "string",
  "has_more": false,
  "next": "string",
  "data": [
    {
      "message": "string",
      "id": "string",
      "object": "string",
      "account_id": "string",
      "user": {
        "id": "string",
        "object": "string",
        "email": "name@example.com",
        "first_name": "string",
        "last_name": "string",
        "time_zone": "string",
        "created_at": "2025-01-01T00:00:00Z",
        "deleted_at": "2025-01-01T00:00:00Z"
      },
      "created_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?