Skip to content

SunLync API (V2) API Definition (0.0.1)

Open API Specificaitons for SunLync API V2

Download OpenAPI description
Overview
API Support
License
Languages
Servers
Sandbox server
https://sandbox.sunlync.net:9000/

Client

Client related endpoints

Operations

Get client points transactions

Request

Returns a list of points transactions for a given client number and date range

Security
BasicAuthCredentials
Query
clientnumberstring= 10 charactersrequired
Examples:
clientnumber=0000000046
startDatestringrequired
Examples:
startDate=2025-01-01
endDatestringrequired
Examples:
endDate=2025-11-01
curl -i -X GET \
  -u <username>:<password> \
  'https://sandbox.sunlync.net:9000/slapi/clients/getpointstransactions?clientnumber=stringstri&startDate=string&endDate=string'

Responses

Get Points Transactions

Bodyapplicaiton/json
transactionsArray of objects(pointsTransactions)
Response
applicaiton/json
{ "transactions": [ {} ] }

Get billing info

Request

Returns a list of client billing accounts for a given client number

Security
BasicAuthCredentials
Query
clientnumberstring= 10 charactersrequired
Examples:
clientnumber=0000000046
curl -i -X GET \
  -u <username>:<password> \
  'https://sandbox.sunlync.net:9000/slapi/clients/billinginfo?clientnumber=stringstri'

Responses

Get Billing Info

Bodyapplicaiton/json
accountsArray of objects(clientBillingInfo)
Response
applicaiton/json
{ "accounts": [ {} ] }

Search clients

Request

Returns a list of clients

Security
BasicAuthCredentials
Query
clientnumberstring= 10 characters
Examples:
clientnumber=0000000046
firstnamestring
Examples:
firstname=John
lastnamestring
Examples:
lastname=Doe
dobstring
Examples:
dob=1980-12-01
addressstring
Examples:
address=10 Test St
phonestring
Examples:
phone=7165555555
emailstring
Examples:
email=test@test.com
curl -i -X GET \
  -u <username>:<password> \
  'https://sandbox.sunlync.net:9000/slapi/clients/search?clientnumber=stringstri&firstname=string&lastname=string&dob=string&address=string&phone=string&email=string'

Responses

Search Clients

Bodyapplicaiton/json
packagesArray of objects(clientInfo)
Response
applicaiton/json
{ "packages": [ {} ] }

Configuration

SunLync configuration related endpoints

Operations

User

User related endpoints

Operations