Saaslogic
  1. Customers
Saaslogic
  • Introduction
  • Authentication
  • Enum Reference
  • Authentication
    • saaslogic token
      • Get the saaslogic access token
    • login Url
      • Gives the login URL
    • logout Url
      • Gives the logout URL
  • Countries
    • Get list of countries
  • Plans
    • List all plans for a product
  • Subscriptions
    • Create a product subscription
    • Retrieve a subscription
    • Create Customer and Subscription
    • Subscription with details permissions, menus and features
    • The Saaslogic URL for creating subscription
  • Usage Reporting
    • Report the resource usages in subscription for invoicing
    • Retrieves the resource usages of a subscription in the current billing cycle
  • Customers
    • addresses
      • Create an address
      • List all addresses
      • Update an address
      • Retrieve an address
      • Delete an address
    • contacts
      • Create a contact
      • List all contacts
      • Update a contact
      • Retrieve a contact
      • Delete a contact
    • Create a customer
      POST
    • List all customers
      GET
    • Update a customer
      PUT
    • Retrieve a customer
      GET
    • Delete a customer
      DELETE
  • Vendors
    • vendor addresses
      • Create a vendor address.
      • List all vendor addresses.
      • Update a vendor address.
      • Retrieve a vendor address..
      • Delete a vendor address.
    • vendor contacts
      • Create a vendor contact.
      • List all vendor contacts.
      • Update a vendor contact.
      • Retrieve a vendor contact.
      • Delete a vendor contact.
    • vendor bills
      • Create a vendor bill
      • Cancel a vendor bill.
    • vendor bills payout
      • Update payment details to vendor bills.
    • Create a vendor
    • Update a vendor.
    • Activate a vendor.
    • Dectivate a vendor.
  • Attributes
    • Create a organization attribute and set the value
    • Retrieve a organization attribute
    • Create a user attribute
    • Update a user attribute
    • Get a user attribute
  • Invoices
    • subscriptions
      • Get the invoices
      • Get the invoices by subscription
    • payments
      • Mark the invoice payment status
    • Get the invoice details .
    • cancel the invoices
    • Send invoice as pdf with payment link.
    • Create an on-demand invoice
  1. Customers

List all customers

GET
/customers
Customers
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api-sandbox.saaslogic.io/v1/customers' \
--header 'Authorization;' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Response Response Example
200 - List all customers
[
  {
    "customerId": "4e27ea44-9be0-4661-a851-3c099d3a18a5",
    "customerName": "Adroit Solutions",
    "customerType": "BUSINESS",
    "isTaxExempted": true,
    "exemptionReasonCode": "D",
    "exemptionNumber": "12345678",
    "isActive": true,
    "Status": "Ready",
    "contacts": [
      {
        "firstName": "Michael",
        "lastName": "Hensley",
        "email": "info@adroit.io",
        "contactNumber": "1234567890",
        "countryCode": "IND",
        "contactId": "54674d18-aa04-4650-baf2-36479dafdb22",
        "countryPrefix": "+91",
        "isDefault": true
      },
      {
        "firstName": "Michael",
        "lastName": "Hensley",
        "email": "info@adroit.io",
        "contactNumber": "1234567890",
        "countryCode": "IND",
        "contactId": "54674d18-aa04-4650-baf2-36479dafdb22",
        "countryPrefix": "+91",
        "isDefault": true
      }
    ],
    "addresses": [
      {
        "addressName": "Adroit Solutions",
        "address": "Akshya Nagar 1st Block 1st Cross, Rammurthy nagar, Bangalore",
        "countryCode": "IND",
        "stateCode": "KA",
        "city": "Bangalore",
        "zip": "560016",
        "addressId": "6c54f68f-1de4-4d72-b532-ae45658e4a15",
        "isDefault": true
      },
      {
        "addressName": "Adroit Solutions",
        "address": "Akshya Nagar 1st Block 1st Cross, Rammurthy nagar, Bangalore",
        "countryCode": "IND",
        "stateCode": "KA",
        "city": "Bangalore",
        "zip": "560016",
        "addressId": "6c54f68f-1de4-4d72-b532-ae45658e4a15",
        "isDefault": true
      }
    ]
  },
  {
    "customerId": "4e27ea44-9be0-4661-a851-3c099d3a18a5",
    "customerName": "Adroit Solutions",
    "customerType": "BUSINESS",
    "isTaxExempted": true,
    "exemptionReasonCode": "D",
    "exemptionNumber": "12345678",
    "isActive": true,
    "Status": "Ready",
    "contacts": [
      {
        "firstName": "Michael",
        "lastName": "Hensley",
        "email": "info@adroit.io",
        "contactNumber": "1234567890",
        "countryCode": "IND",
        "contactId": "54674d18-aa04-4650-baf2-36479dafdb22",
        "countryPrefix": "+91",
        "isDefault": true
      },
      {
        "firstName": "Michael",
        "lastName": "Hensley",
        "email": "info@adroit.io",
        "contactNumber": "1234567890",
        "countryCode": "IND",
        "contactId": "54674d18-aa04-4650-baf2-36479dafdb22",
        "countryPrefix": "+91",
        "isDefault": true
      }
    ],
    "addresses": [
      {
        "addressName": "Adroit Solutions",
        "address": "Akshya Nagar 1st Block 1st Cross, Rammurthy nagar, Bangalore",
        "countryCode": "IND",
        "stateCode": "KA",
        "city": "Bangalore",
        "zip": "560016",
        "addressId": "6c54f68f-1de4-4d72-b532-ae45658e4a15",
        "isDefault": true
      },
      {
        "addressName": "Adroit Solutions",
        "address": "Akshya Nagar 1st Block 1st Cross, Rammurthy nagar, Bangalore",
        "countryCode": "IND",
        "stateCode": "KA",
        "city": "Bangalore",
        "zip": "560016",
        "addressId": "6c54f68f-1de4-4d72-b532-ae45658e4a15",
        "isDefault": true
      }
    ]
  }
]

