Introduction

Welcome to the HOALife API Documentation. HOALife's API is intended to be consumed by programmers to consume or generate data with the HOALife system.

While this documentation is comprehensive, access to some endpoints may not be included in all Customer Agreements. Contact sales@hoalife.com to learn more.

The API provides scoped Read, Write, Update, and Destroy actions for most resources.

JSON is the only currently supported response format, following the JSON:API spec. All responses will have the application/vnd.api+json content type. Any POST or PUT requests must specify the application/vnd.api+json Content-Type header.

API Clients

This API is completely accessible without an API Client, however, we do provide some API Clients to allow you to leverage this API without worrying about implementation details.

Ruby

The hoalife Ruby gem will seamlessly take care of this API's authentication, signature verification, rate limiting, pagination, and error handling.

$ gem install hoalife

View the README for usage details and examples.

Authentication

HOALife supports two kinds of API credentials:

• Service Account API Keys (sk_...) are created for an account and are intended for automated integrations that run without a user's involvement. They do not have a fixed expiration.
• User Access API Keys (cli_...) are issued to a signed-in user through the OAuth flow below. Each key is scoped to one selected account and the access level the user approved.

Both credential types can use the Authorization: Token ... header. Service Account API Keys also support the Basic Authentication and URL parameter methods documented below. User Access API Keys require the Token header.

Service Account API Keys via HTTP Header

To authorize, use this code:

# With shell, you can just pass the correct header with each request
curl https://api.hoalife.com/api/ \
  -H "Authorization: Token sk_SUPERSECRET"

Make sure to replace sk_SUPERSECRET with your API key.

HOALife expects for the API key to be included in all API requests to the server in a header that looks like the following:

Authorization: Token sk_SUPERSECRET

User Access API Keys (OAuth)

User Access API Keys are issued through OAuth Authorization Code with PKCE. The HOALife CLI is a public client: it does not have a client secret. It starts the flow over HTTPS, opens the returned authorization URL in a browser, and listens on a local loopback callback for the authorization code. The resulting credential belongs to the user, is limited to the selected account and approved access level, and expires unless refreshed.

1. Create an authorization request

Generate a cryptographically random state and PKCE code_verifier. Use an unpadded Base64URL-encoded verifier between 43 and 128 characters long. Calculate the S256 challenge as the unpadded Base64URL encoding of SHA256(code_verifier). Keep the state and verifier in the CLI process; do not put either in the browser URL.

Choose an available port and use this exact loopback callback format for both requests:

http://127.0.0.1:{port}/oauth/callback

For example, request an authorization URL with cURL:

curl --fail-with-body https://api.hoalife.com/oauth/authorization-requests \
  -H "Content-Type: application/json" \
  -d '{"client_id":"hoalife-cli","redirect_uri":"http://127.0.0.1:49152/oauth/callback","state":"STATE_FROM_CLI","code_challenge":"S256_CHALLENGE_FROM_CLI"}'

The response contains an authorization_url. Open it in the user's browser. The user signs in if needed, selects an account if they have access to more than one eligible account, and approves the requested access. When CLI access is enabled on a root account, eligible leaf accounts beneath it can be selected. A user with one eligible account skips account selection. Account eligibility depends on the user's highest eligible membership role; architectural committee members and voters cannot authorize CLI access when they are the highest eligible role. Account administrators can grant read-only, read/write, or read/write/delete access; other eligible membership roles can grant read-only access only.

2. Receive the authorization response

After approval, HOALife redirects the browser to the loopback callback with a short-lived authorization code and the original state. The CLI must compare the returned state with the value it generated before proceeding. If the user cancels, the callback contains error=access_denied and the state instead of a code. The CLI should handle that response and close its local listener.

Authorization codes expire after five minutes and can be exchanged only once. The authorization request itself expires after ten minutes if it is not completed.

3. Exchange the code for a credential

Send the code, original redirect URI, and verifier to the token endpoint:

curl --fail-with-body https://api.hoalife.com/oauth/token \
  -H "Content-Type: application/json" \
  -d '{"client_id":"hoalife-cli","redirect_uri":"http://127.0.0.1:49152/oauth/callback","code":"CODE_FROM_CALLBACK","code_verifier":"VERIFIER_FROM_CLI"}'

The response contains an access_token, a refresh_token, a signing_secret, and token_type of Token. The access token is a User Access API Key. The signing secret is used to verify the API's X-Signature HMAC header. The credential is associated with the user and selected account, with the membership recorded when access came through one. API requests are scoped to the selected account. Its permissions are limited to the selected grant: read grants allow read actions; write grants allow read, create, and update actions; delete grants additionally allow destroy actions. These values are returned only once, so store them securely and never log them.

The access token expires in 24 hours (expires_in). A refresh token expires if it is not used within seven days (refresh_token_expires_in); each successful refresh rotates it and starts a new seven-day period. The grant has a one-year absolute lifetime (grant_expires_in). Refresh the pair by sending the current refresh token and client ID:

curl --fail-with-body https://api.hoalife.com/oauth/token \
  -H "Content-Type: application/json" \
  -d '{"grant_type":"refresh_token","client_id":"hoalife-cli","refresh_token":"REFRESH_TOKEN_FROM_PREVIOUS_RESPONSE"}'

The response contains a replacement access token, refresh token, and the same signing secret. Store the replacement tokens securely, discard the previous pair, and serialize refresh attempts. Refresh tokens are single-use; reusing a consumed token revokes the grant. If a refresh token has expired or the grant has reached its one-year lifetime, complete browser authorization again.

Requests to /api/info and /api/schema do not count against an API credential's request limit.

After the token exchange succeeds, the CLI may redirect the browser to /authorization-issued.html on the same HOALife host. This static page confirms authorization is complete and asks the user to return to the CLI; it does not receive the authorization code or access token.

4. Make API requests

Send the credential in the Authorization header:

curl https://api.hoalife.com/api/accounts \
  -H "Authorization: Token cli_SUPERSECRET"

User Access API Keys are accepted with the Token header. They are not accepted with HTTP Basic authentication or the api_key URL parameter. Service Account API Keys can use the authentication methods in the section above.

To check which account and permissions a credential represents, request /api/info with the same header. The response includes the account ID and name, the credential type, its permissions, and (for User Access API Keys) its access level and access_token_expires_at. The API currently returns credential_type: "cli" for User Access API Keys and credential_type: "service_account" for Service Account API Keys.

curl https://api.hoalife.com/api/info \
  -H "Authorization: Token cli_SUPERSECRET"

Revoke access

To revoke a grant, send the current refresh token and client ID to POST /oauth/revoke:

curl --fail-with-body https://api.hoalife.com/oauth/revoke \
  -H "Content-Type: application/json" \
  -d '{"client_id":"hoalife-cli","token":"REFRESH_TOKEN"}'

