Aryna

Aryna API Documentation

Version 1.0

Dashboard

Communities API

Manage apartment communities and property portfolios. Assign managers, track properties, and organize your real estate operations.

GET

/communities

Retrieve a paginated list of communities for your organization. Supports search and filtering.

How to Use This Endpoint

Business Context: Query your entire property portfolio to build custom dashboards, export reports, or synchronize with your property management system. Filter by name or location to find specific communities quickly.

Common Scenario: Your executive dashboard pulls all active communities every hour to display portfolio-wide pricing metrics, occupancy rates, and competitive positioning across regions.

Required Scope

communities:read

Query Parameters

ParameterTypeRequiredDescription
searchstringNoFilter by name, address, or external ID
limitintegerNoMax results (1-100, default: 50)
offsetintegerNoSkip results for pagination (default: 0)

Example Request

cURL

curl "https://api.aryna.ai/v1/communities?limit=20&search=Sunset" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

200 OK

application/json
{
  "communities": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Sunset Apartments",
      "address": "123 Main St, Los Angeles, CA",
      "zipcode": "90001",
      "email": "info@sunsetapts.com",
      "external_community_id": "EXT-001",
      "website_url": "https://sunsetapts.com",
      "status": "active",
      "community_manager": {
        "id": "user-id-1",
        "email": "manager@example.com",
        "full_name": "Jane Smith",
        "role": "member",
        "status": "active"
      },
      "asset_manager": null,
      "leasing_manager": null,
      "other_team_members": [],
      "created_at": "2024-11-10T12:00:00.000Z",
      "updated_at": "2024-11-10T12:00:00.000Z"
    }
  ],
  "total": 1,
  "limit": 20,
  "offset": 0
}
POST

/communities

Create a new community (apartment property) in your organization. Managers and team members can be assigned by email.

How to Use This Endpoint

Business Context: Programmatically add new properties as you acquire them or onboard new management contracts. Automatically assign managers using email addresses instead of looking up user IDs, streamlining your workflow.

Common Scenario: When your acquisitions team closes a deal on a new apartment complex, your CRM automatically calls this endpoint to create the community in Aryna, assign the designated property manager, and trigger the first PriceWatch survey—all without manual data entry.

Required Scope

communities:write

Request Body

FieldTypeRequiredDescription
namestring✓Community name (max 200 chars)
addressstring✓Full address (max 500 chars)
zipcodestring✓US zipcode (12345 or 12345-6789)
emailstringNoCommunity contact email
external_community_idstringNoYour unique identifier
website_urlstringNoCommunity website URL
statusstringNoStatus: active or inactive
community_manager_emailstringNoEmail to assign as Community Manager
asset_manager_emailstringNoEmail to assign as Asset Manager
leasing_manager_emailstringNoEmail to assign as Leasing Manager
other_team_members_emailsarrayNoArray of emails for additional team members

Example Request

cURL

curl -X POST https://api.aryna.ai/v1/communities \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Sunset Apartments",
    "address": "123 Main St, Los Angeles, CA",
    "zipcode": "90001",
    "email": "info@sunsetapts.com",
    "external_community_id": "EXT-001",
    "website_url": "https://sunsetapts.com",
    "community_manager_email": "manager@example.com"
  }'

Response

201 Created

application/json
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Sunset Apartments",
  "address": "123 Main St, Los Angeles, CA",
  "zipcode": "90001",
  "email": "info@sunsetapts.com",
  "external_community_id": "EXT-001",
  "website_url": "https://sunsetapts.com",
  "status": "active",
  "community_manager": {
    "id": "user-id-1",
    "email": "manager@example.com",
    "full_name": "Jane Smith",
    "role": "member",
    "status": "active"
  },
  "asset_manager": null,
  "leasing_manager": null,
  "other_team_members": [],
  "created_at": "2024-11-10T12:00:00.000Z",
  "updated_at": "2024-11-10T12:00:00.000Z"
}
PATCH

/communities/:id

Update specific fields of a community. Only the fields provided will be updated. Managers can be reassigned by providing new email addresses.

How to Use This Endpoint

Business Context: Keep community information current as management changes, properties are renovated, or portfolios are sold. Reassign managers dynamically as your team structure evolves.

Common Scenario: When a property manager leaves and their portfolio is redistributed, your HR system makes multiple PATCH calls to reassign their communities to other managers, ensuring continuity of PriceWatch monitoring and compliance tracking.

Required Scope

communities:write

Path Parameters

id

Community ID (UUID)

The unique identifier for the community

Request Body (all optional)

All fields from the create endpoint are supported. Only include the fields you want to update.

Note: The other_team_members_emails field replaces all existing team members with the new list.

Example Request

cURL

curl -X PATCH https://api.aryna.ai/v1/communities/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "inactive",
    "website_url": "https://new-website.com"
  }'

Response

200 OK

application/json
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Sunset Apartments",
  "address": "123 Main St, Los Angeles, CA",
  "zipcode": "90001",
  "email": "info@sunsetapts.com",
  "external_community_id": "EXT-001",
  "website_url": "https://new-website.com",
  "status": "inactive",
  "community_manager": {
    "id": "user-id-1",
    "email": "manager@example.com",
    "full_name": "Jane Smith",
    "role": "member",
    "status": "active"
  },
  "asset_manager": null,
  "leasing_manager": null,
  "other_team_members": [],
  "created_at": "2024-11-10T12:00:00.000Z",
  "updated_at": "2024-11-11T12:00:00.000Z"
}

Common Use Cases

Portfolio Sync

Keep your property portfolio synchronized with your property management system.

GET /communities

Bulk Imports

Programmatically import communities from CSV files or other systems.

POST /communities

Manager Assignments

Automatically assign property managers based on your organizational rules.

PATCH /communities/:id

Status Updates

Mark communities as inactive when sold or no longer managed.

PATCH /communities/:id

Try it in the Interactive Docs

Test these endpoints directly in your browser with our interactive OpenAPI documentation.

Open Interactive API Docs