Skip to main content
GET
/
contact
/
{uuid}
Get Contact Details
curl --request GET \
  --url https://api.dev.uselevers.com/api-service/v1/contact/{uuid} \
  --header 'Authorization: Bearer <token>'
{
  "name": "<string>",
  "nameAr": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "phoneNumber": "<string>",
  "email": "<string>",
  "building": "<string>",
  "buildingAr": "<string>",
  "street": "<string>",
  "streetAr": "<string>",
  "district": "<string>",
  "districtAr": "<string>",
  "city": "<string>",
  "cityAr": "<string>",
  "country": "<string>",
  "countryAr": "<string>",
  "postalCode": "<string>",
  "secondaryContacts": [
    {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "phoneNumber": "<string>",
      "email": "<string>"
    }
  ],
  "paymentInstructions": {
    "bankName": "<string>",
    "iban": "<string>",
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "bankAddress": "<string>",
    "accountNumber": "<string>",
    "bankCompanyName": "<string>",
    "bankCompanyAddress": "<string>"
  },
  "workflow": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  },
  "risk": "LOW",
  "totalAmount": 123,
  "totalPaid": 123,
  "outstandingAmount": 123,
  "averageDelay": 123,
  "lastContacted": "2023-12-25",
  "remindersEnabled": true,
  "hasErrors": true,
  "errorDetail": {},
  "customFields": [
    "<unknown>"
  ],
  "promiseToPayDate": "2023-12-25",
  "promiseToPaySwitchWorkflowId": 123,
  "reminderStatus": "<string>",
  "reminderLabel": "<string>"
}

Authorization

All endpoints require Bearer token authentication.
HeaderTypeRequiredDescription
AuthorizationstringYesBearer authentication header of the form Bearer <token>

Getting Your API Key

See the Quickstart guide for instructions on obtaining your API credentials.

Path Parameters

ParameterTypeRequiredDescription
uuidstring (UUID)YesContact UUID

Response

Returns detailed contact information including:
  • Basic Info: Name, emails, phone numbers, address
  • Financials: Total amount, total paid, outstanding amount, average delay
  • Risk: Risk level assessment
  • Reminders: Reminder status and label
  • Custom Fields: Any custom fields defined for the contact
  • Secondary Contacts: Array of secondary contact persons

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

uuid
required

Response

Successful Response

name
string
required
Required string length: 1 - 255
nameAr
string
Required string length: 1 - 255
firstName
string
Required string length: 1 - 255
lastName
string
Required string length: 1 - 255
phoneNumber
string
Required string length: 1 - 255
email
string
Required string length: 1 - 255
building
string
Required string length: 1 - 255
buildingAr
string
Required string length: 1 - 255
street
string
Required string length: 1 - 255
streetAr
string
Required string length: 1 - 255
district
string
Required string length: 1 - 255
districtAr
string
Required string length: 1 - 255
city
string
Required string length: 1 - 255
cityAr
string
Required string length: 1 - 255
country
string
Required string length: 1 - 255
countryAr
string
Required string length: 1 - 255
postalCode
string
Required string length: 1 - 255
secondaryContacts
GetContactRespShort · object[]
paymentInstructions
PaymentInstructionResp · object
workflow
GetWorkflowResponseShort · object
risk
enum<string>

An enumeration.

Available options:
LOW,
MEDIUM,
HIGH
totalAmount
number
totalPaid
number
outstandingAmount
number
averageDelay
integer
lastContacted
string<date>
remindersEnabled
boolean
hasErrors
boolean
errorDetail
Errordetail · object
customFields
any[]
promiseToPayDate
string<date>
promiseToPaySwitchWorkflowId
integer
reminderStatus
string
reminderLabel
string