The endpoint returns success for unknown tokens and tokens belonging to another client. Revoking the refresh token invalidates the entire grant, including the current access token, even when that access token has expired. DELETE /api/logout remains available when a valid access token is present. A User Access API Key stops working if the user no longer has the access required by its grant. The CLI should discard its local copy when the user signs out or revokes access.

User Access API Keys do not grant webhook access. Webhooks are reserved for Service Account API Keys and cannot be created or managed with OAuth-issued credentials.

Service Account API Keys via Basic Authentication

To authorize, use this code:

# cURL will encode the username and password in the header for you. YMMV with other libraries.
curl https://sk_SUPERSECRET:sk_SUPERSECRET@api.hoalife.com/api/

Make sure to replace sk_SUPERSECRET with your API key.

When using Basic Authentication, enter your API key for both the username and password. cURL will Base64 and encode these for you, sending the Authorization header as follows:

Authorization: Basic c2tfU1VQRVJTRUNSRVQ6c2tfU1VQRVJTRUNSRVQ=

Service Account API Keys via URL Parameter

To authorize, use this code:

# With shell, you can just pass the correct header with each request
curl https://api.hoalife.com/api/?api_key=sk_SUPERSECRET

Make sure to replace sk_SUPERSECRET with your API key.

Passing your API key via URL parameter is also possible. This is helpful when testing requests via a web browser.

Rate Limit

To ensure a consistent and reliable service, this API limits the number of requests per API key within a given time frame. The default limit is 5 requests per second; requests to /api/info and /api/schema are excluded. The rate limit is enforced as a GCRA "Leaky Bucket". Higher volume rate limits are available per the Customer Agreement. Contact sales@hoalife.com to learn more.

Requests subject to rate limits include HTTP headers to help you stay within the allowance. Exceeding these limits will result in a 429. Continued requests after a 429 may result in requests from your IP being blocked.

Accommodating the rate limit could be as simple as this pseudo-code
sleep 2sec if X-RateLimit-Remaining < 1.

API Schema

Retrieve the machine-readable attribute contracts with an authenticated request:

curl https://api.hoalife.com/api/schema \
  -H "Authorization: Token sk_SUPERSECRET"

HTTP Request

GET https://api.hoalife.com/api/schema

Service Account API Keys and active User Access API Keys can retrieve the schema. No resource permissions are required. Missing, invalid, expired, or revoked credentials receive 401 Unauthorized. Requests are exempt from credential rate limits and usage counting, including when the credential has exhausted its allowance. Successful responses use application/vnd.api+json and include the usual X-Signature header.

Response

The response has data.id: "v1", data.type: "api_schema", and these attributes:

Each operation is a JSON Schema Draft 2020-12 object with $schema, type, properties, and required. It describes the attributes inside data.attributes, including nested arrays and objects. For example, data.attributes.resources.acc_request_votes.create lists request_id and user_id as required and limits status to "requested", "", or null. The read schema instead describes the returned vote and its possible statuses.

Nullable fields include "null" in their type. Conditional response fields have x-conditional: true; conditional input requirements are explained in field descriptions. Defaults are included only for creation.

The catalog is the same for every valid credential and contains the public serializer contracts used by this reference. Resource names match documentation sections, rather than endpoint paths. It does not describe the complete JSON:API envelope, relationship inputs, special actions, or permissions. Use the endpoint sections for those details and /api/info for your credential's permissions.

Verify Authenticity

Paranoid? No problem. All responses provided by this API are signed via HMAC SHA256.

A signature is created by generating an HMAC of the raw response body with a SHA256 digest, using the shared Signing Secret. You'll find this signature in the HTTP header X-Signature.

def verified?
  digest = OpenSSL::Digest.new("sha256")
  OpenSSL::HMAC.hexdigest(digest, "ss_SUPERSECRET", response.body) == response.headers["X-Signature"]
end

Make sure to replace ss_SUPERSECRET with your provided Signing Secret.

Querying, Ordering, and Pagination

Querying

Most attributes of a resource are query-able so that you can filter resource collections based on an attribute. Include the attribute as a query parameter in the URL external_id=EXT42.

By default, exact matching will be used. If you'd like to craft an approximate query, you can specify the operator as part of the parameter value.

Ordering

You can specify the order of a resource collection by passing the order URL query parameter order=foo.

By default, the resource will be ordered by the created_at attribute in ascending order. You can specify the direction of the order clause by specifying asc or desc as part of the parameter value.

Pagination

Recourse collections are paginated, with 25 resources per page. Traversing pages can be done via the page=X URL query parameter.

There are a number of helpful attributes in a collection response to help you traverse pages. If you have specified order or query attributes, they will be reflected in the pagination links.

"meta": {
  "total": 167,
  "total_pages": 7
},
"links": {
  "self": "/api/accounts/1/properties?page=1",
  "next": "/api/accounts/1/properties?page=2",
  "prev": "/api/accounts/1/properties"
}

Accounts

Accounts represent both Associations which are managed, and Management companies.

Get All Accounts

curl "https://api.hoalife.com/api/accounts" \
  -H "Authorization: Token sk_SUPERSECRET"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": "1",
      "type": "account",
      "attributes": {
        "id": 1,
        "parent_id": null,
        "name": "XYZ HOA Management",
        "repeat_violation_strategy": "six_month_rolling_window",
        "escalation_threshold": 3,
        "violation_lookback_period": "two_months",
        "mailing_street_1": "123 HOALife Way",
        "mailing_street_2": null,
        "mailing_city": "Sun Valley",
        "mailing_state": "ID",
        "mailing_postal_code": "83313",
        "organizational": true,
        "external_id": null,
        "created_at": "2019-07-30T21:16:44.624Z",
        "updated_at": "2019-08-01T14:49:17.016Z"
      },
      "relationships": {}
    },
    {
      "id": "2",
      "type": "account",
      "attributes": {
        "id": 2,
        "parent_id": 1,
        "name": "Goodview HOA",
        "repeat_violation_strategy": "six_month_rolling_window",
        "escalation_threshold": null,
        "violation_lookback_period": null,
        "mailing_street_1": "123 Goodview Dr",
        "mailing_street_2": null,
        "mailing_city": "Ketchum",
        "mailing_state": "ID",
        "mailing_postal_code": "83340",
        "organizational": false,
        "external_id": null,
        "created_at": "2019-07-30T21:16:44.640Z",
        "updated_at": "2019-07-31T15:44:01.644Z"
      },
      "relationships": {}
    },
    {
      "id": "3",
      "type": "account",
      "attributes": {
        "id": 3,
        "parent_id": 1,
        "name": "Sleepyville HOA",
        "repeat_violation_strategy": "six_month_rolling_window",
        "escalation_threshold": null,
        "violation_lookback_period": null,
        "mailing_street_1": "123 Sleepy Ct",
        "mailing_street_2": null,
        "mailing_city": "Sun Valley",
        "mailing_state": "ID",
        "mailing_postal_code": "83353",
        "organizational": false,
        "external_id": null,
        "created_at": "2019-08-01T14:37:15.287Z",
        "updated_at": "2019-08-01T14:37:15.287Z"
      },
      "relationships": {}
    }
  ],
  "meta": {
    "current_page": 1,
    "total": 3,
    "total_pages": 1
  },
  "links": {
    "self": "/api/accounts?page=1",
    "next": "/api/accounts",
    "prev": "/api/accounts"
  }
}

