Uber Developers

Get Groups

GEThttps://api.uber.com/v1/business/organizations/{organization_id}/groups

Privileged and Confidential This endpoint design has been confidentially shared with you. It is still under development and is subject to change without notice. Please do not share this document or API endpoint details with anyone who is not authorized to have access. For more information read about scopes.

¶ Use Case

The Get Groups endpoint allows you to get groups of an organization.

¶ Authorization

The Get Groups endpoint requires an access_token using the client credentials (for 1P use-case) grant to business.employees scope.

If an application follows third party authentication, the get groups endpoint requires the client to get authorized using the authorization endpoint

¶ Path Parameters

Name	Type	Optional	Description
`organization_id`	string	No	Identifier for your organization.

¶ Query Parameters

Name	Type	Optional	Description
`limit`	int	No	The number of groups in a page. Note: Default value is `50`. The maximum allowed value is `1000`
`start_key`	string	No	The page token of the groups.

¶ Response Fields

Name	Type	Description
`groups`	array	A list of group objects.
`groups[].group_id`	string	Unique identifier of the group object.
`groups[].name`	string	Name of the group.
`groups[].programs`	array	A list of program objects.
`groups[].programs[].program_id`	string	Unique identifier of the program object
`groups[].programs[].name`	string	The program name.
`groups[].programs[].category`	string	The category of program. Below are the possible values: `RIDES` `EATS` `GUESTS` `VOUCHERS` `HEALTH`
`next_start_key`	string	Page token for the next page.

¶ Example Request

curl -X GET -H "Authorization: Bearer <TOKEN>" \
  "https://api.uber.com/v1/business/organizations/<organization_id>/groups"

¶ Example Response

Status-Code: 200 OK

{
 "groups": [
     {
         "id": "af08b1d7-dc71-43bc-847a-524169810f55",
         "name": "General",
         "programs": [
           {
             "id": "af08b1d7-dc71-43bc-847a-524169810d55",
             "name": "General",
             "category": "EATS"
           },
           {
             "id": "cgfe1d7-dc71-43bc-847a-524169810g55",
             "name": "Rides",
             "category": "RIDES"
           }
         ]
     },
     {
       "id": "ff08b1d7-dc71-43bc-847a-524169810h55",
       "name": "Late Night Meal",
       "programs": [
         {
           "id": "fdggre-dc71-43bc-847a-524169810i55",
           "name": "General",
           "category": "EATS"
         },
         {
           "id": "egfe1d7-dc71-43bc-847a-524169810j55",
           "name": "Late Night Meal",
           "category": "EATS"
         }
       ]
      
   }
 ],
 "next_page_token": "2"
}

¶ Error Responses

HTTP Status	Code	Description
400	`BAD_REQUEST`	request specific message
401	`NOT_AUTHORIZED`	Caller not authorized to make this request
429	`rate_limited`	Rate limit exceeded
500	`INTERNAL_SERVER_ERROR`	We have experienced a problem