> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tilta.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# List buyers
> Retrieve a paginated list of all buyers registered on your platform. Use limit and offset to page through large result sets efficiently.
This endpoint returns a paginated collection of all buyer records associated with your platform. Use it to build internal dashboards, audit buyer data, or iterate over your buyer base for batch processing. Results are returned in descending order of creation date by default, with the most recently created buyers appearing first. Use the `limit` and `offset` parameters to control page size and navigate through large result sets.
To export all buyers without pagination, use [Export buyers](/api-reference/buyers/export-buyers) instead. It streams every
matching buyer in a single CSV response.
The `total` field reflects the count of all buyers on your platform and does not change based on your `limit` or `offset`
values. Use it to drive pagination controls in your UI.
## OpenAPI
````yaml GET /v1/buyers
openapi: 3.0.0
info:
version: 0.0.1
title: Tilta API
description: Tilta API documentation
servers:
- url: https://api.tilta.io
description: Tilta Production API
- url: https://api.tilta-sandbox.io
description: Tilta Sandbox API
security: []
paths:
/v1/buyers:
get:
tags:
- Buyers
summary: List buyers
description: Returns a list of buyers.
parameters:
- schema:
$ref: '#/components/schemas/limit'
required: false
description: The number of records to be taken.
name: limit
in: query
- schema:
$ref: '#/components/schemas/offset'
required: false
description: The number of records to be skipped.
name: offset
in: query
- schema:
type: string
description: Buyer's IDs to filter in buyers.
example: buyer_123,buyer_456
required: false
description: Buyer's IDs to filter in buyers.
name: external_id
in: query
- schema:
type: string
description: Buyer's legal name to filter in buyers.
required: false
description: Buyer's legal name to filter in buyers.
name: legal_name
in: query
- schema:
type: string
description: Buyer's trading name to filter in buyers.
required: false
description: Buyer's trading name to filter in buyers.
name: trading_name
in: query
- schema:
type: string
description: Buyer's legal forms to filter in buyers.
example: LIMITED_COMPANY,PUBLIC_COMPANY
required: false
description: Buyer's legal forms to filter in buyers.
name: legal_form
in: query
- schema:
type: string
description: >-
Created at range filter (unix timestamps in seconds). Format:
"gte..lte" where each bound is optional (e.g.
"1580515200..1583020800").
example: 1580515200..1583020800
required: false
description: >-
Created at range filter (unix timestamps in seconds). Format:
"gte..lte" where each bound is optional (e.g.
"1580515200..1583020800").
name: created_at
in: query
- schema:
type: string
description: Buyer's billing address countries to filter in buyers.
example: DE,AT
required: false
description: Buyer's billing address countries to filter in buyers.
name: business_address_country
in: query
- schema:
type: string
description: Buyer's billing address city to filter in buyers.
required: false
description: Buyer's billing address city to filter in buyers.
name: business_address_city
in: query
- schema:
type: string
description: Buyer's billing address street to filter in buyers.
required: false
description: Buyer's billing address street to filter in buyers.
name: business_address_street
in: query
- schema:
type: string
description: Buyer's billing address postcode to filter in buyers.
required: false
description: Buyer's billing address postcode to filter in buyers.
name: business_address_postcode
in: query
- schema:
type: string
description: Buyer's delivery address countries to filter in buyers.
example: DE,AT
required: false
description: Buyer's delivery address countries to filter in buyers.
name: delivery_address_country
in: query
- schema:
type: string
description: Buyer's delivery address city to filter in buyers.
required: false
description: Buyer's delivery address city to filter in buyers.
name: delivery_address_city
in: query
- schema:
type: string
description: Buyer's delivery address street to filter in buyers.
required: false
description: Buyer's delivery address street to filter in buyers.
name: delivery_address_street
in: query
- schema:
type: string
description: Buyer's delivery address postcode to filter in buyers.
required: false
description: Buyer's delivery address postcode to filter in buyers.
name: delivery_address_postcode
in: query
- schema:
type: string
description: Buyer's VAT IDs to filter in buyers.
required: false
description: Buyer's VAT IDs to filter in buyers.
name: vat_id
in: query
- schema:
type: string
description: >-
Maximum days past due range to filter buyers by, in the format
gte..lte.
example: 15..30
required: false
description: >-
Maximum days past due range to filter buyers by, in the format
gte..lte.
name: max_days_past_due
in: query
- schema:
type: string
description: >-
Sort buyers by provided field in ascending or descending order.
Prefix field with - for descending order. Example:
sort_by=-created_at
required: false
description: >-
Sort buyers by provided field in ascending or descending order.
Prefix field with - for descending order. Example:
sort_by=-created_at
name: sort_by
in: query
- schema:
type: array
nullable: true
items:
type: string
enum:
- contacts
description: >-
Buyer sub-entities to expand in the response object. Currently
supported: contacts (buyer contacts).
example:
- contacts
required: false
description: >-
Buyer sub-entities to expand in the response object. Currently
supported: contacts (buyer contacts).
name: expand
in: query
- schema:
type: string
description: >-
Filter by a Custom Data field. Replace `field` in
`custom_data[field]` with the field name. Bare values are strings;
JSON numbers, booleans, quoted strings, and arrays preserve their
JSON types. A scalar also matches an element of a stored array; an
array matches a stored array containing all supplied values.
required: false
description: >-
Filter by a Custom Data field. Replace `field` in
`custom_data[field]` with the field name. Bare values are strings;
JSON numbers, booleans, quoted strings, and arrays preserve their
JSON types. A scalar also matches an element of a stored array; an
array matches a stored array containing all supplied values.
name: custom_data[field]
in: query
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
limit:
type: integer
minimum: 0
description: The number of taken records.
example: 100
offset:
type: integer
minimum: 0
description: The number of skipped records.
example: 0
total:
type: integer
minimum: 0
description: Total number of records
example: 140
items:
type: array
items:
type: object
properties:
external_id:
type: string
maxLength: 100
pattern: ^[a-zA-Z0-9-_]+$
description: Unique identifier of a buyer.
created_at:
type: number
description: >-
Timestamp indicating when the buyer was created
(unix time in seconds).
example: 1582896122
updated_at:
type: number
description: >-
Timestamp indicating the last time the buyer was
updated (unix time in seconds).
example: 1582896122
max_days_past_due:
type: integer
nullable: true
description: Maximum days past due among DUE invoices.
trading_name:
type: string
nullable: true
description: >-
Buyer's trading name. If it's not provided, Tilta
will use the legal_name.
example: ACME
legal_name:
type: string
description: >-
Buyer's full legal name incl. the legal form if
applicable.
example: ACME GmbH
legal_form:
type: string
enum:
- LIMITED_COMPANY
- SOLE_TRADER
- PARTNERSHIP
- PUBLIC_COMPANY
- COOPERATIVE
- GOVERNMENT
- OTHER
description: >-
Buyer's legal form which depends on the buyer's
registered country. [Available legal
forms](https://docs.tilta.io/docs/legal-forms) cover
Tilta's operating countries.
registered_at:
type: number
nullable: true
description: >-
Buyer' registration date (unix time in seconds),
when they signed up on your platform.
example: 1582896122
incorporated_at:
type: number
nullable: true
description: >-
Buyer's date of incorporation (unix time in
seconds), meaning the date when the business of
registered or started.
example: 1582896122
business_identifiers:
type: array
nullable: true
items:
type: object
properties:
type:
type: string
enum:
- VAT_ID
- TAX_ID
- REGISTER_ID
- CREFO_ID
- ALLIANZ_TRADE_ID
- SCHUFA_ID
- CREDITSAFE_ID
- CRIF_ID
- ELLISPHERE_ID
description: The type of business identifier
value:
type: string
maxLength: 48
description: The value of the business identifier
country:
type: string
enum:
- AF
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CD
- CG
- CK
- CR
- HR
- CU
- CW
- CY
- CZ
- CI
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- KP
- KR
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RO
- RU
- RW
- RE
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TM
- TC
- TV
- TR
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
- AX
description: Two-letter country code (ISO 3166-1 alpha-2).
required:
- type
- value
- country
additionalProperties: false
description: A list of business identifiers
business_address:
type: object
properties:
street:
type: string
description: Address line (e.g. street, road, place).
example: Example Street
house:
type: string
description: House number or denominator.
example: 42b
postcode:
type: string
description: ZIP or postal code.
example: '12345'
city:
type: string
description: City, district, town, or village.
example: Berlin
country:
type: string
enum:
- AF
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CD
- CG
- CK
- CR
- HR
- CU
- CW
- CY
- CZ
- CI
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- KP
- KR
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RO
- RU
- RW
- RE
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TM
- TC
- TV
- TR
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
- AX
description: Two-letter country code (ISO 3166-1 alpha-2).
additional:
type: string
nullable: true
description: >-
Additional address information (e.g. PO Box, c/o
name etc.).
example: c/o Testimonial
required:
- postcode
- city
- country
description: Buyer's billing address.
delivery_address:
type: object
nullable: true
properties:
street:
type: string
description: Address line (e.g. street, road, place).
example: Example Street
house:
type: string
description: House number or denominator.
example: 42b
postcode:
type: string
description: ZIP or postal code.
example: '12345'
city:
type: string
description: City, district, town, or village.
example: Berlin
country:
type: string
enum:
- AF
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CD
- CG
- CK
- CR
- HR
- CU
- CW
- CY
- CZ
- CI
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- KP
- KR
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RO
- RU
- RW
- RE
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TM
- TC
- TV
- TR
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
- AX
description: Two-letter country code (ISO 3166-1 alpha-2).
additional:
type: string
nullable: true
description: >-
Additional address information (e.g. PO Box, c/o
name etc.).
example: c/o Testimonial
required:
- postcode
- city
- country
description: Buyer's default delivery address.
custom_data:
type: object
nullable: true
additionalProperties:
anyOf:
- type: string
- type: number
- type: boolean
- type: array
items:
anyOf:
- type: string
- type: number
- type: boolean
- nullable: true
- nullable: true
description: >-
Free-form metadata for storing integration-specific
data alongside this buyer. Replaces the existing
object entirely on update.
contacts:
type: array
items:
type: object
properties:
external_id:
type: string
maxLength: 100
pattern: ^[a-zA-Z0-9-_]+$
description: Unique identifier of a contact.
buyer_external_id:
type: string
maxLength: 100
pattern: ^[a-zA-Z0-9-_]+$
description: >-
External identifier of the buyer this contact
belongs to.
salutation:
type: string
nullable: true
enum:
- MR
- MS
- OTHER
description: Contact salutation.
first_name:
type: string
nullable: true
description: Contact first name.
last_name:
type: string
nullable: true
description: Contact last name.
email:
type: string
nullable: true
format: email
description: Contact email.
phone:
type: string
nullable: true
description: >-
Contact phone number in E.164 format (e.g.
+491711010101).
example: '+491711010101'
assign_to_all_invoices:
type: boolean
description: >-
Whether this contact should automatically be
assigned to all invoices created for the
buyer.
address:
type: object
nullable: true
properties:
street:
type: string
description: Address line (e.g. street, road, place).
example: Example Street
house:
type: string
description: House number or denominator.
example: 42b
postcode:
type: string
description: ZIP or postal code.
example: '12345'
city:
type: string
description: City, district, town, or village.
example: Berlin
country:
type: string
enum:
- AF
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CD
- CG
- CK
- CR
- HR
- CU
- CW
- CY
- CZ
- CI
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- KP
- KR
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RO
- RU
- RW
- RE
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TM
- TC
- TV
- TR
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
- AX
description: >-
Two-letter country code (ISO 3166-1
alpha-2).
additional:
type: string
nullable: true
description: >-
Additional address information (e.g. PO
Box, c/o name etc.).
example: c/o Testimonial
required:
- postcode
- city
- country
description: Contact's address.
created_at:
type: number
description: >-
Timestamp indicating when the contact was
created (unix time in seconds).
example: 1582896122
updated_at:
type: number
description: >-
Timestamp indicating the last time the contact
was updated (unix time in seconds).
example: 1582896122
required:
- external_id
- buyer_external_id
- assign_to_all_invoices
- created_at
- updated_at
additionalProperties: false
description: Contact response payload.
description: >-
Buyer contacts. Returned when expand includes
contacts.
required:
- external_id
- created_at
- updated_at
- max_days_past_due
- legal_name
- legal_form
- business_address
additionalProperties: false
description: Buyer response payload.
required:
- limit
- offset
- total
- items
additionalProperties: false
description: Buyers for a platform.
'400':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/badRequestSchema'
'401':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/unauthorizedRequestSchema'
security:
- bearerAuth: []
components:
schemas:
limit:
type: integer
description: The number of records to be taken.
example: 100
default: 100
maximum: 100
offset:
type: integer
description: The number of records to be skipped.
example: 0
default: 0
badRequestSchema:
type: object
properties:
code:
type: string
description: Error code
example: BAD_REQUEST
error:
type: string
description: Error message for debugging purposes
example: Request validation failed. 1 issue found.
issues:
type: array
items:
type: object
properties:
code:
type: string
description: Issue code
example: INVALID_TYPE
path:
type: string
description: Issue path starting with body, params, querystring, or headers
example: body.registered_at
message:
type: string
description: Issue message for debugging purposes
example: Invalid type
required:
- code
- path
- message
description: List of issues
example:
- code: INVALID_TYPE
path: body.registered_at
message: Invalid type
required:
- code
- error
- issues
description: Bad Request, see error message for details.
example:
code: BAD_REQUEST
error: Request validation failed. 1 issue found.
issues:
- code: INVALID_TYPE
path: body.registered_at
message: Invalid type
unauthorizedRequestSchema:
type: object
properties:
error:
type: string
description: Error details.
example: Unauthorized
code:
type: string
description: Error code.
example: UNAUTHORIZED
required:
- error
- code
description: Unauthorized Request.
example:
error: Unauthorized
code: UNAUTHORIZED
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: Your Tilta API key, sent as `Bearer `.
````