This endpoint retrieves all Accounts accessible by the API key.

HTTP Request

GET https://api.hoalife.com/api/accounts

Attributes

Nested presence applies when its parent object is present.

Query Parameters

Create Account

curl "https://api.hoalife.com/api/accounts" \
  -X POST \
  -H "Authorization: Token sk_SUPERSECRET" \
  -H "Content-Type: application/vnd.api+json" \
  -d '
    {
      "data": {
        "type": "account",
        "attributes": {
          "name": "Foo Bar22",
          "external_id": "123",
          "organizational": false
        },
        "relationships": {
          "parent": {
            "data": {
              "type": "account",
              "id": 5
            }
          }
        }
      }
    }
  '

The above command returns JSON structured like this:

{
  "data": {
    "id": "731",
    "type": "account",
    "attributes": {
      "id": 42,
      "name": "Foo Bar",
      "organizational": false,
      "created_at": "2019-08-12T23:53:04.537Z",
      "updated_at": "2019-08-12T23:53:04.537Z",
      "repeat_violation_strategy": "six_month_rolling_window",
      "external_id": "123",
      "parent_id": 5,
      "violation_lookback_period": 0,
      "escalation_threshold": null,
      "mailing_street_2": null,
      "mailing_street_1": null,
      "mailing_city": null,
      "mailing_state": null,
      "mailing_postal_code": null
    },
    "relationships": {}
  }
}

This endpoint creates a new Account.

HTTP Request

POST https://api.hoalife.com/api/accounts

Account Writable Attributes

Required refers to unconditional presence. See descriptions for conditional requirements. Nested requirements apply when the parent object is supplied.

Update Account

curl "https://api.hoalife.com/api/accounts/42" \
  -X PUT \
  -H "Authorization: Token sk_SUPERSECRET" \
  -H "Content-Type: application/vnd.api+json" \
  -d '
    {
      "data": {
        "type": "account",
        "attributes": {
          "name": "Foo Bar22"
        }
      }
    }
  '

The above command will return updated JSON, just like for the Create action with a successful status code of 201 CREATED.

This endpoint updates an existing Account.

HTTP Request

PUT https://api.hoalife.com/api/accounts/:account_id

URL Parameters

Editable Attributes

Required refers to unconditional presence. See descriptions for conditional requirements. Nested requirements apply when the parent object is supplied.

Destroy Account

curl "https://api.hoalife.com/api/accounts/42" \
  -X DELETE \
  -H "Authorization: Token sk_SUPERSECRET" \
  -H "Content-Type: application/vnd.api+json"

The above command will return an empty response successful response with a successful status code of 202 Accepted.

This endpoint destroys an existing Account. Because Account objects have many dependent resources, the actual deletion of the data is performed in a background process. This means that the API may continue to return data for the Account even after you've requested a it be deleted.

HTTP Request

DELETE https://api.hoalife.com/api/accounts/:account_id

URL Parameters

Invoices

Invoices represent finalized charges associated with properties.

Get All Invoices for an Account

curl "https://api.hoalife.com/api/accounts/123/invoices" \
  -H "Authorization: Token sk_SUPERSECRET"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": "987",
      "type": "invoice",
      "attributes": {
        "id": 987,
        "account_id": 123,
        "property_id": 456,
        "status": "open",
        "transaction_date": "2026-09-01",
        "due_date": "2026-10-01",
        "document_number": "INV-987",
        "total_cents": 12500,
        "balance_cents": 12500,
        "created_at": "2026-09-01T12:00:00.000Z",
        "updated_at": "2026-09-01T12:00:00.000Z"
      },
      "relationships": {}
    }
  ],
  "meta": {
    "current_page": 1,
    "total": 1,
    "total_pages": 1
  },
  "links": {
    "self": "/api/accounts/123/invoices?page=1",
    "next": "/api/accounts/123/invoices",
    "prev": "/api/accounts/123/invoices"
  }
}

Returns finalized invoices synced with the accounting provider for the account identified in the path. Invoices without an external provider ID have not synced back yet and are excluded, even if they are finalized locally. If no finalized, synced invoices are available, the endpoint returns an empty collection. The account must have an active accounting integration. The API key must have read permission for invoices, and the path account must be within the API key's account scope.

If no accounting integration is available to the account, the API returns 409 Conflict:

{
  "data": {
    "id": "556629c9-c2ad-494b-82d4-53d9639f7174",
    "type": "error",
    "attributes": {
      "id": "556629c9-c2ad-494b-82d4-53d9639f7174",
      "title": "Accounting integration required",
      "status": 409,
      "detail": "Invoice listing requires an accounting integration for this account"
    }
  }
}

HTTP Request

GET https://api.hoalife.com/api/accounts/:account_id/invoices

URL Parameters

Attributes

Nested presence applies when its parent object is present.

Query Parameters

The response uses the standard collection pagination metadata and links. Follow the links.next URL to retrieve the next page. An account outside the API key's scope or a property that does not belong to the path account is not accessible through this endpoint.

Create Invoice

Create an invoice for a property in the account identified by account_id. The invoice is created asynchronously by the account's accounting integration.

curl "https://api.hoalife.com/api/accounts/123/invoices" \
  -X POST \
  -H "Authorization: Token sk_SUPERSECRET" \
  -H "Content-Type: application/vnd.api+json" \
  -d '
    {
      "data": {
        "type": "invoice",
        "attributes": {
          "property_id": 456,
          "description": "Monthly assessment",
          "quantity": 1,
          "amount_cents": 12500,
          "item_type_id": "accounting-item-789",
          "transaction_date": "2025-01-15",
          "due_date": "2025-02-15",
          "private_note": "Created through the API",
          "customer_memo": "Thank you"
        }
      }
    }
  '

The API queues invoice creation with the accounting integration and returns immediately. No invoice resource is included in the response. Refresh the account's invoice list to find the invoice after creation completes. The API does not provide a job-status endpoint.

HTTP Request

POST https://api.hoalife.com/api/accounts/:account_id/invoices

Writable Attributes

Required refers to unconditional presence. See descriptions for conditional requirements. Nested requirements apply when the parent object is supplied.

