List Activity

GET/users/{user_id}/accounts/{account_id}/activity

Paginated account activity: contributions, distributions, interest, and fees. Requires the benefit_account key scope and product. Contribution rows carry a source. Other types do not.

Path Parameters

user_idstringrequired

The Sail user id.

account_idstringrequired

The Sail account id.

Query Parameters

typestring

Filter to one activity type.

tax_yearinteger

Filter to a specific tax year.

limitinteger

Max results per page.

offsetinteger

Pagination offset.

Response

Contribution history.

dataobject[]

Show data properties

idstring

The Sail activity id.

account_idstring

The account this activity occurred on.

type"contribution" | "distribution" | "interest" | "fee"

The kind of activity.

datestring<date>

When the activity occurred.

amountnumber<float>

Positive for money in (contributions, interest), negative for money out (distributions, fees).

tax_yearinteger

The tax year this activity is attributed to.

Present on contribution rows only.

descriptionstring

Human-readable description of the activity.

paginationobject

Pagination metadata for this page.

Show pagination properties

totalinteger

Total number of matching records, across all pages.

limitinteger

The limit used for this page.

offsetinteger

The offset used for this page.

has_moreboolean

Whether additional pages remain after this one.

Standard error envelope covering 400, 401, 403, 404, 429, and 500.

errorobject

The error detail.

Show error properties

codestring

Machine-readable code, e.g. not_found, token_scope_mismatch, product_not_enabled, insufficient_key_scope, insufficient_token_scope, user_token_required, user_token_expired, invalid_user_token, invalid_key_configuration, connection_not_reconnectable, rate_limited.

messagestring

Human-readable error message. May change, so match on error.code instead.

paramstring

The request field that caused the error, when applicable. Null otherwise.

const response = await fetch(`https://live.savewithsail.com/api/v1/users/${user_id}/accounts/${account_id}/activity`, { method: 'GET', headers: { 'Authorization': 'Bearer <token>' } }); const data = await response.json();

import requests response = requests.request( "GET", "https://live.savewithsail.com/api/v1/users/{user_id}/accounts/{account_id}/activity", headers={ "Authorization": "Bearer <token>" }, ) data = response.json()

<?php $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, "https://live.savewithsail.com/api/v1/users/<user_id>/accounts/<account_id>/activity"); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET"); curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer <token>"]); $response = curl_exec($ch); curl_close($ch);

package main import ( "fmt" "io" "net/http" ) func main() { req, _ := http.NewRequest("GET", "https://live.savewithsail.com/api/v1/users/<user_id>/accounts/<account_id>/activity", nil) req.Header.Set("Authorization", "Bearer <token>") resp, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer resp.Body.Close() data, _ := io.ReadAll(resp.Body) fmt.Println(string(data)) }

HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://live.savewithsail.com/api/v1/users/<user_id>/accounts/<account_id>/activity")) .header("Authorization", "Bearer <token>") .method("GET", HttpRequest.BodyPublishers.noBody()) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());

require "net/http" require "uri" uri = URI("https://live.savewithsail.com/api/v1/users/<user_id>/accounts/<account_id>/activity") http = Net::HTTP.new(uri.host, uri.port) http.use_ssl = uri.scheme == "https" request = Net::HTTP::Get.new(uri) request["Authorization"] = "Bearer <token>" response = http.request(request) puts response.body

{ "data": [ { "id": "string", "account_id": "string", "type": "contribution", "date": "2024-01-01", "amount": 0, "tax_year": 0, "source": "payroll", "description": "string" } ], "pagination": { "total": 0, "limit": 0, "offset": 0, "has_more": true } }