List Container groups

List Container groups

GET https://api.ocamba.com/v1/hood/groups
Returns a list of Container groups

Tip

Sortable fields are: id, name, num_of_items, create_time and update_time.

Filterable fields are: id, name, num_of_items, create_time and update_time.

Rate limits:

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

Query parameters

parameters

Response schemas

curl -X GET \
 "https://api.ocamba.com/v1/hood/groups" \
  -H "Authorization: Bearer {TOKEN}"
const url = 'https://api.ocamba.com/v1/hood/groups';
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/groups");
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": 50,
  "items": [
    {
      "id": "453",
      "company_id": "6197120",
      "name": "nesta",
      "color": "#836265",
      "num_of_items": 9,
      "create_time": "2020-09-08 08:25:59",
      "update_time": "2022-06-29 07:25:08"
    },
    {
      "id": "479",
      "company_id": "6197120",
      "name": "Test #135496",
      "color": "#e3b694",
      "num_of_items": 1,
      "create_time": "2020-10-06 11:16:34",
      "update_time": "2022-05-25 14:16:03"
    }
  ]
}

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