API Platform Base Path: https://api.enterprise.apigee.com/v1/o/{org_name}
API Resource Path: /companies/{company_name}
Gets details for a Company
Verb: GET
Auth: Basic AuthSample Response:
{
"apps" : [ ],
"name" : "DevCompany",
"displayName" : "Developer Company",
"organization" : "myorg",
"status" : "active",
"attributes" : [ {
"name" : "region",
"value" : "north"
} ],
"createdAt" : 1343049811765,
"createdBy" : "Admin",
"lastModifiedAt" : 1343049811765,
"lastModifiedBy" : "Admin"
}
Response Payload Elements:
| Name | Description |
|---|---|
| apps | Apps associated with the company |
| name | Name of the company |
| displayName | Display name of the company |
| organization | organization containing the company |
| status | Status of the company--active or inactive. |
| attributes | Arbitrary attribues that may be used to extend the default company profile |
| createdAt | UNIX time when the entity was created |
| createdBy | Apigee account user who created the entity |
| lastModifiedAt | UNIX time when the entity was last modified |
| lastModifiedBy | Apigee account user who last modified the entity |
Failure 4xx with proper error message
{
"code" : "developer.service.CompanyDoesNotExist",
"message" : "Company named DevCompany1 does not exist in organization {organizationName}",
"contexts" : [ ]
}