Request

Header Params
Authorization
string 
required
Saaslogic authorization token
Default:
Bearer {{bearerToken}}
Content-Type
string 
optional
Default:
application/json
Accept
string 
optional
Default:
application/json

Responses

🟢200List all customers
application/json
Body
customerName
string 
required
The name of the customer.
Example:
Adroit Solutions
customerType
enum<string> 
required
The type of customer, either 'BUSINESS' or 'INDIVIDUAL'.
Allowed values:
BUSINESSINDIVIDUAL
Example:
BUSINESS
isTaxExempted
boolean 
required
Indicates whether the customer is exempt from taxes.
contacts
array[object (CustomerContact) {7}] 
optional
A list of contacts associated with the customer.
firstName
string 
required
The first name of the contact person.
Example:
Michael
lastName
string 
required
The last name of the contact person.
Example:
Hensley
email
string <email>
required
The email address of the contact person. Must be a valid email format.
Example:
info@adroit.io
contactNumber
string 
required
The phone number of the contact person.
Example:
1234567890
countryCode
enum<string> 
required
The country code of the contact person's location.
Allowed values:
USAINDAUSCHNCHLKHMCANGBRKENBRAMWIVNMARETURESPPHLPERPAKNGANZLNLDMEXJORJPNIDNDEUETHDNKCUBCRIBOLBELARGBGDAUT
Example:
IND
contactId
string 
optional
A unique identifier for the contact.
Example:
54674d18-aa04-4650-baf2-36479dafdb22
isDefault
boolean 
optional
Indicates whether this is the default contact.
customerId
string 
optional
The unique identifier of the customer.
exemptionReasonCode
enum<string> 
required
The code indicating the reason for tax exemption.
💡
Field is Required when isTaxExempted is true
Allowed values:
ABCDEFGHIJKLMNOPQR
Example:
R
exemptionNumber
string 
optional
The tax exemption number associated with the customer.
💡
Field is Required when isTaxExempted is true
addresses
array[object (CustomerAddress) {8}] 
required
A list of addresses associated with the customer.
addressName
string 
required
The name associated with the address, such as a company name or building name.
Example:
Adroit Solutions
address
string 
required
The detailed street address including house number, street name, and locality.
Example:
Akshya Nagar 1st Block 1st Cross, Rammurthy nagar, Bangalore
countryCode
string 
required
The ISO 3166-1 alpha-3 country code representing the country.
Example:
IND
stateCode
string 
required
The state or province code as per ISO 3166-2.
Example:
KA
city
string 
required
The name of the city or town where the address is located.
Example:
Bangalore
zip
string 
required
The postal or ZIP code of the address location.
Example:
560016
addressId
string 
optional
A unique identifier for the address record.
Example:
6c54f68f-1de4-4d72-b532-ae45658e4a15
isDefault
boolean 
optional
Indicates whether this address is the default address for the entity.
🔴500ErrorResponse
Previous
Create a customer
Next
Update a customer
Built with