Uber Developers

Search Employees

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

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 Search Employees endpoint allows you to search for employees of an organization.

¶ Authorization

The Search Employees 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 search employees 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
`email`	string	Yes	The email address of an employee.
`group_name`	string	Yes	The name of the group Note: This value is case sensitive
`is_admin`	boolean	Yes	Whether the employee is an admin.
`phone`	string	Yes	The phone number of the employee. Note: Enter phone number without country code. Works on prefix match as well.
`program_name`	string	Yes	Name of program employee is part of
`program_category`	string	Yes	Category of the program employee part of
`limit`	int	Yes	The number of employees in a page. Note: Default value is `50`. The maximum allowed value is `1000`
`start_key`	string	Yes	The page token of the employees. Required when fetching later pages of employee

¶ Response Fields

Name	Type	Description
`employees`	array	A list of employees objects.
`employees[].first_name`	string	First name of the employee.
`employees[].last_name`	string	Last name of the employee.
`employees[].email`	string	Email id of the employee.
`employees[].mobile_country_code`	string	The mobile country code of the employee. If no code is provided but mobile_number is provided, code of the organization will be taken as default code.
`employees[].mobile_number`	string	The mobile number of the employee.
`employees[].u4b_data`	object	Object containing employee data specific to uber for business.
`employees[].u4b_data.employee_id`	string	The employee ID of the employee.
`employees[].u4b_data.reviewer`	string	The email id of the reviewer.
`employees[].u4b_data.is_admin`	boolean	Check if employee is admin.
`employees[].u4b_data.status`	string	The status of an employee Below are the possible values: `CREATED` `INVITED` `LINKED_PENDING_APPROVAL` `LINKED` `SUSPENDED` `DELETED`
`employees[].u4b_data.linking_url`	string	URL to be used by the employee to confirm an invitation to the Uber for Business Organization. Note: This field is only returned if the employee is not linked.
`employees[].u4b_data.invite_count`	int	Number of times the employee is invited to the Uber for Business Organization. Note: This field is only returned if the employee is not linked.
`employees[].u4b_data.last_invite_timestamp`	string	The timestamp of the last invitation sent to the employee. Eg: “2022-09-28T06:58:46Z”
`employees[].u4b_data.groups`	array	List of groups the employee is in.
`employees[].u4b_data.groups[].uuid`	string	Group identifier.
`employees[].u4b_data.groups[].name`	string	Group Name.
`employees[].u4b_data.programs[].program_id`	string	Unique identifier of the program
`employees[].u4b_data.programs[].name`	string	Program Name.
`employees[].u4b_data.programs[].description`	string	Description of the program
`employees[].u4b_data.programs[].category`	string	Category of the program. Possible values are `RIDES` `EATS` `GUESTS` `VOUCHERS` `HEALTH` `UNKNOWN`
`next_start_key`	string	Page token for the next page.

¶ Example Request with email filter

curl -X GET -H "Authorization: Bearer <TOKEN>" \
  "https://api.uber.com/v1/business/organizations/<organization_id>/employees/search?email=test"

¶ Example Response

Status-Code: 200 OK

{
 "employees": [{
   "first_name": "test",
   "last_name": "test",
   "email": "test@uber.com",
   "mobile_country_code": "+91",
   "mobile_number": "1234567899",
   "u4b_data": {
     "employee_id": "test.test",
     "reviewer": "test1@uber.com",
     "is_admin": false,
     "status": "INVITED",
     "linking_url": "https://<url>",
     "last_invite_timestamp": "2022-09-28T06:58:46Z",
     "invite_count": 2,
     "groups": [
       {
         "uuid": "uuid",
         "name": "test"
       }
     ]
     "programs":[]
   }
 }]
}

¶ Example Request with program_category filter

curl --location 'https://api.uber.com/v1/business/organizations/731d15b2-1e20-4c1b-9ac6-354924502d10/employees/search?program_category=RIDES' \
--header 'Authorization:<token>'

¶ Example Response

Status-Code: 200 OK

{
    "employees": [
        {
            "first_name": "Jeet",
            "last_name": "Kamte",
            "email": "abhinavs+test+kamte@uber.com",
            "u4b_data": {
                "employee_id": "",
                "billing_mode": "CENTRALIZED",
                "is_admin": false,
                "groups": [
                    {
                        "uuid": "206ff5e0-99a9-45f1-ba2a-8d8c143dfd10",
                        "name": "General",
                    }
                ],
                "programs": [
                    {
                        "program_id": "28d64c7e-77f0-442b-bdfa-4b0c20b42bbd",
                        "name": "Business travel",
                        "description": "A general Uber for Business programme for business travel.",
                        "category": "RIDES"
                    }
                ],
                "status": "LINKED",
                "last_invite_timestamp": "2023-04-18T11:51:06Z"
            }
        },
        {
            "first_name": "Abhinav",
            "last_name": "First",
            "email": "abhinavs+test+first@uber.com",
            "u4b_data": {
                "billing_mode": "CENTRALIZED",
                "is_admin": true,
                "groups": [
                    {
                        "uuid": "206ff5e0-99a9-45f1-ba2a-8d8c143dfd10",
                        "name": "General",
                        "programs": null
                    }
                ],
                "programs": [
                    {
                        "program_id": "28d64c7e-77f0-442b-bdfa-4b0c20b42bbd",
                        "name": "Business travel",
                        "description": "A general Uber for Business programme for business travel.",
                        "category": "RIDES"
                    }
                ],
                "status": "LINKED",
                "last_invite_timestamp": "2023-03-27T17:46:26Z"
            }
        }
    ],
    "next_start_key": ""
}

¶ Error Responses

HTTP Status	Code	Description
400	`BAD_REQUEST`	Invalid parameters passed in request.
401	`NOT_AUTHORIZED`	Caller not authorized to make this request
404	`ENTITY_NOT_FOUND`	The entity does not exist. Eg: Non-existent `group_name` requested
429	`rate_limited`	Rate limit exceeded
500	`INTERNAL_SERVER_ERROR`	We have experienced a problem