List Profile Lists

List Profile Lists

GET https://api.ocamba.com/v1/hood/profile-lists
Returns a list of Profile Lists

Tip

Searchable field is: name.

Sortable fields are: name, description, color, create_time and update_time.

Filterable fields are: id, name, color, create_time, update_time.

Rate limits:

  • Burst: 10/s
  • Steady: 150/m

Query parameters

parameters

Response schemas

curl -X GET \
 "https://api.ocamba.com/v1/hood/profile-lists" \
  -H "Authorization: Bearer {TOKEN}"
const url = 'https://api.ocamba.com/v1/hood/profile-lists';
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-lists");
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": "1000101",
      "company_id": "6197120",
      "name": "black friday list",
      "description": "List of all profiles who subscribed through the black firday newsletter.",
      "color": "#bba19f",
      "create_time": "2025-01-28 13:38:37",
      "update_time": "2025-01-28 13:38:37"
    },
    {
      "id": "1000109",
      "company_id": "6197120",
      "name": "Christmas sale list",
      "description": "List of all profiles who subscribed thourgh the christmas sale campaign.",
      "color": "#bdc19f",
      "create_time": "2025-01-29 12:38:23",
      "update_time": "2025-01-29 12:38:23"
    },
    {
      "id": "1000110",
      "company_id": "6197120",
      "name": "Returning buyers list",
      "description": "List of all profiles who were flagged as returning buyers.",
      "color": "#296a1d",
      "create_time": "2025-01-29 13:54:03",
      "update_time": "2025-02-03 13:54:53"
    }
  ]
}

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"
}
Responses