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:

example

clientnumber=0000000046

curl -i -X GET \
  -u '<username>:<password>' \
  'http://sandbox.sunlync.net:9000/slapi/clients/clientdetails?clientnumber=0000000046'

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

{
  "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"
}