Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.wellapp.ai/llms.txt

Use this file to discover all available pages before exploring further.

The Location entity manages address information, geographical coordinates, and relationships to people, companies, and workspaces.

Attributes

NameTypeRequiredDescription
idstring (UUID), 🔒 SystemUnique ID
full_addressstring, 🔒 SystemConcatenate all address fields. A pre-formatted full address string for display purposes (e.g. “123 Main St Apt 4B, San Francisco, CA 94103, USA”).
address_line1string✅ YesPrimary street address
address_line2string⚪ NoAdditional street address
citystring⚪ NoCity
regionstring⚪ NoState or province
postal_codestring⚪ NoZIP or postal code
countrystring✅ YesISO 3166-1 alpha-2 code
latitudeFloat⚪ NoGeographical latitude of the address, useful for maps or distance calculations.
longitudeFloat⚪ NoGeographical longitude of the address, used with latitude for precise location mapping.
is_registeredBoolean⚪ NoIndicates whether this is the user’s or entity’s registered address.
is_primaryBoolean⚪ NoIndicates whether this is the user’s or entity’s main/default address. Default = true
labelenum⚪ NoA flexible field for storing additional custom info such as delivery notes or validation source. Enum email + phone + addresses labels
created_atISO 8601, 🔒 system-Timestamp
updated_atISO 8601, 🔒 system-Timestamp
deleted_atstring, 🔒 system-nullable ISO 8601

Relationships

NameTypeRequiredDescriptionExample
personspeople⚪ NoPeople Resource{ “type”: “people”, “id”: “airbyte” }
companiesto-many (company)⚪ NoCompany Resource[{ “type”: “company”, “id”: “companyChild” }
workspacesto-many (categories)⚪ NoWorkspace Resource[{ “type”: “workspace”, “id”: “workspaceChild” }]