View Container group

GET /groups/{id}
Copied
Arrow
                https://api.ocamba.com/v1/hood/groups/{id}

Retrieves the details of a Container group that has previously been created if a valid identifier was provided

Rate limits:

Burst: 10/s
Steady: 150/m

path Parameters
Arrow
Name
Description
idstringrequired
Unique resource identifier.


Example: 12345
query Parameters
Arrow
Name
Description
fieldsstring
Fields parameter represents array of dimensions and measures. Dimensions are used to categorize, segment, and reveal the details of the data. Measures contain numeric, quantitative values that can be measured. At least one measure is required.


Example: fields=field1,field2,field3
viewstring
Hood API returns full representation of the resource using the "view=full" query parameter. If not specified, the default view will be used.

Note that the "fields" parameter has precedence over the "view" parameter.


Example: view=full/default

Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ group ]
An array of all created items.
Group
Name
Description
colorstring
Group color.


Example: #6d9382
company_idstring
A unique company identifier generated by the Ocamba.


Example: 7196310
create_timestring
Timezone: GMT.


Example: 2021-10-29 12:47:00
descriptionstring
The more detailed description of the Group.


Example: This is my first group.
idstring
A unique identifier generated by the Ocamba.


Example: 450
item_idsarray
This field isn't readable, it helps you add items to the group on group creation.


Example: ["30677878","44676391","7403921"]
namestring
Group name.


Example: example_group_name
num_of_itemsnumber
Number of items.


Example: 9
update_timestring
Timezone: GMT.


Example: 2021-10-30 14:27:26
totalinteger
A total number of items.


Example: 1
tip
1 If you don't know the group id, list the groups to find it.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
    "total": 1,
    "items": [
        {
            "id": "481",
            "company_id": "6197120",
            "name": "test",
            "color": "#6d9382",
            "num_of_items": 2,
            "item_ids": [
                "30677878",
                "44676391",
                "7403921"
            ],
            "create_time": "2020-10-13 08:12:29",
            "update_time": "2022-04-20 13:21:12"
        }
    ]
}

{
  "total": 1,
  "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"
    }
  ]
}