The API key must have create permission for invoices. The :account_id must be within the API key's account scope, and property_id must identify a property belonging to that account. The property must also be linked to a customer in the accounting integration through its external customer ID; for QuickBooks Online, this is the QuickBooks customer ID. item_type_id is an opaque string; clients should obtain valid values from GET /api/accounts/:account_id/invoice_item_types rather than infer provider-specific identifiers.

Email delivery is not part of invoice creation through this endpoint.

Responses

202 Accepted

The invoice creation request was accepted for asynchronous processing. The response body is empty. The created invoice becomes available through GET /api/accounts/:account_id/invoices after processing completes.

400 Bad Request

The request is invalid. Required fields must be present; quantity and amount_cents must be positive, and amount_cents must be an integer expressed in cents; the dates must be valid ISO 8601 dates; and the property must have an external customer ID configured for the accounting integration. Validation failures use the standard API error envelope described in Errors.

{
  "data": {
    "id": "error-id",
    "type": "error",
    "attributes": {
      "id": "error-id",
      "title": "Invalid data",
      "status": 400,
      "detail": {
        "amount_cents": ["must be an integer"],
        "due_date": ["is invalid"],
        "property_id": ["is not linked to an accounting customer"]
      }
    }
  }
}

409 Conflict

The account or property does not have an accounting integration available for invoice creation. The response uses the standard API error envelope described in Errors.

{
  "data": {
    "id": "error-id",
    "type": "error",
    "attributes": {
      "id": "error-id",
      "title": "Accounting integration unavailable",
      "status": 409,
      "detail": "Invoice creation requires an accounting integration for this account."
    }
  }
}

Invoice Item Types

Invoice item types identify the products or services available when creating an invoice. The API returns the item types supplied by the invoice provider available to the requested Account. The resource is provider-neutral; its id is an opaque string and should be passed back unchanged when creating an invoice.

Get Invoice Item Types

curl "https://api.hoalife.com/api/accounts/2/invoice_item_types" \
  -H "Authorization: Token sk_SUPERSECRET"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": "7",
      "type": "invoice_item_type",
      "attributes": {
        "id": "7",
        "name": "Management Fee",
        "fully_qualified_name": "Services:Management Fee",
        "unit_price_cents": 12500
      },
      "relationships": {}
    },
    {
      "id": "18",
      "type": "invoice_item_type",
      "attributes": {
        "id": "18",
        "name": "Late Fee",
        "fully_qualified_name": "Fees:Late Fee",
        "unit_price_cents": 2500
      },
      "relationships": {}
    }
  ]
}

Returns invoice item types available from the invoice provider for the requested Account. The Account must be within the API key's scope. The API key must have read permission for invoices.

If no accounting integration is available to the Account, the API returns 409 Conflict:

{
  "data": {
    "id": "556629c9-c2ad-494b-82d4-53d9639f7174",
    "type": "error",
    "attributes": {
      "id": "556629c9-c2ad-494b-82d4-53d9639f7174",
      "title": "Accounting integration required",
      "status": 409,
      "detail": "No accounting integration is available for this account"
    }
  }
}

HTTP Request

GET https://api.hoalife.com/api/accounts/:account_id/invoice_item_types

Attributes

Nested presence applies when its parent object is present.

Users

Users with roles on the credential's Account, its descendants, or its ancestors that provide inherited access.

Get All Users

curl "https://api.hoalife.com/api/users" \
  -H "Authorization: Token sk_SUPERSECRET"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": "1",
      "type": "user",
      "attributes": {
        "id": 1,
        "email": "admin@example.com",
        "first_name": "Bob",
        "last_name": "Admin",
        "timezone": "Mountain Time (US & Canada)",
        "authorizations": [
          {
            "id": 444,
            "account_id": 1,
            "role": "administrator"
          }
        ]
      }
    },
    {
      "id": "2",
      "type": "user",
      "attributes": {
        "id": 2,
        "email": "sub-account-manager@example.com",
        "first_name": "Jane",
        "last_name": "SubAccountManger",
        "timezone": "Pacific Time (US & Canada)",
        "authorizations": [
          {
            "id": 555,
            "account_id": 2,
            "role": "manager"
          },
          {
            "id": 556,
            "account_id": 3,
            "role": "manager"
          }
        ]
      }
    },
    {
      "id": "3",
      "type": "user",
      "attributes": {
        "id": 3,
        "email": "inspector@example.com",
        "first_name": "Sally",
        "last_name": "Inspector",
        "timezone": "Eastern Time (US & Canada)",
        "authorizations": [
          {
            "id": 777,
            "account_id": 4,
            "role": "inspector"
          }
        ]
      }
    }
  ],
  "meta": {
    "current_page": 1,
    "total": 3,
    "total_pages": 1
  },
  "links": {
    "self": "/api/users?page=1",
    "next": "/api/users",
    "prev": "/api/users"
  }
}

This endpoint retrieves all Users accessible by the credential, including users whose roles are inherited from parent or other ancestor accounts. Each user is returned once, with authorizations for the credential's account, its descendants, and its ancestors. Each authorization retains the ID of the account where the role was granted. Roles only on sibling or unrelated accounts are excluded.

Filter Users and their returned authorizations by the account where a role was granted using the account_id query parameter, or by role using role. For example, filtering by a parent account's ID returns users with roles granted on that parent; filtering by a child account's ID selects roles granted directly on that child.

HTTP Request

GET https://api.hoalife.com/api/users

Attributes

Nested presence applies when its parent object is present.

Query Parameters

User Authorizations

User Authorizations to the given Account and any child accounts.

Get All User Authorizations

curl "https://api.hoalife.com/api/users/authorizations" \
  -H "Authorization: Token sk_SUPERSECRET"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": "111",
      "type": "authorization",
      "attributes": {
        "id": 111,
        "role": "staff",
        "account_id": 1,
        "user": {
          "id": 1,
          "email": "bob@example.com",
          "first_name": "Bob",
          "last_name": "Smith",
          "timezone": "Mountain Time (US & Canada)"
        }
      },
      "relationships": {}
    },
    {
      "id": "222",
      "type": "authorization",
      "attributes": {
        "id": 222,
        "role": "read_only",
        "account_id": 1,
        "user": {
          "id": 2,
          "email": "boardmember@example.com",
          "first_name": "Board",
          "last_name": "Member",
          "timezone": "Mountain Time (US & Canada)"
        }
      },
      "relationships": {}
    },
  ],
  "meta": {
    "current_page": 1,
    "total": 2,
    "total_pages": 1
  },
  "links": {
    "self": "/api/users/authorizations?page=1",
    "next": "/api/users/authorizations",
    "prev": "/api/users/authorizations"
  }
}

This endpoint retrieves all User Authorizations accessible by the API key. If the API key has access to multiple Accounts, all User Authorizations for all those accounts will be returned. Scope User Authorizations to a specific Account by adding an account_id query parameter.

