Bitium

Languages

Admin - Groups

retrieve the groups within an organization

Required Scopes

  • ORG_READ

Request Parameters

Name Type Required Description
page integer No Page of results to fetch.
Default value: 1
per_page integer No Number of results to return per page.
q string No Query string (partial name of a group)

 

Endpoint Copy

GET https://www.bitium.com/api/v2/organizations/{organization_id}/admin/groups

Example Request

curl -H "Authorization: token {token}" \
-H "X-Device-Id: {unique_id}" \
https://www.bitium.com/api/v2/organizations/{organization_id}/admin/groups?page=1&per_page=1 

Example Response

[
  {
    "installations_count": 3, 
    "contacts_count": 3, 
    "created_at": "2015-05-07T14:29:25.203-07:00", 
    "id": 4635, 
    "name": "Engineering"
  }, 
  {
    "installations_count": 0, 
    "contacts_count": 3, 
    "created_at": "2015-05-07T14:30:07.358-07:00", 
    "id": 4636, 
    "name": "Marketing"
  }
]

retrieve a group

Required Scopes

  • ORG_READ

 

Endpoint Copy

GET https://www.bitium.com/api/v2/organizations/{organization_id}/admin/groups/{group_id}

Example Request

curl -H "Authorization: token {token}" \
-H "X-Device-Id: {unique_id}" \
https://www.bitium.com/api/v2/organizations/{organization_id}/admin/groups/{group_id}?page=1&per_page=1 

Example Response

{
	"id": 1,
	"name": "Unicorn Princesses",
	"contacts_count": 0,
	"installations_count": 0,
	"created_at": "2015-08-28T15:46:33.238-07:00"
}