Owners

List owners

get/owners

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/owners
  • Auth: HTTP bearer

Query parameters

searchstring

Free-text search over last name, first name, legal name, email and phone numbers.

emailstring

Exact match.

first_namestring

Partial match, case-insensitive.

last_namestring

Partial match, case-insensitive.

legal_namestring

Partial match on the company name.

registration_numberstring

SIRET or equivalent.

mobile_phonestring

Normalised before matching.

landline_phonestring

Normalised before matching.

owner_categorystring

individual, sc/sci or company.

citystring
postal_codestring
countrystring
pageinteger

Zero-based page index. The first page is 0.

limitinteger

Rows per page. Defaults to 50.

sort_bystring

Field to sort on (created_at, last_name, email, …).

sort_order'asc' | 'desc'

Response

OK

idstring uuid nullable
titlestring nullable
last_namestring nullable
first_namestring nullable
owner_category'individual' | 'company' | 'sc/sci' nullable
legal_namestring nullable
registration_numberstring nullable
countrystring nullable
address_complementstring nullable
street_numberstring nullable
street_namestring nullable
localitystring nullable
postal_codestring nullable
citystring nullable
postal_boxstring nullable
mobile_phonestring nullable
landline_phonestring nullable
emailstring email nullable
auth_user_idstring nullable
created_atstring date-time nullable
updated_atstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.