Skip to main content
GET
/
contact
Get Contacts
curl --request GET \
  --url https://api.dev.uselevers.com/api-service/v1/contact \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "name": "<string>",
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "nameAr": "<string>",
      "firstName": "<string>",
      "firstNameAr": "<string>",
      "lastName": "<string>",
      "lastNameAr": "<string>",
      "phoneNumber": "<string>",
      "vatNumber": "<string>",
      "email": "[email protected]",
      "building": "<string>",
      "buildingAr": "<string>",
      "street": "<string>",
      "streetAr": "<string>",
      "district": "<string>",
      "districtAr": "<string>",
      "city": "<string>",
      "cityAr": "<string>",
      "country": "<string>",
      "countryAr": "<string>",
      "postalCode": "<string>",
      "additionalNumber": "<string>",
      "otherId": "<string>",
      "bankName": "<string>",
      "bankContactName": "<string>",
      "iban": "<string>",
      "accountNumber": "<string>",
      "emailTone": "FRIENDLY",
      "sendEmailNotif": true,
      "sendEmailNotifLang": "ENGLISH",
      "sendSmsNotif": true,
      "sendSmsNotifLang": "ENGLISH",
      "remindersEnabled": true,
      "extPlatformId": "<string>",
      "extCompanyId": "<string>",
      "hasErrors": true,
      "errorDetail": {},
      "totalAmount": 123,
      "totalPaid": 123,
      "outstandingAmount": 123,
      "totalInvoices": 123,
      "countUnpaidInvoices": 123,
      "risk": "LOW",
      "role": "PRIMARY",
      "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>"
      },
      "customFields": [
        "<unknown>"
      ],
      "promiseToPayDate": "2023-12-25",
      "promiseToPaySwitchWorkflowUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "reminderStatus": "<string>",
      "reminderLabel": "<string>"
    }
  ],
  "total": 1,
  "page": 2,
  "size": 2,
  "pages": 1
}

​
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.

​
Query Parameters

ParameterTypeRequiredDescription
pageintegerNoPage number (default: 1, min: 1)
sizeintegerNoItems per page (default: 50, min: 1, max: 100)
namestringNoFilter by contact name
uuidstring (UUID)NoFilter by contact UUID
account-numberstringNoFilter by account number
risk-levelstringNoFilter by risk level
workflow-uuidstring (UUID)NoFilter by workflow UUID
reminders-enabledbooleanNoFilter by reminders enabled status
total-amount-fromnumberNoFilter by minimum total amount
total-amount-tonumberNoFilter by maximum total amount
outstanding-amount-fromnumberNoFilter by minimum outstanding amount
outstanding-amount-tonumberNoFilter by maximum outstanding amount

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
uuid
​
name
string
Maximum string length: 255
​
account-number
string
Maximum string length: 255
​
total-amount-from
number
​
total-amount-to
number
​
outstanding-amount-from
number
​
outstanding-amount-to
number
​
total-invoices-from
integer
​
total-invoices-to
integer
​
risk-level
string
​
workflow-uuid
string<uuid>
​
reminders-enabled
boolean
​
reminder-status
string
​
page
integer
default:1
Required range: x >= 1
​
size
integer
default:50
Required range: 1 <= x <= 100

Response

Successful Response

​
items
GetContactResp · object[]
required
​
total
integer
Required range: x >= 0
​
page
integer
Required range: x >= 1
​
size
integer
Required range: x >= 1
​
pages
integer
Required range: x >= 0