The Get Organizations endpoint is designed to retrieve a list of all organizations that an application has access to within the vehicle suppliers network.

¶ Usecase

The Get Organizations API facilitates efficient vehicle allocation management, grants access to organizational data, and supports service integration across branches. It ensures effective interaction between applications and the relevant entities, streamlining operations and improving service delivery at various locations. Additionally, this API provides real-time data updates, occurring in less than one minute.

¶ Support for Hierarchical Data

The Get Organizations API automatically operates within the hierarchical structure of the organization linked to the developer’s account at the time of setup.

¶ Supported supplier types

Rentals & Fleets

¶ Scopes

vehicle_suppliers.organizations.read

¶ Resource

/v1/vehicle-suppliers/orgs

¶ HTTP Method

GET

¶ Authorization

Client Credentials

¶ Example Request

curl GET "https://api.uber.com/v1/vehicle-suppliers/orgs" \
-H "Authorization: Bearer <TOKEN>" \
-H "Content-Type: application/json"

¶ Example Response

{
  "organizations": [
    {
      "id": "<org_id>",
      "parent_org_id": "<parent_org_id>",
      "name": "Test Company Seattle",
      "types": [
        "RENTAL_COMPANY"
      ]
    },
    {
      "id": "<org_id>",
      "parent_org_id": "<parent_org_id>",
      "name": "Test Company San Francisco",
      "types": [
        "RENTAL_COMPANY"
      ]
    },
    {
      "id": "<org_id>",
      "name": "Test Company HQ",
      "types": [
        "RENTAL_COMPANY"
      ]
    }
  ]
}

¶ Request Body parameters

The [API] Get Organizations endpoint retrieves a list of organizations without requiring request body parameters, using only headers, authorization, and content type.

¶ Response Fields

Name	Type	Description
organizations	object array	List of Organization objects

Organization object fields

Name	Type	Description
id	string	Organization ID
parent_org_id	string	ID of the vehicle supplier that owns the vehicle
name	string	ID of parent organization (if present)
types	enum_array	List of lines of businesses this organization provides. Options:
		DRIVER_BUSINESS
		RENTAL_COMPANY

¶ Rate limit

• The rate limit for this endpoint is 200 requests per hour (RPH).

¶ Endpoint Specific Errors

Http Status Code	Code	Message
401	unauthorized	Invalid OAuth 2.0 credentials provided
429	rate_limited	Number of requests exceeds allowed limit
500	internal_server_error	Internal server error
503	service_unavailable	Service unavailable

¶ Notes

• When integrating the Get Organizations API endpoint, Rental and Fleet suppliers need to consider several specific aspects of organization data. These include understanding the types of organizations retrievable (e.g., suppliers, dealers). The representation of organizational hierarchies and parent-child relationships, and the inclusion of geographical identifiers for optimizing vehicle distribution. Operational details such as hours of operation and services offered are crucial.