List Profile Properties

List Profile Properties

GET https://api.ocamba.com/v1/hood/profile-properties

Returns a list of profile Properties

Rate limits:

Burst: 10/s
Steady: 150/m

Query parameters

parameters

Response schemas

GET https://api.ocamba.com/v1/hood/profile-properties HTTP/1.1
Host: api.ocamba.com
Authorization: Bearer YOUR_SECRET_TOKEN
curl -X GET "https://api.ocamba.com/v1/hood/profile-properties" \
  -H "Authorization: Bearer $TOKEN"
fetch("https://api.ocamba.com/v1/hood/profile-properties", {
  method: "GET",
  headers: { Authorization: `Bearer ${TOKEN}` }
}).then(r => r.json());
$ch = curl_init("https://api.ocamba.com/v1/hood/profile-properties");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "Authorization: Bearer $token"
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);

Responses

200 OK

HTTP/1.1 200 OK
Content-Type: application/json

{
  "total": 5,
  "items": [
    {
      "id": "1000105",
      "company_id": "7196310",
      "target": "my_region",
      "label": "my_region",
      "data_type": "text",
      "example": "northern_europe",
      "description": "Custom region information associated with the profile. Can be used to group or filter profiles based on regional segmentation defined by your organization.",
      "import_aliases": [
        "region_name"
      ],
      "export_alias": "region_name",
      "pi_data": 1,
      "system": 1,
      "importable": 1,
      "exportable": 1,
      "create_time": "2025-01-29 12:47:00",
      "update_time": "2025-01-30 14:27:26"
    }
  ]
}

400 Bad Request

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
  "code": 400,
  "title": "Bad request.",
  "message": "The request body is not valid.",
  "trace_id": "99a84211-f73d-4ff8-acdf-eb3e06bb9d62"
}

500 Internal Server Error

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
  "code": 500,
  "title": "Internal server error.",
  "trace_id": "99a84211-f73d-4ff8-acdf-eb3e06bb9d62"
}
Responses

Tip
1
Searchable fields are: target, label and description.
2
Sortable fields are: data_type, pi_data, importable, exportable, create_time, update_time.
3
Filterable fields are: id, target, label, data_type, example, pi_data, system, importable, exportable, create_time, update_time.