HTTP Request

GET https://api.hoalife.com/api/users/authorizations

Attributes

Nested presence applies when its parent object is present.

Query Parameters

Create User Authorization

When creating a User Authorization, passing the user's information is recommended. If a User does not exist for a given email address, a user will be created. If the User does exist, the record will be looked up by the email attribute.

Alternatively, if the User already exists and you know the User's id, you can pass the id via a relationship. The former method is preferred to avoid an additional API request.

Only one Authorization per User per Account is possible. Per Account hierarchy branch User Authorizations are encouraged to scope a User's access. Multiple User Authorizations throughout the same Account hierarchy branch is possible, but not recommended.

Available roles are administrator, manager, staff, inspector, and read_only.

curl "https://api.hoalife.com/api/users/authorizations" \
  -X POST \
  -H "Authorization: Token sk_SUPERSECRET" \
  -H "Content-Type: application/vnd.api+json" \
  -d '
    {
      "data": {
        "type": "authorization",
        "attributes": {
          "role": "read_only",
          "send_invitation_email": false,
          "user": {
            "first_name": "Bob",
            "last_name": "Smith",
            "email": "bob@example.com"
          }
        },
        "relationships": {
          "account": {
            "data": {
              "type": "account",
              "id": 5
            }
          }
        }
      }
    }
  '

# OR

curl "https://api.hoalife.com/api/users/authorizations" \
  -X POST \
  -H "Authorization: Token sk_SUPERSECRET" \
  -H "Content-Type: application/vnd.api+json" \
  -d '
    {
      "data": {
        "type": "authorization",
        "attributes": {
          "role": "read_only",
          "send_invitation_email": false
        },
        "relationships": {
          "account": {
            "data": {
              "type": "account",
              "id": 5
            }
          },
          "user": {
            "data": {
              "type": "user",
              "id": 2
            }
          },
        }
      }
    }
  '

The above command returns JSON structured like this:

{
  "data": {
    "id": "3333",
    "type": "authorization",
    "attributes": {
      "id": 3333,
      "role": "read_only",
      "account_id": 5,
      "user": {
        "id": 1,
        "email": "bob@example.com",
        "first_name": "Bob",
        "last_name": "Smith",
        "timezone": "Mountain Time (US & Canada)"
      }
    }
  },
  "relationships": {}
  }
}

This endpoint creates a User Authorization.

HTTP Request

POST https://api.hoalife.com/api/users/authorizations

User Authorization Writable Attributes

Required refers to unconditional presence. See descriptions for conditional requirements. Nested requirements apply when the parent object is supplied.

Select the account through data.relationships.account.data.id. Select an existing user through data.relationships.user.data.id, or supply the nested user attributes below data.attributes.

Update User Authorization

curl "https://api.hoalife.com/api/users/authorizations/42" \
  -X PUT \
  -H "Authorization: Token sk_SUPERSECRET" \
  -H "Content-Type: application/vnd.api+json" \
  -d '
    {
      "data": {
        "type": "authorization",
        "attributes": {
          "role": "read_only"
        }
      }
    }
  '

The above command will return updated JSON, just like for the Create action with a successful status code of 200 OK.

This endpoint updates an existing User Authorization.

HTTP Request

PUT https://api.hoalife.com/api/users/authorizations/:user_authorization_id

URL Parameters

Editable Attributes

Required refers to unconditional presence. See descriptions for conditional requirements. Nested requirements apply when the parent object is supplied.

Destroy User Authorization

curl "https://api.hoalife.com/api/users/authorizations/42" \
  -X DELETE \
  -H "Authorization: Token sk_SUPERSECRET" \
  -H "Content-Type: application/vnd.api+json"

The above command will return an empty response successful response with a successful status code of 202 Accepted.

This endpoint destroys an existing User Authorization.

HTTP Request

DELETE https://api.hoalife.com/api/users/authorizations/:user_authorization_id

URL Parameters

Properties

Properties represent a property or unit in an Association.

Get All Properties

curl "https://api.hoalife.com/api/properties" \
  -H "Authorization: Token sk_SUPERSECRET"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": "1",
      "type": "property",
      "attributes": {
        "id": 1,
        "account_id": 2,
        "formatted_id": "PRP-1",
        "street_1": "944 Awesome Street",
        "street_2": null,
        "city": "Sun Valley",
        "state": "ID",
        "postal_code": "83353",
        "override_geocoding": false,
        "latitude": "37.233333",
        "longitude": "-115.808333",
        "route_leg": null,
        "lot_number": null,
        "route": "Awesome Street",
        "emails": [
            "johnAndJudySmithOnFacebook@aol.com"
        ],
        "phone_numbers": [],
        "created_at": "2019-07-30T21:16:45.265Z",
        "updated_at": "2019-07-30T21:16:45.265Z",
        "mailing_name": "John and Judy Smith",
        "mailing_street_1": "944 Awesome Street",
        "mailing_street_2": null,
        "mailing_city": "Sun Valley",
        "mailing_state": "ID",
        "mailing_postal_code": "83353",
        "notes": [
            {
                "body_text": "Neighbor has complained about poor lawn hygiene.",
                "author": "John Owner",
                "pinned": true,
                "created_at": "2019-08-05T03:26:02.917Z"
            }
        ],
        "tags":[{"title":"Board Member","id":1,"color":"#6fa7ce"}],
        "external_id": null
      },
      "relationships": {}
    },
    ...
    {
      "id": "25",
      "type": "property",
      "attributes": {
        "id": 25,
        "account_id": 2,
        "formatted_id": "PRP-25",
        "street_1": "4242 Cowbell Drive",
        "street_2": null,
        "city": "Sun Valley",
        "state": "ID",
        "postal_code": "83353",
        "override_geocoding": false,
        "latitude": "37.233333",
        "longitude": "-115.808333",
        "route_leg": null,
        "route": "Cowbell Drive",
        "lot_number": null,
        "emails": [
            "earl-larae@cowbelldrive.com", "earl-larae@yahsnooze.com"
        ],
        "phone_numbers": [
            "+132155512345", "+132155512346"
        ],
        "created_at": "2019-07-30T21:16:45.460Z",
        "updated_at": "2019-07-30T21:16:45.460Z",
        "mailing_name": "Earl LaRae",
        "mailing_street_1": "PO BOX 42424242",
        "mailing_street_2": null,
        "mailing_city": "Sun Valley",
        "mailing_state": "ID",
        "mailing_postal_code": "83353",
        "notes": [],
        "tags": [],
        "external_id": null
      },
      "relationships": {}
    }
  ],
  "meta": {
    "current_page": 1,
    "total": 858,
    "total_pages": 35
  },
  "links": {
    "self": "/api/properties?page=1",
    "next": "/api/properties?page=2",
    "prev": "/api/properties"
  }
}

