List Container groups

List Container groups

GET https://api.ocamba.com/v1/hood/groups

Returns a list of Container groups

Rate limits:

Burst: 10/s
Steady: 150/m

Query parameters

parameters

Response schemas

GET https://api.ocamba.com/v1/hood/groups HTTP/1.1
Host: api.ocamba.com
Authorization: Bearer YOUR_SECRET_TOKEN
curl -X GET "https://api.ocamba.com/v1/hood/groups" \
  -H "Authorization: Bearer $TOKEN"
fetch("https://api.ocamba.com/v1/hood/groups", {
  method: "GET",
  headers: { Authorization: `Bearer ${TOKEN}` }
}).then(r => r.json());
$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

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

{
  "total": 50,
  "items": [
    {
      "id": "450",
      "company_id": "7196310",
      "name": "example_group_name",
      "color": "#6d9382",
      "num_of_items": 9,
      "description": "This is my first group.",
      "item_ids": "[\"30677878\",\"44676391\",\"7403921\"] ",
      "create_time": "2021-10-29 12:47:00",
      "update_time": "2021-10-30 14:27:26"
    }
  ]
}
Responses

Tip
1
Sortable fields are: id, name, num_of_items, create_time and update_time.
2
Filterable fields are: id, name, num_of_items, create_time and update_time.