Skip to Content
TillorManual
Customers

List Customers

Access

Member of the organization with this permission:

  • customers:read

An API key with scopes also needs the permission among its scopes.

GET
/orgs/{organizationId}/customers

Lists customers with pagination, filtering, sorting, and includes. Supports virtual fields (terrains, meters, consumption), filtering by id, status, customerType, displayId, and text search.

Authorization

ApiKeyAuth
headerx-api-key<token>

API key for authentication

Path Parameters

organizationId*string

The ID or slug of the organization

Query Parameters

page?integer
Range-9007199254740991 <= value <= 9007199254740991
limit?integer
Range-9007199254740991 <= value <= 9007199254740991
sortBy?string
Value in"id""displayId""firstName""lastName""email""phone""address""city""state""zipCode""country""vatNumber""notes""birthday""customerType""status""metadata""customFields""locale""createdAt""updatedAt""consentToCommunications""consentToMarketing"
sortDir?string
Value in"asc""desc"
include?|array<>|string
customerType?|array<>|
status?|array<>|
consentToCommunications?boolean|string|number|null
consentToMarketing?boolean|string|number|null
displayId?number||
birthday?|null
createdAt?|null
updatedAt?|null
firstName?string|array<string>|
lastName?string|array<string>|
email?string|array<string>|
phone?string|array<string>|
address?string|array<string>|
city?string|array<string>|
state?string|array<string>|
zipCode?string|array<string>|
country?string|array<string>|
vatNumber?string|array<string>|
notes?string|array<string>|
locale?string|array<string>|
metadata?
customFields?
hasMeterConsumptionBatches?boolean|string|number|null
hasNoMeterConsumptionBatches?boolean|string|number|null
hasInvoices?boolean|string|number|null
hasNoInvoices?boolean|string|number|null
hasReservations?boolean|string|number|null
hasNoReservations?boolean|string|number|null
hasVoipCalls?boolean|string|number|null
hasNoVoipCalls?boolean|string|number|null
hasOccupations?boolean|string|number|null
hasNoOccupations?boolean|string|number|null
hasPayments?boolean|string|number|null
hasNoPayments?boolean|string|number|null
hasMandates?boolean|string|number|null
hasNoMandates?boolean|string|number|null
hasMandateAgreements?boolean|string|number|null
hasNoMandateAgreements?boolean|string|number|null
hasSignatureRequests?boolean|string|number|null
hasNoSignatureRequests?boolean|string|number|null
hasNfcTags?boolean|string|number|null
hasNoNfcTags?boolean|string|number|null
hasTasks?boolean|string|number|null
hasNoTasks?boolean|string|number|null
hasPeppolRecipients?boolean|string|number|null
hasNoPeppolRecipients?boolean|string|number|null
hasDocuments?boolean|string|number|null
hasNoDocuments?boolean|string|number|null
hasAccessMethods?boolean|string|number|null
hasNoAccessMethods?boolean|string|number|null
hasAccessMethodOperationTargets?boolean|string|number|null
hasNoAccessMethodOperationTargets?boolean|string|number|null
hasAccessLogEntry?boolean|string|number|null
hasNoAccessLogEntry?boolean|string|number|null
hasNotificationDeliveries?boolean|string|number|null
hasNoNotificationDeliveries?boolean|string|number|null
hasComments?boolean|string|number|null
hasNoComments?boolean|string|number|null
hasContacts?boolean|string|number|null
hasNoContacts?boolean|string|number|null
hasEventLogs?boolean|string|number|null
hasNoEventLogs?boolean|string|number|null
hasAuditLogs?boolean|string|number|null
hasNoAuditLogs?boolean|string|number|null
hasIdentityDocumentScans?boolean|string|number|null
hasNoIdentityDocumentScans?boolean|string|number|null
hasIdentityDocumentScanMatchSuggestions?boolean|string|number|null
hasNoIdentityDocumentScanMatchSuggestions?boolean|string|number|null
hasInboxThreads?boolean|string|number|null
hasNoInboxThreads?boolean|string|number|null
hasVehiclePresences?boolean|string|number|null
hasNoVehiclePresences?boolean|string|number|null
hasLedgerOpeningBalances?boolean|string|number|null
hasNoLedgerOpeningBalances?boolean|string|number|null
meterConsumptionBatchId?string|array<string>|
invoiceId?string|array<string>|
reservationId?string|array<string>|
voipCallId?string|array<string>|
occupationId?string|array<string>|
paymentId?string|array<string>|
mandateId?string|array<string>|
mandateAgreementId?string|array<string>|
signatureRequestId?string|array<string>|
nfcTagId?string|array<string>|
taskId?string|array<string>|
peppolRecipientId?string|array<string>|
documentId?string|array<string>|
accessMethodId?string|array<string>|
accessMethodOperationTargetId?string|array<string>|
AccessLogEntryId?string|array<string>|
notificationDeliveryId?string|array<string>|
commentId?string|array<string>|
contactId?string|array<string>|
eventLogId?string|array<string>|
auditLogId?string|array<string>|
identityDocumentScanId?string|array<string>|
identityDocumentScanMatchSuggestionId?string|array<string>|
inboxThreadId?string|array<string>|
vehiclePresenceId?string|array<string>|
ledgerOpeningBalanceId?string|array<string>|
search?string

Response Body

OK

application/json
  1. response
Example Request
curl -X GET 'https://api.tillor.eu/orgs//customers'
Example Response
null

List Customer NFC Tags GET

Lists NFC tags for a customer with pagination, filtering, and sorting.

Create Customer POST

Creates a new customer with the provided data. Optional `identityDocumentScanId` links an unassigned (pending) identity document scan to the new customer in the same atomic transaction.