This endpoint retrieves all Properties accessible by the API key. If the API key has access to multiple Accounts, all Properties for all those accounts will be returned. Scope Properties to a specific Account by adding an account_id query parameter.

HTTP Request

GET https://api.hoalife.com/api/properties

Attributes

Nested presence applies when its parent object is present.

Query Parameters

Create Property

curl "https://api.hoalife.com/api/properties" \
  -X POST \
  -H "Authorization: Token sk_SUPERSECRET" \
  -H "Content-Type: application/vnd.api+json" \
  -d '
    {
      "data": {
        "type": "property",
        "attributes": {
          "street_1": "4242 Cowbell Drive",
          "city": "Sun Valley",
          "state": "ID",
          "postal_code": "83353",
          "external_id": "123"
        },
        "relationships": {
          "account": {
            "data": {
              "type": "account",
              "id": 5
            }
          }
        }
      }
    }
  '

The above command returns JSON structured like this:

{
  "data": {
      "id": "25",
      "type": "property",
      "attributes": {
        "id": 25,
        "account_id": 5,
        "formatted_id": "PRP-25",
        "street_1": "4242 Cowbell Drive",
        "street_2": null,
        "city": "Sun Valley",
        "state": "ID",
        "postal_code": "83353",
        "override_geocoding": false,
        "latitude": "37.233333",
        "longitude": "-115.808333",
        "route_leg": null,
        "route": "Cowbell Drive",
        "emails": [
            "earl-larae@cowbelldrive.com", "earl-larae@yahsnooze.com"
        ],
        "phone_numbers": [
            "+132155512345", "+132155512346"
        ],
        "created_at": "2019-07-30T21:16:45.460Z",
        "updated_at": "2019-07-30T21:16:45.460Z",
        "mailing_name": "Earl LaRae",
        "mailing_street_1": "PO BOX 42424242",
        "mailing_street_2": null,
        "mailing_city": "Sun Valley",
        "mailing_state": "ID",
        "mailing_postal_code": "83353",
        "notes": [],
        "external_id": "123"
      },
    },
    "relationships": {}
  }
}

This endpoint creates a new Property.

HTTP Request

POST https://api.hoalife.com/api/properties

Property Writable Attributes

Required refers to unconditional presence. See descriptions for conditional requirements. Nested requirements apply when the parent object is supplied.

When mailing_street_1 is not blank, the property must also have mailing_city, mailing_state, and mailing_postal_code. New properties default a missing mailing_name to "Current Resident" and mailing_country to "US". When matching an existing property, its existing mailing city, state, and postal code can satisfy these requirements.

Update Property

curl "https://api.hoalife.com/api/properties/42" \
  -X PUT \
  -H "Authorization: Token sk_SUPERSECRET" \
  -H "Content-Type: application/vnd.api+json" \
  -d '
    {
      "data": {
        "type": "property",
        "attributes": {
          "street_1": "123 Updated St",
          "tags": ["1", "Board Member"]
        }
      }
    }
  '

The above command will return updated JSON, just like for the Create action with a successful status code of 201 CREATED.

This endpoint updates an existing Property.

HTTP Request

PUT https://api.hoalife.com/api/properties/:property_id

URL Parameters

Editable Attributes

Required refers to unconditional presence. See descriptions for conditional requirements. Nested requirements apply when the parent object is supplied.

Destroy Property

curl "https://api.hoalife.com/api/properties/42" \
  -X DELETE \
  -H "Authorization: Token sk_SUPERSECRET" \
  -H "Content-Type: application/vnd.api+json"

The above command will return an empty response successful response with a successful status code of 202 Accepted.

This endpoint destroys an existing Property. Because Property objects have many dependent resources, the actual deletion of the data is performed in a background process. This means that the API may continue to return data for the Property even after you've requested a it be deleted.

HTTP Request

DELETE https://api.hoalife.com/api/properties/:property_id

URL Parameters

Property Conversations

Property Conversations are discussion threads associated with a property.

Get All Property Conversations

curl "https://api.hoalife.com/api/properties/456/conversations" \
  -H "Authorization: Token sk_SUPERSECRET"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": "125",
      "type": "conversation",
      "attributes": {
        "id": 125,
        "property_id": 456,
        "description": "Pool maintenance",
        "created_at": "2026-10-01T14:20:00.000Z",
        "updated_at": "2026-10-02T09:15:00.000Z"
      },
      "relationships": {}
    }
  ],
  "meta": {
    "current_page": 1,
    "total": 1,
    "total_pages": 1
  },
  "links": {
    "self": "/api/properties/456/conversations?page=1",
    "next": "/api/properties/456/conversations",
    "prev": "/api/properties/456/conversations"
  }
}

Returns conversation threads for the property identified by :property_id. Conversations are ordered by most recently updated first. Use Get Conversation Messages to read messages in a thread. Both endpoints require the Conversations Read permission (conversations: ["read"]) and accept service account and user access credentials. Only properties in the credential's account or descendant accounts are accessible. A missing or inaccessible property or conversation returns 404.

HTTP Request

GET https://api.hoalife.com/api/properties/:property_id/conversations

URL Parameters

Query Parameters

Attributes

Nested presence applies when its parent object is present.

Get Conversation Messages

curl "https://api.hoalife.com/api/properties/456/conversations/125/messages" \
  -H "Authorization: Token sk_SUPERSECRET"

Returns messages in the selected property's conversation, oldest first. Results use the standard JSON:API collection envelope with data, pagination meta, and links. Each resource has type conversation_message. Message bodies are plain text; raw email headers and attachments are not included. This endpoint is read-only and does not send messages.

HTTP Request

GET https://api.hoalife.com/api/properties/:property_id/conversations/:conversation_id/messages

URL Parameters

Query Parameters

page selects a page of 25 messages. Filtering and custom ordering are not supported.

Attributes

Nested presence applies when its parent object is present.

Property Notes

Property Notes are notes attached directly to a property.

Get All Property Notes

curl "https://api.hoalife.com/api/properties/456/notes" \
  -H "Authorization: Token sk_SUPERSECRET"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": "125",
      "type": "note",
      "attributes": {
        "id": 125,
        "pinned": true,
        "auto_action": null,
        "auto_action_at": null,
        "created_at": "2026-10-01T14:20:00.000Z",
        "author_id": 1,
        "body_text": "Inspection follow-up",
        "attached_to_type": "property",
        "attached_to_id": 456
      }
    }
  ],
  "meta": {
    "current_page": 1,
    "total": 1,
    "total_pages": 1
  },
  "links": {
    "self": "/api/properties/456/notes?page=1",
    "next": "/api/properties/456/notes",
    "prev": "/api/properties/456/notes"
  }
}

Returns all notes attached directly to the selected property, including pinned and unpinned notes, newest first by creation date. Notes on the property's escalations or architectural requests are not included. Note bodies are returned as plain text using the existing note response format.

