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.

Required Scope

communities:read

Query Parameters

Parameter	Type	Required	Description
search	string	No	Filter by name, address, or external ID
limit	integer	No	Max results (1-100, default: 50)
offset	integer	No	Skip 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.

Required Scope

communities:write

Request Body

Field	Type	Required	Description
name	string	✓	Community name (max 200 chars)
address	string	✓	Full address (max 500 chars)
zipcode	string	✓	US zipcode (12345 or 12345-6789)
email	string	No	Community contact email
external_community_id	string	No	Your unique identifier
website_url	string	No	Community website URL
status	string	No	Status: `active` or `inactive`
community_manager_email	string	No	Email to assign as Community Manager
asset_manager_email	string	No	Email to assign as Asset Manager
leasing_manager_email	string	No	Email to assign as Leasing Manager
other_team_members_emails	array	No	Array 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.

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