Get Administrator

GET/administrators/{administrator_id}

Retrieves a single HSA/FSA administrator with supported products and login URLs.

Path Parameters

administrator_idstringrequired

The Sail administrator id.

Response

Administrator details.

idstring

The Sail administrator id.

namestring

The administrator’s display name.

capabilitiesobject

What Sail can do for this administrator.

Show capabilities properties

supports_rpaboolean

Whether Sail connects to this administrator via automated login (RPA) rather than a direct API integration.

products"expenses" | "benefit_account" | "account_numbers" | "identity"[]

Products this administrator can supply data for.

urlsobject

Public URLs associated with this administrator.

Show urls properties

mainstring

The administrator’s main website URL.

logostring

URL of the administrator’s logo. Null if unavailable.

forgot_passwordstring

URL of the administrator’s password-recovery page.

forgot_usernamestring

URL of the administrator’s username-recovery page.

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/administrators/${administrator_id}`, { method: 'GET', headers: { 'Authorization': 'Bearer <token>' } }); const data = await response.json();

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

<?php $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, "https://live.savewithsail.com/api/v1/administrators/<administrator_id>"); 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/administrators/<administrator_id>", 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/administrators/<administrator_id>")) .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/administrators/<administrator_id>") 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

{ "id": "string", "name": "string", "capabilities": { "supports_rpa": true, "products": [ "expenses" ] }, "urls": { "main": "string", "logo": "string", "forgot_password": "string", "forgot_username": "string" } }