Skip to main content
Browse the docs

List a customer's properties

GET/api/v1/customers/{customer_id}/properties

  • Needs an API key, and runs with the access of the member who made the key.
  • A connected AI assistant can use it too, as listCustomerProperties.

Parameters

In the address

  • customer_idstring (uuid)required

In the query string

  • pageinteger

    Default: 1. At least 1.

  • per_pageinteger

    Default: 50. At least 1. At most 100.

Responses

200Paginated properties.

  • dataarray of objectrequired

    Each item(20)

    • lock_versioninteger

      At least 0.

    • created_atstring (date-time)required

    • updated_atstring (date-time)required

    • idstring (uuid)required

    • account_idstring (uuid)required

    • customer_idstring (uuid)required

    • namestring or null

    • address_line_1stringrequired

    • address_line_2string or null

    • citystringrequired

    • regionstring or null

    • postal_codestringrequired

    • country_codestringrequired

    • access_notesstring or null

    • lawn_area_m2string or null

      The lawn at the property in square metres, with up to two decimal places, or null when it has not been measured. Use it as the quantity of lawn work priced per square metre, such as turfing. A patio or decking is priced the same way and is some other size.

      Matches ^\d{1,8}(\.\d{1,2})?$.

    • latitudenumber (double) or null

      Where the property is, to the middle of its postcode. Looked up shortly after the property is saved, and null until then. Stays null when the postcode is unknown, in Northern Ireland or outside the United Kingdom.

      At least -90. At most 90. Read only.

    • longitudenumber (double) or null

      At least -180. At most 180. Read only.

    • billing_namestring or null

    • billing_addressobject or null

      Fields(6)

      • address_line_1stringrequired

      • address_line_2string or null

      • citystringrequired

      • regionstring or null

      • postal_codestringrequired

      • country_codestringrequired

        At least 2 characters. Up to 2 characters.

    • archived_atstring (date-time) or null

  • metaobjectrequired

    Fields(4)

    • pageintegerrequired

      At least 1.

    • per_pageintegerrequired

      At least 1. At most 100.

    • totalintegerrequired

      At least 0.

    • total_pagesintegerrequired

      At least 0.

A refusal answers in the one error shape every operation shares.

Example

A request our own tests send. The ids are made up: put your own in their place.

curl "https://app.tradesender.co.uk/api/v1/customers/372a8e62-6d44-552f-9c0e-c1229b6478be/properties?page=1&per_page=50" \
  -H "Authorization: Bearer $TRADESENDER_KEY"