List profiles

Returns a paginated list of all profiles accessible to the current user, filtered by role if specified.

Profile Overview

A Profile represents an individual or entity that interacts with the property management system,
including tenants, landlords, and guarantors. Unlike Users (which are for system access),
Profiles represent the actual parties in rental and management agreements.

Business significance

Profiles store essential contact and identification information for all parties involved
in property management. They enable proper association of people to contracts and
facilitate communications, financial transactions, and legal compliance.

Key Relationships

  • Can be associated with a contact address (optional)
  • Connected to various contracts through profile relationships
  • Linked to leasing contracts (for tenants and guarantors)
  • Linked to management contracts (for landlords)
  • Can have multiple bank accounts for payments and transfers

Key data types

  • nature: The role of the profile (physical_tenant, moral_tenant, physical_guarantor, moral_guarantor, private_guarantor, public_guarantor, landlord, syndic, inventory_agent, contractor, photographer)
  • supplier_status: For supplier profiles, their business status (active, inactive, disputing, occasional)
  • first_name / last_name: Personal identification
  • phone_number: Contact information
  • email: Electronic contact

Profile Nature Constraints

  • A profile's nature determines its valid relationships:
    • Tenants can only be associated with leasing contracts
    • Landlords can only be associated with management contracts
    • The nature cannot be changed once set
    • When creating a profile with a leasing_contract_id, nature defaults to 'physical_tenant'
    • When creating a profile with a management_contract_id, nature defaults to 'physical_landlord'
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer

Page number for pagination (default: 1)

integer

Number of items per page (default: 10, max: 100)

string

Filter profiles by their nature/role
(e.g., physical_tenant, physical_landlord, contractor)

string

Filter supplier profiles by their status (active, inactive, disputing, occasional)

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json