List Profile Properties

curl -X GET \
 "https://api.ocamba.com/v1/hood/profile-properties" \
  -H "Authorization: Bearer {TOKEN}"

const url = 'https://api.ocamba.com/v1/hood/profile-properties';
const options = {
  method: 'GET',
  headers: {
    Authorization: `Bearer {TOKEN}`
  }
};

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

$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

{
  "total":5,
  "items":[
    {
      "id": "343986",
      "company_id": "1000001",
      "target": "full_name",
      "property": "full_name",
      "description": "The profile's full legal name. It is used for identification purposes and to personalize communication.",
      "data_type": "text",
      "example": "Jane Doe",
      "system": 1,
      "importable": 1,
      "exportable": 1,
      "import_aliases": [
        "full_name",
        "name",
        "profile_name",
        "profile_name",
        "contact_name",
        "display_name"
      ],
      "create_time": "2025-03-28 14:42:40",
      "update_time": "2025-04-09 13:30:39"
    },
    {
      "id": "343994",
      "company_id": "1000001",
      "target": "region_name",
      "property": "region_name",
      "description": "The name of a specific geographic region or administrative division within a country. It can represent a state, province, district, or any other subdivision depending on the country. This field helps to identify the profile’s location more specifically, enabling localized services, targeted marketing, or regional analysis.",
      "data_type": "text",
      "example": "North Sinai",
      "system": 1,
      "importable": 1,
      "exportable": 1,
      "import_aliases": [
        "region_name",
        "region",
        "state",
        "province",
        "territory",
        "area"
      ],
      "create_time": "2025-03-31 10:17:08",
      "update_time": "2025-04-09 13:29:26"
    },
    {
      "id": "344282",
      "company_id": "1234567",
      "target": "email_addr",
      "property": "email_addr",
      "data_type": "text",
      "example": "[email protected]",
      "system": 0,
      "importable": 1,
      "exportable": 1,
      "export_alias": "email_address",
      "create_time": "2025-04-09 10:38:57",
      "update_time": "2025-04-09 10:38:57"
    },
  ]
}

400 Bad Request

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

500 Internal Server Error

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