> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.coperniq.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.coperniq.io/_mcp/server.

# List Properties

GET https://api.coperniq.io/v1/properties

Retrieve list of properties organized by record type.

When `record_type` is **omitted**, the response includes all keys: `account`, `opportunity`,
`project`, `vendor`, `ahj`, and `utility` — plus the deprecated alias keys `client` and `request`.

When `record_type` is **provided**, the response contains only the requested key(s). Filtering
by `account` or `client` returns both `account` and `client` (identical data); filtering by
`opportunity` or `request` returns both `opportunity` and `request` (identical data).

> **Note:** `client` and `request` are deprecated aliases for `account` and `opportunity` respectively. They will continue to be returned until all users have migrated.

> **AHJ:** The `ahj` key returns only customer-defined custom properties (`isCustom: true`). Standard built-in AHJ fields are not included here — they are exposed directly on the AHJ object instead, and are not updatable via the public API.

> **Utility:** The `utility` key returns only customer-defined custom properties (`isCustom: true`). Standard built-in utility fields are not included here — they are exposed directly on the utility object instead, and are not updatable via the public API.

> **keyName semantics:** For built-in properties (`isCustom: false`), `keyName` is the public
> field name used on the record's create/update/read endpoints (e.g. `address`, `isActive`,
> `createdAt`) — not the internal storage key. Use the `readOnly` flag to tell which built-in
> fields can be sent on create/update (`readOnly: false`) versus which are system/derived
> fields you can only read (`readOnly: true`). For custom properties, `keyName` is the key
> used under the `custom` object, and `readOnly` is always `false`.


Reference: https://docs.coperniq.io/api-reference/properties/list-properties

## Authentication

- `x-api-key` header (required) — API Key authentication via header

## Request

### Query parameters

- `record_type` (enum, optional) — Filter by record type. Can also be supplied as a comma-separated list (`?record_type=project,vendor`) or repeated (`?record_type=project&record_type=vendor`) to request multiple types in one call. When omitted, the response includes every record-type key. When supplied, the response includes only the requested key(s) — plus the matching deprecated alias key where applicable (`account` ↔ `client`, `opportunity` ↔ `request`). > **Note:** `client` and `request` are deprecated aliases for `account` and `opportunity` respectively. They are still accepted as input.
  - Allowed values: `account`, `opportunity`, `project`, `vendor`, `ahj`, `utility`

## Response

### 200

List of properties

- `account` (list of Property, optional)
- `opportunity` (list of Property, optional)
- `project` (list of Property, optional)
- `vendor` (list of Property, optional)
- `ahj` (list of Property, optional) — Customer-defined custom AHJ properties only (`isCustom: true`). Standard built-in AHJ fields are not included.
- `client` (list of Property, optional, deprecated) — Deprecated alias for `account`. Contains identical data.
- `request` (list of Property, optional, deprecated) — Deprecated alias for `opportunity`. Contains identical data.

## Types

### Property

- `name` (string, optional) — Property name
- `type` (string, optional) — Property type
- `keyName` (string, optional) — For built-in (isCustom: false) properties, this is the public field name used on the record's create/update/read endpoints (e.g. `address`, `isActive`, `createdAt`). For custom (isCustom: true) properties, this is the key used under the `custom` object.
- `isMultiple` (boolean, optional) — Whether the property is a multiple value property
- `options` (list of string, optional) — Property options
- `defaultValue` (list of any, optional) — Default value
- `isCustom` (boolean, optional) — True for customer-defined custom columns, false for built-in standard properties.
- `readOnly` (boolean, optional) — True if this property cannot be sent on create/update — it is a system or derived field. Custom properties are always readOnly: false.

## Examples

**Response**

```json
{
  "account": [
    {
      "name": "string",
      "type": "string",
      "keyName": "string",
      "isMultiple": true,
      "options": [
        "string"
      ],
      "defaultValue": [
        "string"
      ],
      "isCustom": true,
      "readOnly": true
    }
  ],
  "opportunity": [
    {
      "name": "string",
      "type": "string",
      "keyName": "string",
      "isMultiple": true,
      "options": [
        "string"
      ],
      "defaultValue": [
        "string"
      ],
      "isCustom": true,
      "readOnly": true
    }
  ],
  "project": [
    {
      "name": "string",
      "type": "string",
      "keyName": "string",
      "isMultiple": true,
      "options": [
        "string"
      ],
      "defaultValue": [
        "string"
      ],
      "isCustom": true,
      "readOnly": true
    }
  ],
  "vendor": [
    {
      "name": "string",
      "type": "string",
      "keyName": "string",
      "isMultiple": true,
      "options": [
        "string"
      ],
      "defaultValue": [
        "string"
      ],
      "isCustom": true,
      "readOnly": true
    }
  ],
  "ahj": [
    {
      "name": "string",
      "type": "string",
      "keyName": "string",
      "isMultiple": true,
      "options": [
        "string"
      ],
      "defaultValue": [
        "string"
      ],
      "isCustom": true,
      "readOnly": true
    }
  ],
  "client": [
    {
      "name": "string",
      "type": "string",
      "keyName": "string",
      "isMultiple": true,
      "options": [
        "string"
      ],
      "defaultValue": [
        "string"
      ],
      "isCustom": true,
      "readOnly": true
    }
  ],
  "request": [
    {
      "name": "string",
      "type": "string",
      "keyName": "string",
      "isMultiple": true,
      "options": [
        "string"
      ],
      "defaultValue": [
        "string"
      ],
      "isCustom": true,
      "readOnly": true
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.coperniq.io/v1/properties"

headers = {"x-api-key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.coperniq.io/v1/properties';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.coperniq.io/v1/properties"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.coperniq.io/v1/properties")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.coperniq.io/v1/properties")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.coperniq.io/v1/properties', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.coperniq.io/v1/properties");
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.coperniq.io/v1/properties")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```