Aryna

Aryna API Documentation

Version 1.0

Dashboard

Code Examples

Example code to help you integrate the Aryna API into your application.

List Communities

GET /communities

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

Create Community

POST /communities

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"
  }'

Update Community Status

PATCH /communities/:id

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"
  }'

Invite User

POST /users/invite

curl -X POST "https://api.aryna.ai/v1/users/invite" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "john.doe@example.com",
    "name": "John Doe",
    "role": "member"
  }'

Integration Best Practices

Environment Variables

Store your API key in environment variables, never hardcode it in your source code.

process.env.ARYNA_API_KEY

Error Handling

Always handle errors gracefully and check response status codes before processing data.

try/catch blocks

Rate Limit Monitoring

Check rate limit headers and implement exponential backoff for 429 errors.

X-RateLimit-Remaining

Timeouts

Set appropriate timeouts for API requests to avoid hanging connections.

timeout: 30000