Requires Notes Read permission (notes: ["read"]) and accepts service account and user access credentials. Access is limited to properties in the credential's account or descendant accounts. A missing or inaccessible property returns 404; missing read permission returns 403.

HTTP Request

GET https://api.hoalife.com/api/properties/:property_id/notes

URL Parameters

Query Parameters

page selects a page of 25 notes. Filtering and custom ordering are not supported.

Attributes

Nested presence applies when its parent object is present.

Property Supplemental Mailing Addresses

Supplemental mailing addresses for properties. The primary property mailing address should be provided as Property data.

Get All Property Supplemental Mailing Addresses

curl "https://api.hoalife.com/api/properties/supplemental_mailing_addresses" \
  -H "Authorization: Token sk_SUPERSECRET"

The above command returns JSON structured like this:

{
  "data": [
    {
  "data": [
    {
      "id": "1",
      "type": "supplemental_mailing_address",
      "attributes": {
        "id": 1,
        "property_id": 42,
        "send_notices": true,
        "mailing_name": "John Smith",
        "mailing_street_1": "1234 Tall Oak Court",
        "mailing_street_2": "",
        "mailing_city": "Low Point",
        "mailing_state": "NC",
        "mailing_postal_code": "23365",
        "external_id": "abc-123"
      },
      "relationships": {}
    },
    {
      "id": "2",
      "type": "supplemental_mailing_address",
      "attributes": {
        "id": 2,
        "property_id": 42,
        "send_notices": false,
        "mailing_name": "Jane Smith",
        "mailing_street_1": "22558 Casa Grande Drive",
        "mailing_street_2": "",
        "mailing_city": "Cookersfield",
        "mailing_state": "IA",
        "mailing_postal_code": "91106",
        "external_id": "abc-122"
      },
      "relationships": {}
    }
  ],
  "meta": {
    "current_page": 1,
    "total": 2,
    "total_pages": 1

    "self": "/api/properties/supplemental_mailing_addresses?page=1",
    "next": "/api/properties/supplemental_mailing_addresses?page=2",
    "prev": "/api/properties/supplemental_mailing_addresses"
  }
}

This endpoint retrieves all Property Supplemental Mailing Addresses for the given Property ID.

This endpoint retrieves all Property Supplemental Mailing Addresses accessible by the API key. If the API key has access to multiple Accounts, all Properties for all those accounts will be returned. Scope Property Supplemental Mailing Addresses to a specific Property by adding an property_id query parameter.

HTTP Request

GET https://api.hoalife.com/api/properties/supplemental_mailing_addresses

Attributes

Nested presence applies when its parent object is present.

Query Parameters

Create Property Supplemental Mailing Address

curl "https://api.hoalife.com/api/properties/supplemental_mailing_addresses" \
  -X POST \
  -H "Authorization: Token sk_SUPERSECRET" \
  -H "Content-Type: application/vnd.api+json" \
  -d '
    {
      "data": {
        "type": "supplemental_mailing_address",
        "attributes": {
          "mailing_name": "Jane Smith",
          "mailing_street_1": "22558 Casa Grande Drive",
          "mailing_city": "Cookersfield",
          "mailing_state": "IA",
          "mailing_postal_code": "91106",
          "send_notices": true,
          "external_id": "abc-123"
        },
        "relationships": {
          "property": {
            "data": {
              "type": "property",
              "id": 42
            }
          }
        }
      }
    }
  '

The above command returns JSON structured like this:

{
  "data": {
      "id": "25",
      "type": "supplemental_mailing_address",
      "attributes": {
        "id": 2,
        "property_id": 42,
        "send_notices": true,
        "mailing_name": "Jane Smith",
        "mailing_street_1": "22558 Casa Grande Drive",
        "mailing_street_2": "",
        "mailing_city": "Cookersfield",
        "mailing_state": "IA",
        "mailing_postal_code": "91106",
        "external_id": "abc-123"
      },
    },
    "relationships": {}
  }
}

This endpoint creates a new Property Supplemental Mailing Address.

HTTP Request

POST https://api.hoalife.com/api/properties/supplemental_mailing_addresses

Property Supplemental Mailing Address Writable Attributes

Required refers to unconditional presence. See descriptions for conditional requirements. Nested requirements apply when the parent object is supplied.

Update Property Supplemental Mailing Address

curl "https://api.hoalife.com/api/properties/supplemental_mailing_addresses/25" \
  -X PUT \
  -H "Authorization: Token sk_SUPERSECRET" \
  -H "Content-Type: application/vnd.api+json" \
  -d '
    {
      "data": {
        "type": "supplemental_mailing_address",
        "attributes": {
          "mailing_name": "Josh Carunner",
        }
      }
    }
  '

The above command will return updated JSON, just like for the Create action with a successful status code of 201 CREATED.

This endpoint updates an existing Property Supplemental Mailing Address.

HTTP Request

PUT https://api.hoalife.com/api/properties/supplemental_mailing_addresses/:supplemental_mailing_addresses_id

URL Parameters

Editable Attributes

Required refers to unconditional presence. See descriptions for conditional requirements. Nested requirements apply when the parent object is supplied.

Destroy Property

curl "https://api.hoalife.com/api/properties/supplemental_mailing_addresses/42" \
  -X DELETE \
  -H "Authorization: Token sk_SUPERSECRET" \
  -H "Content-Type: application/vnd.api+json"

The above command will return an empty response successful response with a successful status code of 202 Accepted.

This endpoint destroys an existing Property Supplemental Mailing Address.

HTTP Request

DELETE https://api.hoalife.com/api/properties/supplemental_mailing_addresses/:supplemental_mailing_addresses_id

URL Parameters

Assets

Assets represent a asset or common area in an association.

Get All Assets

curl "https://api.hoalife.com/api/assets" \
  -H "Authorization: Token sk_SUPERSECRET"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": "1",
      "type": "asset",
      "attributes": {
        "id": 1,
        "account_id": 2,
        "formatted_id": "AST-1",
        "description": "Pool",
        "latitude": "37.233333",
        "longitude": "-115.808333",
        "created_at": "2019-07-30T21:16:45.460Z",
        "updated_at": "2019-07-30T21:16:45.460Z",
        "external_id": null
      },
      "relationships": {}
    },
    ...
    {
      "id": "25",
      "type": "asset",
      "attributes": {
        "id": 25,
        "account_id": 2,
        "formatted_id": "AST-25",
        "description": "West Entrence Common Area",
        "latitude": "37.233333",
        "longitude": "-115.808333",
        "created_at": "2019-07-30T21:16:45.460Z",
        "updated_at": "2019-07-30T21:16:45.460Z",
        "external_id": null
      },
      "relationships": {}
    }
  ],
  "meta": {
    "current_page": 1,
    "total": 858,
    "total_pages": 35
  },
  "links": {
    "self": "/api/assets?page=1",
    "next": "/api/assets?page=2",
    "prev": "/api/assets"
  }
}

