### GET /offices.json Source: https://buildout.com/api/v1 Returns a paginated list of Company Offices. ```APIDOC ## GET /offices.json ### Description Returns a paginated list of Company Offices. ### Method GET ### Endpoint /offices.json ### Response #### Success Response (200) - **office** (object) - The office ``` -------------------------------- ### Buildout API v1 - General GET Endpoints Source: https://buildout.com/api/v1 A list of common read-only GET endpoints available in the Buildout API v1 for accessing various data entities. ```http GET /companies.json GET /companies/ID.json GET /brokers.json GET /brokers/ID.json GET /properties.json GET /properties/ID.json GET /lease_spaces.json GET /lease_spaces/ID.json GET /lots.json GET /lots/ID.json ``` -------------------------------- ### GET /offices/ID.json Source: https://buildout.com/api/v1 Returns a single office by id. ```APIDOC ## GET /offices/ID.json ### Description Returns a single office by id. ### Method GET ### Endpoint /offices/{ID}.json ### Parameters #### Path Parameters - **ID** (integer) - Required - The unique identifier of the office. ### Response #### Success Response (200) - **office** (object) - The office matching the requested ID ``` -------------------------------- ### Create a new condo Source: https://buildout.com/api/v1 Endpoint for creating a condo and a curl example for the POST request. ```http POST /condos.json ``` ```bash curl https://buildout.com/api/v1//condos.json \ -d '{"condo": {"property_id": 1, "address2": "Suite 100", "deal_status_id": 1, "sale_price": 1700, "sale_price_units": "dollars_per_sf", "size": 1200, "size_units": "sf"}}' \ -H "Content-Type: application/json" -X POST ``` -------------------------------- ### GET /brokers/ID.json Source: https://buildout.com/api/v1 Returns a single broker by id. ```APIDOC ## GET /brokers/ID.json ### Description Returns a single broker by id. ### Method GET ### Endpoint /brokers/{ID}.json ### Parameters #### Path Parameters - **ID** (integer) - Required - The unique identifier of the broker. #### Query Parameters - **include_non_brokers** (boolean) - Optional - Also return users who are not brokers. ### Response #### Success Response (200) - **broker** (object) - The broker matching the requested ID ``` -------------------------------- ### Get Condo Source: https://buildout.com/api/v1 Retrieves a single condo by its unique ID. ```APIDOC ## GET /condos/ID.json ### Description Returns a single condo by id. ### Method GET ### Endpoint /condos/ID.json ### Response #### Success Response (200) - **condo** (object) - The condo matching the requested ID. #### Response Example ```json { "condo": { "id": 1, "property_id": 1, "unit_number": "101", "square_footage": 1200 } } ``` ``` -------------------------------- ### GET /brokers.json Source: https://buildout.com/api/v1 Returns a list of all brokers with optional filtering. ```APIDOC ## GET /brokers.json ### Description Returns a list of all brokers. ### Method GET ### Endpoint /brokers.json ### Parameters #### Query Parameters - **limit** (integer) - Optional - Maximum number of brokers to include in results. - **offset** (integer) - Optional - Return list of brokers starting at this index. - **email** (string) - Optional - Allows you to filter by email. - **include_non_brokers** (boolean) - Optional - Also return users who are not brokers. - **include_disabled** (boolean) - Optional - Also return users who are disabled. ### Response #### Success Response (200) - **count** (integer) - The total number of brokers. - **brokers** (array) - A list of brokers. ``` -------------------------------- ### GET /properties.json Source: https://buildout.com/api/v1 Returns a list of all properties with various filtering and sorting options. ```APIDOC ## GET /properties.json ### Description Returns a list of all properties. ### Method GET ### Endpoint /properties.json ### Parameters #### Query Parameters - **company_id** (integer) - Optional - Only return properties from the specified company. - **company_office_id** (integer) - Optional - Only return properties from the specified company office. - **broker_id** (integer) - Optional - Only return properties from the specified broker. - **limit** (integer) - Optional - Maximum number of properties to include. - **offset** (integer) - Optional - Return list of properties starting at this index. - **on_market_only** (boolean) - Optional - Only return properties that are on market. - **under_contract_only** (boolean) - Optional - Only return properties that are under contract. - **closed_only** (boolean) - Optional - Only return properties that are closed. - **deal_type** (string) - Optional - Can be "sale" or "lease". - **proposal** (boolean) - Optional - Include proposals. - **exclude_drafts** (boolean) - Optional - Do not return properties in a draft state. - **property_type_id** (integer) - Optional - Only return properties with the specified property type. - **country_code** (string) - Optional - Only return properties with the specified country. - **sort_results** (Array) - Optional - Sorting criteria. ### Response #### Success Response (200) - **count** (integer) - The total number of properties. - **properties** (array) - A list of properties. ``` -------------------------------- ### GET /companies.json Source: https://buildout.com/api/v1 Retrieves a list of all companies associated with the account. ```APIDOC ## GET /companies.json ### Description Returns a list of all companies. ### Method GET ### Endpoint /companies.json ### Parameters #### Query Parameters - **limit** (integer) - Optional - Maximum number of companies to include in results. If null, return all companies. - **offset** (integer) - Optional - Return list of companies starting at this index ### Response #### Success Response (200) - **count** (integer) - The total number of companies, not taking into account the limit parameter - **companies** (array) - A list of companies ``` -------------------------------- ### GET /lease_spaces.json Source: https://buildout.com/api/v1 Retrieve a list of lease spaces, optionally scoped to a specific property. ```APIDOC ## GET /lease_spaces.json ### Description Returns a list of all lease spaces. Can be scoped to a specific property using /properties/PROPERTY_ID/lease_spaces.json. ### Method GET ### Endpoint /lease_spaces.json ### Parameters #### Query Parameters - **limit** (integer) - Optional - Maximum number of lease spaces to include in results (default: 30) - **offset** (integer) - Optional - Return list of lease spaces starting at this index (default: 0) ### Response #### Success Response (200) - **count** (integer) - The total number of lease spaces, not taking into account the limit parameter - **lease_spaces** (array) - A list of lease spaces ``` -------------------------------- ### Buildout API v1 Base URL Source: https://buildout.com/api/v1 The base URL for all read-only GET requests in the Buildout API v1. Replace with your actual API key. ```http https://buildout.com/api/v1/ ``` -------------------------------- ### GET /brokers/lookup_external_ids.json Source: https://buildout.com/api/v1 Returns a list of all users matching the provided external_ids. ```APIDOC ## GET /brokers/lookup_external_ids.json ### Description Returns a list of all users matching the provided external_ids, up to a maximum of ten (10) users. ### Method GET ### Endpoint /brokers/lookup_external_ids.json ### Parameters #### Query Parameters - **external_ids[]** (List of integers) - Required - Which ExternalID records to look up. ### Response #### Success Response (200) - **brokers.message** (string) - Status of the request. - **brokers.records** (object) - Mapping of ExternalID => BuildoutUser. ``` -------------------------------- ### Update an existing condo Source: https://buildout.com/api/v1 Endpoint for updating a condo and a curl example for the PUT request. ```http PUT /condos/ID.json ``` ```bash curl https://buildout.com/api/v1//condos/1.json \ -d '{"condo": {"address2": "Suite 100"}}' \ -H "Content-Type: application/json" -X PUT ``` -------------------------------- ### Buildout API v1 - Get Company Endpoint Source: https://buildout.com/api/v1 Retrieve a single company's details by providing its unique ID. ```http GET /companies/ID.json ``` -------------------------------- ### POST /properties.json Source: https://buildout.com/api/v1 Create a new property listing in the Buildout system. ```APIDOC ## POST /properties.json ### Description Creates a new property listing using the provided broker and address information. ### Method POST ### Endpoint https://buildout.com/api/v1//properties.json ### Request Body - **property** (object) - Required - The property object containing details like broker_id and address. ### Request Example { "property": { "broker_id": 1, "address": "123 Main St." } } ``` -------------------------------- ### POST /lease_spaces.json Source: https://buildout.com/api/v1 Creates a new lease space with the provided details. ```APIDOC ## POST /lease_spaces.json ### Description Create a lease space. ### Method POST ### Endpoint /lease_spaces.json ### Parameters #### Request Body The POST request takes one parameter, a lease_space object. The following attributes can be present on lease_space: - **property_id** (integer) - Required - Foreign key reference to a Property - **tenant_name** (string) - Name of the tenant occupying the lease space - **deal_status_id** (integer) - Reference to DealStatus enum - **space_type_id** (integer) - Reference to PropertySubtype enum - **address2** (string) - Second line of address for lease space - Conditionally Required - **suite** (string) - Suite number - **floor** (string) - Floor number - **hide_lease_rate** (boolean) - Indicates that the lease rate should be hidden - **hidden_lease_rate_label_override** (string) - Override for Hidden Lease Rate Label - **price_per_sf_per_year** (float) - DEPRECATED - **price_per_sf_per_year_max** (float) - DEPRECATED | If this field is present the rate is a range from price_per_sf_per_year to price_per_sf_per_year_max - **lease_rate** (float) - Lease rate - Conditionally Required - **lease_rate_max** (float) - If this field is present the rate is a range from lease_rate to lease_rate_max - **lease_rate_units** (string) - Required - Reference to LeaseRateUnit option - **size_sf** (integer) - Required - Space size, in SF - **lease_type_id** (integer) - Conditionally Required - Reference to LeaseType enum - **lease_term** (string) - Lease term (months) - **min_divisible_sf** (integer) - Min divisible, in SF - **max_contiguous_sf** (integer) - Max contiguous, in SF - **sublease** (boolean) - Indicates that the space is sublease - **sublease_expiration** (date) - Expiration date of sublease - **description** (string) - Description of lease space - **cam_per_sf** (float) - Cam per SF - **cam_expense_stops** (float) - A tenant's responsibility for common area maintenance expenses and what the baseline is for these expenses. - **cooling** (boolean) - Is there cooling in the space - **cooling_description** (string) - Description of the cooling in the space - **heating** (boolean) - Is there heating in the space - **heating_description** (string) - Description of the heating in the space - **number_of_parking_spaces** (integer) - Number of parking spaces available for the lease space - **lease_terms** (string) - Contractual agreements between a landlord and tenant - **net_lease_investment** (boolean) - Is this a net lease investment or not - **number_of_offices** (integer) - Number of offices in the lease space - **signage_available** (boolean) - Indicates if signage is available for the lease space - **tenants_pay_electric** (boolean) - Indicates if tenants pay for electricity - **tenants_pay_gas** (boolean) - Indicates if tenants pay for gas - **tenants_pay_water** (boolean) - Indicates if tenants pay for water - **ti_allowance** (float) - The specific amount of money a landlord provides to a tenant to pay for office buildout - **date_available** (date) - Date available - **space_type_label_override** (string) - Override for space type label - **lease_type_label_override** (string) - Override for lease type label - **video_url** (string) - URL for LeaseSpace video - **matterport_url** (string) - URL to Matterport walkthrough - **virtual_tour_url** (string) - URL to virtual tour (non-Matterport) - **custom_fields** (object) - Custom fields, specific to each Buildout client - **photos** (array) - A list of LeaseSpace photos. The first one is the main photo. Limit 100 photos per LeaseSpace. - **external_id** (string) - Field for tracking ID of lease space in external systems - **floor_plan_url** (string) - Floor plan URL - **sort_order** (integer) - Sort order of lease space ### Request Example ```json { "lease_space": { "property_id": 1, "address2": "Suite 201" } } ``` ``` -------------------------------- ### Create Lot with Curl Source: https://buildout.com/api/v1 Use this curl command to create a new lot. You must provide the property ID, deal status ID, property subtype ID, size, and size units. Replace placeholders with your API key. ```bash curl https://buildout.com/api/v1//lots.json \ -d '{"lot": {"property_id": 1, "deal_status_id": 1, "property_subtype_id": 501, "size": 4, "size_units": "acres"}}' \ -H "Content-Type: application/json" -X POST ``` -------------------------------- ### Create Property Photo Interface Source: https://buildout.com/api/v1 Endpoint for creating a new property photo. ```text POST /properties/ID/photos.json ``` -------------------------------- ### POST /properties Source: https://buildout.com/api/v1 Creates a new property listing with the provided property attributes. ```APIDOC ## POST /properties ### Description Creates a new property record in the system. Requires specific property details including address, type, and subtype. ### Method POST ### Endpoint /properties ### Parameters #### Request Body - **broker_id** (integer) - Conditionally Required - Foreign key reference to this property's primary broker - **second_broker_id** (integer) - Optional - Foreign key reference to this property's second broker - **third_broker_id** (integer) - Optional - Foreign key reference to this property's third broker - **broker_ids** (array) - Conditionally Required - Array of foreign key references to this property's brokers - **address** (string) - Required - Property address - **city** (string) - Required - Property city - **state** (string) - Conditionally Required - Abbreviation for property state - **zip** (string) - Conditionally Required - Property ZIP code - **county** (string) - Conditionally Required - Property county name - **country_code** (string) - Optional - Reference to Country enum. Set to "US" if not set. - **country_name_override** (string) - Conditionally Required - Name of the property's country. Ignored unless country_code is set to "Other". - **hide_address** (boolean) - Optional - Indicates if address is hidden - **hide_address_label_override** (string) - Optional - Override for hidden address label - **latitude** (float) - Optional - Latitude coordinate - **longitude** (float) - Optional - Longitude coordinate - **market** (string) - Optional - Property market - **submarket** (string) - Optional - Property submarket - **cross_streets** (string) - Optional - Property cross streets - **location_description** (string) - Optional - Property location description - **name** (string) - Optional - Property name - **property_type_id** (integer) - Required - Reference to PropertyType enum - **property_type_label_override** (string) - Optional - Text to show instead of the property type's label - **property_subtype_id** (integer) - Required - Reference to PropertySubtype enum - **additional_property_subtype_ids** (array) - Optional - Array of PropertySubtype ids - **zoning** (string) - Optional - Property zoning - **apn** (string) - Optional - APN # - **lot_size_acres** (float) - Optional - Property lot size, in acres - **lot_size_hectares** (float) - Optional - Property lot size, in hectares - **lot_size_sf** (float) - Optional - Property lot size, in square feet - **lot_size_sm** (float) - Optional - Property lot size, in square meters - **you_tube_url** (string) - Optional - URL of YouTube video - **building_size_sf** (integer) - Conditionally Required - Property building size, in SF - **number_of_units** (integer) - Conditionally Required - Number of units in property - **number_of_floors** (integer) - Conditionally Required - Number of floors in property - **year_built** (integer) - Conditionally Required - Year when property was built - **ceiling_height_f** (float) - Optional - Property ceiling height, in feet - **ceiling_height_min** (float) - Optional - Minimum ceiling clearence - **renovated** (integer) - Optional - Year last renovated - **parking_ratio** (float) - Optional - Parking ratio per 1000 SF - **number_of_parking_spaces** (integer) - Optional - Number of parking spaces - **utilities_description** (string) - Optional - Description of utilities - **traffic_count** (integer) - Optional - Property traffic count - **traffic_count_street** (string) - Optional - Property Traffic count street - **traffic_count_frontage** (integer) - Optional - Traffic count frontage (ft) - **site_description** (string) - Optional - Description of property site - **grade_level_doors** (integer) - Optional - Number of grade level doors (industrial) - **dock_high_doors** (integer) - Optional - Number of dock high doors (industrial) - **number_of_cranes** (integer) - Optional - Number of cranes (industrial) - **sprinkler_description** (string) - Optional - Sprinker system description (industrial) - **power_description** (string) - Optional - Power system description (industrial) - **warehouse_pct** (integer) - Optional - Warehouse % (industrial) - **industrial_office_space** (integer) - Optional - Office Space (SF) (industrial) - **occupancy_pct** (float) - Optional - Occupancy % - **building_class** (string) - Conditionally Required - Building class (A, B, or C for office) - **gross_leasable_area** (integer) - Optional - Gross leasable area, in SF - **sale** (boolean) - Optional - Indicates that this is a sale listing - **sale_deal_status_id** (integer) - Optional - Reference to DealStatus enum - **auction** (boolean) - Optional - True if the property is being offered via auction - **auction_date** (date) - Optional - Date of auction - **auction_time** (string) - Optional - Time string in 30 minute increments - **auction_location** (string) - Optional - Location of auction - **auction_starting_bid_dollars** (integer) - Optional - Auction starting bid - **auction_url** (string) - Optional - Auction URL - **hide_sale_price** (boolean) - Optional - Indicates that the sale price should be hidden - **hidden_price_label** (string) - Optional - Text to show in place of hidden sale price - **sale_price_dollars** (float) - Optional - Sale price, in dollars ``` -------------------------------- ### Get Lot Source: https://buildout.com/api/v1 Retrieves a single lot by its unique ID. ```APIDOC ## GET /lots/ID.json ### Description Returns a single lot by id. ### Method GET ### Endpoint /lots/ID.json ### Response #### Success Response (200) - **lot** (object) - The lot matching the requested ID. #### Response Example ```json { "lot": { "id": 1, "property_id": 1, "address": "123 Main St", "size": 1.5, "size_units": "acres" } } ``` ``` -------------------------------- ### Create Property using curl Source: https://buildout.com/api/v1 Use this endpoint to create a new property listing. Ensure you replace \"\" with your actual API key and provide the necessary property details in JSON format. ```bash curl https://buildout.com/api/v1//properties.json \ -d '{"property": {"broker_id": 1, "address": "123 Main St."}}' \ -H "Content-Type: application/json" -X POST ``` -------------------------------- ### POST /offices.json Source: https://buildout.com/api/v1 Creates a new Company Office. ```APIDOC ## POST /offices.json ### Description Returns a newly created Company Office. ### Method POST ### Endpoint /offices.json ### Response #### Success Response (200) - **office** (object) - The office ``` -------------------------------- ### List Lease Spaces Interfaces Source: https://buildout.com/api/v1 Endpoints for retrieving lease spaces globally or scoped to a property. ```text GET /lease_spaces.json ``` ```text GET /properties/PROPERTY_ID/lease_spaces.json ``` -------------------------------- ### GET /condos/ID.json Source: https://buildout.com/api/v1 Retrieves a specific condo record by its unique identifier. ```APIDOC ## GET /condos/ID.json ### Description Retrieves the condo matching the requested ID. ### Method GET ### Endpoint /condos/{ID}.json ### Parameters #### Path Parameters - **ID** (integer) - Required - The unique identifier of the condo. ``` -------------------------------- ### POST /properties.json Source: https://buildout.com/api/v1 Create a new property record. ```APIDOC ## POST /properties.json ### Description Create a property. ### Method POST ### Endpoint /properties.json ``` -------------------------------- ### GET /properties/lookup_external_ids.json Source: https://buildout.com/api/v1 Look up a list of properties using their external identifiers. ```APIDOC ## GET /properties/lookup_external_ids.json ### Description Returns a list of all properties matching the provided external_ids, up to a maximum of ten (10) properties. ### Method GET ### Endpoint /properties/lookup_external_ids.json ### Parameters #### Query Parameters - **external_ids[]** (List of strings) - Required - Which ExternalID records to look up. - **minimal** (Boolean) - Optional - Only return the BuildoutID, rather than the entire property, for a given ExternalID. ### Response #### Success Response (200) - **message** (string) - Status of the request - **records** (object) - Mapping of ExternalID => Property ``` -------------------------------- ### POST /condos.json Source: https://buildout.com/api/v1 Creates a new condo record in the system. ```APIDOC ## POST /condos.json ### Description Create a new condo record. ### Method POST ### Endpoint /condos.json ### Parameters #### Request Body - **property_id** (integer) - Required - Foreign key reference to this condo's property - **address2** (string) - Optional - Secondary address of the condo - **deal_status_id** (integer) - Required - Reference to DealStatus enum - **description** (string) - Optional - Description - **hide_sale_price** (boolean) - Optional - Indicates the condo's sale price should be hidden - **hidden_price_label_override** (string) - Optional - Text displayed instead of the sale price if hide_sale_price is true - **sale_price** (float) - Required - Sale price - **sale_price_units** (string) - Required - Reference to Condo Sale Price Units option - **size** (float) - Required - Condo size - **size_units** (string) - Required - Reference to Condo Size Units option ``` -------------------------------- ### GET /companies/ID.json Source: https://buildout.com/api/v1 Retrieves details for a specific company by its unique identifier. ```APIDOC ## GET /companies/ID.json ### Description Returns a single company by id. ### Method GET ### Endpoint /companies/{ID}.json ### Parameters #### Path Parameters - **ID** (string) - Required - The unique identifier of the company ``` -------------------------------- ### POST /properties/ID/photos.json Source: https://buildout.com/api/v1 Create a new property photo. There is a limit of 100 photos per property. ```APIDOC ## POST /properties/ID/photos.json ### Description Create a property photo. Limit 100 photos per property. ### Method POST ### Endpoint /properties/ID/photos.json ### Parameters #### Request Body - **data** (string) - Optional - Base64 encoded photo - **url** (string) - Optional - URL of the photo; ignored if the data attribute is specified - **type** (string) - Optional - Valid values are ['Property Photo', 'Site Plan', 'Retailer Map'] - **description** (string) - Optional - Description of photo - **sort_order** (integer) - Optional - The order that the photos are returned. The photo with the smallest sort order is the main photo. Sort order must be unique for the attached object. if sort_order is not passed in, it will be given a number so that it is last in order ### Request Example { "photo": { "data": "Eijfv23kcKD1Iek..." } } ``` -------------------------------- ### GET /lease_spaces/ID.json Source: https://buildout.com/api/v1 Retrieves a specific lease space by its unique ID. ```APIDOC ## GET /lease_spaces/ID.json ### Description Retrieves a specific lease space by its unique ID. ### Method GET ### Endpoint /lease_spaces/ID.json ### Response #### Success Response (200) - lease_space (object) - The lease space matching the requested ID ``` -------------------------------- ### Create Lot Source: https://buildout.com/api/v1 Creates a new lot associated with a property. ```APIDOC ## POST /lots.json ### Description Create a lot. ### Method POST ### Endpoint /lots.json ### Parameters #### Request Body - **lot** (object) - Required - The lot object containing attributes. - **property_id** (integer) - Required - Foreign key reference to the lot's property. - **deal_status_id** (integer) - Required - Reference to DealStatus enum. - **property_subtype_id** (integer) - Required - Reference to PropertySubtype enum; must be a land type (501 - 507). - **size** (float) - Required - Lot size. - **size_units** (string) - Required - Reference to Lot Size Units option. - **address** (string) - Optional - The lot's street address if different from the property's address. - **apn** (string) - Optional - Assessor's parcel number. - **description** (string) - Optional - Lot description. - **number** (string) - Optional - Lot number or name. - **sale_price** (float) - Optional - Sale price. - **sale_price_units** (string) - Optional - Reference to Lot Price Units option. - **zoning** (string) - Optional - Zoning description. ### Request Example ```json { "lot": { "property_id": 1, "deal_status_id": 1, "property_subtype_id": 501, "size": 4, "size_units": "acres" } } ``` ### Response #### Success Response (200) - **lot** (object) - The newly created lot object. #### Response Example ```json { "lot": { "id": 2, "property_id": 1, "deal_status_id": 1, "property_subtype_id": 501, "size": 4, "size_units": "acres", "address": null, "apn": null, "description": null, "number": null, "sale_price": null, "sale_price_units": null, "zoning": null } } ``` ``` -------------------------------- ### Create Lease Space Photo with curl Source: https://buildout.com/api/v1 This curl command demonstrates how to add a new photo to a lease space. The photo data should be Base64 encoded. The API supports adding photos directly or via a URL. ```bash curl https://buildout.com/api/v1//lease_spaces/1/photos.json \ -d '{"photo": {"data": "Eijfv23kcKD1Iek..."}}' \ -H "Content-Type: application/json" -X POST ``` -------------------------------- ### Create Lease Space Photo Source: https://buildout.com/api/v1 Creates a new photo for a specific lease space. Photos must be unique per lease space, with a limit of 100 photos per lease space. ```APIDOC ## POST /lease_spaces/{ID}/photos.json ### Description Creates a lease space photo. Limit 100 photos per Lease Space. ### Method POST ### Endpoint `/lease_spaces/{ID}/photos.json` or `/properties/{PROPERTY_ID}/lease_spaces/{LEASE_SPACE_ID}/photos.json` ### Parameters #### Request Body - **photo** (object) - Required - An object containing the photo details. - **data** (string) - Required - Base64 encoded photo. Ignored if `url` is specified. - **url** (string) - Optional - URL of the photo; ignored if the `data` attribute is specified. - **type** (string) - Optional - Valid values are ['Property Photo', 'Site Plan', 'Retailer Map']. - **description** (string) - Optional - Description of photo. - **sort_order** (integer) - Optional - The order that the photos are returned. The photo with the smallest sort order is the main photo. Sort order must be unique for the attached object. If `sort_order` is not passed in, it will be given a number so that it is last in order. ### Request Example ```json { "photo": { "data": "Eijfv23kcKD1Iek..." } } ``` ``` -------------------------------- ### Create Property Photo via cURL Source: https://buildout.com/api/v1 Uploads a base64 encoded photo to a specific property. ```bash curl https://buildout.com/api/v1//properties/1/photos.json \ -d '{"photo": {"data": "Eijfv23kcKD1Iek..."}}' \ -H "Content-Type: application/json" -X POST ``` -------------------------------- ### GET /properties/{ID}.json Source: https://buildout.com/api/v1 Retrieves a specific property object based on its unique identifier. ```APIDOC ## GET /properties/{ID}.json ### Description Retrieves the property matching the requested ID. ### Method GET ### Endpoint /properties/{ID}.json ### Parameters #### Path Parameters - **ID** (string) - Required - The unique identifier of the property. ### Response #### Success Response (200) - **property** (object) - The property matching the requested ID. ``` -------------------------------- ### Create Lease Space Source: https://buildout.com/api/v1 Creates a new lease space record. Requires a lease_space object containing mandatory fields like property_id, lease_rate_units, and size_sf. ```http POST /lease_spaces.json ``` ```bash curl https://buildout.com/api/v1//lease_spaces.json \ -d '{"lease_space": {"property_id": 1, "address2": "Suite 201"}}' \ -H "Content-Type: application/json" -X POST ``` -------------------------------- ### GET /lease_spaces/lookup_external_ids.json Source: https://buildout.com/api/v1 Looks up lease spaces using one or more external IDs. Returns a maximum of ten lease spaces. ```APIDOC ## GET /lease_spaces/lookup_external_ids.json ### Description Returns a list of all lease spaces matching the provided external_ids, up to a maximum of ten (10) lease spaces. ### Method GET ### Endpoint /lease_spaces/lookup_external_ids.json ### Query Parameters - **external_ids** (List of External IDs) - Required - Which ExternalID records to look up - **minimal** (Boolean) - Optional - Only return the BuildoutID, rather than the entire lease space, for a given ExternalID ### Response #### Success Response (200) - message (string) - Status of the request - records (object) - Mapping of ExternalID => LeaseSpace ``` -------------------------------- ### Buildout API v1 - List Companies Endpoint Source: https://buildout.com/api/v1 Use this endpoint to retrieve a list of all companies. You can customize the results using limit and offset parameters. ```http GET /companies.json ``` -------------------------------- ### List Condos Source: https://buildout.com/api/v1 Retrieves a list of all condos, optionally scoped to a specific property and with pagination. ```APIDOC ## GET /condos.json ### Description Returns a list of all condos. ### Method GET ### Endpoint /condos.json ### Parameters #### Query Parameters - **limit** (integer) - Required - Maximum number of condos to include in results. - **offset** (integer) - Optional - Default: 0. Return list of condos starting at this index. ### Response #### Success Response (200) - **count** (integer) - The total number of condos, not taking into account the limit parameter. - **condos** (array) - A list of condo objects. #### Response Example ```json { "count": 5, "condos": [ { "id": 1, "property_id": 1, "unit_number": "101", "square_footage": 1200 } ] } ``` ``` -------------------------------- ### List Lots Source: https://buildout.com/api/v1 Retrieves a list of all lots, optionally scoped to a specific property and with pagination. ```APIDOC ## GET /lots.json ### Description Returns a list of all lots. ### Method GET ### Endpoint /lots.json ### Parameters #### Query Parameters - **limit** (integer) - Required - Maximum number of lots to include in results. - **offset** (integer) - Optional - Default: 0. Return list of lots starting at this index. ### Response #### Success Response (200) - **count** (integer) - The total number of lots, not taking into account the limit parameter. - **lots** (array) - A list of lot objects. #### Response Example ```json { "count": 10, "lots": [ { "id": 1, "property_id": 1, "address": "123 Main St", "size": 1.5, "size_units": "acres" } ] } ``` ``` -------------------------------- ### Lookup Lease Spaces by External IDs Source: https://buildout.com/api/v1 Retrieves up to ten lease spaces based on a list of provided external IDs. ```http GET /lease_spaces/lookup_external_ids.json?external_ids[]=1&external_ids[]=2&external_ids[]=3 ```