GET
/
communities
curl --location --request GET 'https://api.travtus.com/communities/?name={Your_Community_name_here}' \
--header 'Authorization: bearer <token>'

{
  "communities": [
    {
      "community_id": "test1234-4e84-4d02-8fa1-71d5ff0e0979",
      "community_external_ref": "987123",
      "name": "Test Community",
      "description": null,
      "location": {
        "latitude": "34.0811089",
        "longitude": "-84.2789026"
      },
      "timezone": "America/New_York",
      "website": "https://community.test.com/apartments/community-test",
      "phone_number": "801-456-1234",
      "email": "[email protected]",
      "status": "active"
    }
  ],
  "last_id": -1
}

You need to provide at least one search parameter in your request to find communities.

​
Example use cases

This endpoint allows you to find communities (properties or building portfolios) based on various parameters:

  • Retrieve a specific community by its ID or external reference
  • Search for communities by name
  • Paginate through results for larger data sets
​
Authorization
string
default:"none"
required

The authentication token for your request

​
Query Parameters

​
community_id
string
default:"none"

The unique identifier for the community.

​
community_external_ref
string
default:"none"

The external reference ID for the community.

​
name
string
default:"none"

The name of the community to search for.

​
after_id
integer
default:"1"

The API returns a maximum of 100 records per call.

You can use this parameter to load the next set of records by passing in the value returned in the response, under last_id.

​
Response

​
communities
array

A list of communities that match the search criteria.

​
last_id
integer

The ID to use with the after_id parameter to get the next page of results. A value of -1 indicates that there are no more pages available.

​
Errors

Listed below are common errors that may be returned by the endpoint, along with their corresponding status code.

Status Code - 400

Missing Authorization header
{
  "error": {
    "type": "missing_authorization",
    "message": "Your request does not include an 'Authorization' header with a bearer token for your account."
  }
}

Status Code - 401

Expired Authorization header bearer token value
{
  "error": {
    "type": "expired_token",
    "message": "The bearer token you have provided in the 'Authorization' header has expired. Please obtain a new one."
  }
}

Status Code - 401

Invalid Authorization header bearer token value
{
  "error": {
    "type": "invalid_authorization",
    "message": "The bearer token you have provided in the 'Authorization' header is invalid."
  }
}

Status Code - 400

No search parameters provided
{
  "error": {
    "type": "no_search_parameters",
    "message": "At least one search parameter is required to find communities."
  }
}

Status Code - 404

Returned if no communities could be found.

No communities found
{
  "error": "No communities found matching the provided criteria."
}

Status Code - 500

Internal server error
{
  "error": "An internal error occurred while processing your request."
}

curl --location --request GET 'https://api.travtus.com/communities/?name={Your_Community_name_here}' \
--header 'Authorization: bearer <token>'

{
  "communities": [
    {
      "community_id": "test1234-4e84-4d02-8fa1-71d5ff0e0979",
      "community_external_ref": "987123",
      "name": "Test Community",
      "description": null,
      "location": {
        "latitude": "34.0811089",
        "longitude": "-84.2789026"
      },
      "timezone": "America/New_York",
      "website": "https://community.test.com/apartments/community-test",
      "phone_number": "801-456-1234",
      "email": "[email protected]",
      "status": "active"
    }
  ],
  "last_id": -1
}