This endpoint retrieves all Assets accessible by the API key. If the API key has access to multiple Accounts, all Assets for all those accounts will be returned. Scope Assets to a specific Account by adding an account_id query parameter.

HTTP Request

GET https://api.hoalife.com/api/assets

Attributes

Nested presence applies when its parent object is present.

Query Parameters

Create Asset

curl "https://api.hoalife.com/api/assets" \
  -X POST \
  -H "Authorization: Token sk_SUPERSECRET" \
  -H "Content-Type: application/vnd.api+json" \
  -d '
    {
      "data": {
        "type": "asset",
        "attributes": {
          "description": "4242 Cowbell Drive",
          "latitude": "37.233333",
          "longitude": "-115.808333",
          "external_id": "123"
        },
        "relationships": {
          "account": {
            "data": {
              "type": "account",
              "id": 5
            }
          }
        }
      }
    }
  '

The above command returns JSON structured like this:

{
  "data": {
      "id": "25",
      "type": "asset",
      "attributes": {
        "id": 25,
        "account_id": 5,
        "formatted_id": "AST-25",
        "latitude": "37.233333",
        "longitude": "-115.808333",
        "created_at": "2019-07-30T21:16:45.460Z",
        "updated_at": "2019-07-30T21:16:45.460Z",
        "external_id": "123"
      },
    },
    "relationships": {}
  }
}

This endpoint creates a new Asset.

HTTP Request

POST https://api.hoalife.com/api/assets

Asset Writable Attributes

Required refers to unconditional presence. See descriptions for conditional requirements. Nested requirements apply when the parent object is supplied.

Update Asset

curl "https://api.hoalife.com/api/assets/42" \
  -X PUT \
  -H "Authorization: Token sk_SUPERSECRET" \
  -H "Content-Type: application/vnd.api+json" \
  -d '
    {
      "data": {
        "type": "asset",
        "attributes": {
          "description": "Common aread West entrance"
        }
      }
    }
  '

The above command will return updated JSON, just like for the Create action with a successful status code of 201 CREATED.

This endpoint updates an existing Asset.

HTTP Request

PUT https://api.hoalife.com/api/assets/:asset_id

URL Parameters

Editable Attributes

Required refers to unconditional presence. See descriptions for conditional requirements. Nested requirements apply when the parent object is supplied.

Destroy Asset

curl "https://api.hoalife.com/api/assets/42" \
  -X DELETE \
  -H "Authorization: Token sk_SUPERSECRET" \
  -H "Content-Type: application/vnd.api+json"

The above command will return an empty response successful response with a successful status code of 202 Accepted.

This endpoint destroys an existing Asset. Because Asset objects have many dependent resources, the actual deletion of the data is performed in a background process. This means that the API may continue to return data for the Asset even after you've requested a it be deleted.

HTTP Request

DELETE https://api.hoalife.com/api/assets/:asset_id

URL Parameters

CCR Articles

CCR Articles represent a group of similar Violation Types an Association enforces.

Get All CCR Articles

curl "https://api.hoalife.com/api/ccr_articles" \
  -H "Authorization: Token sk_SUPERSECRET"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": "1",
      "type": "ccr_article",
      "attributes": {
        "id": 1,
        "article": "5.14.a",
        "title": "Lot Maintenance",
        "description": "As stated in Article 5.14(a) - Each Owner of a Lot shall maintain all Improvements located thereon in good and sufficient repair and shall keep the improvements thereon painted or stained, lawn cut, shrubbery trimmed, windows glazed, rubbish and debris removed, weeds cut and otherwise maintain the same in a neat and aesthetically pleasing condition.",
        "created_at": "2019-07-30T21:16:47.540Z",
        "updated_at": "2019-07-31T15:44:01.646Z",
        "account_id": 2,
        "external_id": null
      },
      "relationships": {}
    },
    ...
    {
      "id": "4",
      "type": "ccr_article",
      "attributes": {
        "id": 4,
        "article": "5.24.c",
        "title": "Fences and Walls",
        "description": "As stated in Article 5.24(c) - All fences and walls shall be constructed and installed and maintained in good appearance and condition at the expense of the Owner of the Lot on which they are located and all damaged fencing and walls shall be repainted or replaced to original design, materials, and color within a reasonable time after said damage occurs.",
        "created_at": "2019-07-30T21:16:48.006Z",
        "updated_at": "2019-07-30T21:16:48.009Z",
        "account_id": 2,
        "external_id": null
      },
      "relationships": {}
    }
  ],
  "meta": {
    "current_page": 1,
    "total": 4,
    "total_pages": 1
  },
  "links": {
    "self": "/api/ccr_articles?page=1",
    "next": "/api/ccr_articles",
    "prev": "/api/ccr_articles"
  }
}

This endpoint retrieves all CCR Articles accessible by the API key. If the API key has access to multiple Accounts, all CCR Articles for all those accounts will be returned. Scope CCR Articles to a specific Account by adding an account_id query parameter.

HTTP Request

GET https://api.hoalife.com/api/ccr_articles

Attributes

Nested presence applies when its parent object is present.

Query Parameters

Create CCR Article

curl "https://api.hoalife.com/api/ccr_articles" \
  -X POST \
  -H "Authorization: Token sk_SUPERSECRET" \
  -H "Content-Type: application/vnd.api+json" \
  -d '
    {
      "data": {
        "type": "ccr_article",
        "attributes": {
          "article": "5.24.c",
          "title": "Fences and Walls",
          "description": "As stated in Article 5.24(c) - All fences and walls shall be constructed and installed and maintained in good appearance and condition at the expense of the Owner of the Lot on which they are located and all damaged fencing and walls shall be repainted or replaced to original design, materials, and color within a reasonable time after said damage occurs.",
          "external_id": "123"
        },
        "relationships": {
          "account": {
            "data": {
              "type": "account",
              "id": 5
            }
          }
        }
      }
    }
  '

The above command returns JSON structured like this:

{
  "data": {
      "id": "4",
      "type": "ccr_article",
      "attributes": {
        "id": 4,
        "article": "5.24.c",
        "title": "Fences and Walls",
        "description": "As stated in Article 5.24(c) - All fences and walls shall be constructed and installed and maintained in good appearance and condition at the expense of the Owner of the Lot on which they are located and all damaged fencing and walls shall be repainted or replaced to original design, materials, and color within a reasonable time after said damage occurs.",
        "created_at": "2019-07-30T21:16:48.006Z",
        "updated_at": "2019-07-30T21:16:48.009Z",
        "account_id": 2,
        "external_id": null
      }
    },
    "relationships": {}
  }
}