Skip to main content
GET
/
customers
Get all customers
curl --request GET \
  --url http://api.contabull.com/customers
{
  "customers": [
    {
      "id": "<string>",
      "name": "<string>",
      "email": "<string>",
      "document": "<string>",
      "addressStreet": "<string>",
      "addressNumber": "<string>",
      "addressNeighborhood": "<string>",
      "addressCity": "<string>",
      "addressState": "<string>",
      "addressPostalCode": "<string>",
      "addressCountryCode": "<string>",
      "isBeneficiary": true,
      "type": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "totalPages": 123,
  "currentPage": 123,
  "hasMore": true
}

Query Parameters

type
enum<string>
Available options:
COMPANY,
INDIVIDUAL
isBeneficiary
boolean
query
string
page
number
default:1

Response

default - application/json
customers
object[]
required
total
number
required
totalPages
number
required
currentPage
number
required
hasMore
boolean
required