[API] Get Organizations
Get list of all organizations that application has access to.
¶ Resource
/v1/vehicle-suppliers/orgs
¶ HTTP Method
GET
¶ Access Method
¶ Required scopes
vehicle_suppliers.organizations.read
¶ Example Request
curl GET "https://api.uber.com/v1/vehicle-suppliers/orgs" \
-H "Authorization: Bearer <TOKEN>" \
-H "Content-Type: application/json"
¶ 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 |
¶ Example Response
Status-code: 200
{
"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"
]
}
]
}
¶ 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 |