Skip to content

SunLync API (V2) API Definition (0.0.1)

Open API Specificaitons for SunLync API V2

Download OpenAPI description
openapi.json
openapi.yaml
Overview
API Support
support@sunlync.com
License
Languages
Servers
Sandbox server
https://sandbox.sunlync.net:9000/

Client

Client related endpoints

Operations

Get client details

Request

Returns basic demographic information 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/clientdetails?clientnumber=stringstri'

Responses

Get Client Details

Bodyapplicaiton/json
firstNamestring
Example: "John"
lastNamestring
Example: "Doe"
middleInitstring
Example: "D"
address1string
Example: "10 Main St"
address2string
Example: "Suite 1"
citystring
Example: "Buffalo"
statestring
Example: "NY"
zipstring
Example: "14220"
dobstring
Example: "1980-12-25T00:00:00.000Z"
homePhonestring
Example: "7165551234"
cellPhonestring
Example: "7165555678"
workPhonestring
Example: "7165559876"
workExtstring
Example: "123"
genderstring
Example: "male"
emailstring
Example: "jdoe@test.com"
lastVisitstring(date-time)
Example: "2025-06-26T13:39:49.849Z"
homeStorestring
Example: "Store 1"
skinTypestring
Example: "fair"
eyeColorstring
Example: "blue"
howHearstring
Example: "Marketing"
Response
applicaiton/json
{
  "firstName": "John",
  "lastName": "Doe",
  "middleInit": "D",
  "address1": "10 Main St",
  "address2": "Suite 1",
  "city": "Buffalo",
  "state": "NY",
  "zip": "14220",
  "dob": "1980-12-25T00:00:00.000Z",
  "homePhone": "7165551234",
  "cellPhone": "7165555678",
  "workPhone": "7165559876",
  "workExt": "123",
  "gender": "male",
  "email": "jdoe@test.com",
  "lastVisit": "2025-06-26T13:39:49.849Z",
  "homeStore": "Store 1",
  "skinType": "fair",
  "eyeColor": "blue",
  "howHear": "Marketing"
}

Get ledger balances

Request

Returns ledger balances for a given client number

  • Postive value amount owed
  • Negative value is amount of credit
Security
BasicAuthCredentials
Query
clientnumberstringrequired
Examples:
clientnumber=0000000004
curl -i -X GET \
  -u <username>:<password> \
  'https://sandbox.sunlync.net:9000/slapi/clients/ledgerbalance?clientnumber=string'

Responses

Get Ledger Balances

Bodyapplicaiton/json
overallBalancenumber(float)
Example: 4
generalBalancenumber(float)
Example: 2
eftBalancenumber(float)
Example: 2
Response
applicaiton/json
{
  "overallBalance": 4,
  "generalBalance": 2,
  "eftBalance": 2
}

Get communication preferences

Request

Returns communication preferences for a given client number

Security
BasicAuthCredentials
Query
clientnumberstringrequired
Examples:
clientnumber=0000000004
curl -i -X GET \
  -u <username>:<password> \
  'https://sandbox.sunlync.net:9000/slapi/clients/commprefs?clientnumber=string'

Responses

Client Communication Preferences

Bodyapplicaiton/json
allowboolean
Example: true
emailboolean
Example: true
cellVoiceboolean
Example: true
cellTextboolean
Example: true
homePhoneboolean
Example: true
workPhoneboolean
Example: true
mailboolean
Example: true
Response
applicaiton/json
{
  "allow": true,
  "email": true,
  "cellVoice": true,
  "cellText": true,
  "homePhone": true,
  "workPhone": true,
  "mail": true
}

Configuration

SunLync configuration related endpoints

Operations

User

User related endpoints

Operations