Was this helpful?

 

Base Path: https://api.enterprise.apigee.com/v1/o/{org_name}

API Resource Path:

/companies?expand=true

Description: Returns an expanded list of companies, displaying a full profile for each company in the organization

Verb: GET
Auth: Basic Auth
Media types:
application/json
text/xml
Sample Request:
$ curl -X GET -H "Accept:application/json" \
https://api.enterprise.apigee.com/v1/o/{org_name}/companies?"expand=true" \]
-u myname:mypass
Sample Response:
{
  "company" : [ {
    "apps" : [ ],
    "name" : "DevCompany1",
    "displayName" : "",
    "organization" : "AutomationOrganization",
    "status" : "active",
    "attributes" : [ ],
    "createdAt" : 1343027924464,
    "createdBy" : "defaultUser",
    "lastModifiedAt" : 1343027924464,
    "lastModifiedBy" : "defaultUser"
  }, {
    "apps" : [ ],
    "name" : "DevCompany",
    "displayName" : "Developer Company",
    "organization" : "AutomationOrganization",
    "status" : "active",
    "attributes" : [ {
      "name" : "region",
      "value" : "south"
    } ],
    "createdAt" : 1343049811765,
    "createdBy" : "Admin",
    "lastModifiedAt" : 1343049811875,
    "lastModifiedBy" : "Admin"
  } ]
}
Response Payload Elements:
Name Description
company Settings for the company
apps A list of apps registered by the company
name Name of the company
displayName Display name of the company
organization Organization to which the company belongs
Errors:
{
 "code" : "developer.service.CompanyDoesNotExist",
 "message" : "Company named DevCompany1 does not exist in organization {organizationName}",
 "contexts" : [ ]
}

 

Add new comment

Provide your email address if you wish to be contacted offline about your comment.
We will not display your email address as part of your comment.

We'd love your feedback and perspective! Please be as specific as possible.
Type the characters you see in this picture. (verify using audio)

Type the characters you see in the picture above; if you can't read them, submit the form and a new image will be generated. Not case sensitive.