You are viewing the Apigee Management API reference documentation. For the main product docs, and to search all docs, go to https://docs.apigee.com. For cross-site search, click Search all in the search results.

List Companies

Resource Summary

Security

Content Type

application/json, text/xml

Category

Company,

listAndExpandCompanies

GET

List Companies

List all companies in an organization, and optionally returns an expanded list of companies, displaying a full profile for each company in the organization.

 

With Apigee Edge for Public Cloud:

  • The maximum number of companies returned is 1000.
  • You can paginate the list of companies returned using the startKey and count query parameters.

Resource URL

https://api.enterprise.apigee.com/v1 /organizations/{org_name}/companies

Query Parameters

Name Values Description
expand

Set expand to true to return a full profile for each company.

count

Apigee Edge for Public Cloud only: Number of companies to return in the list. The maximum limit is 1000. Use with the startkey to provide more targeted filtering.

startKey

Apigee Edge for Public Cloud only: Returns a list of companies starting with the specified company. For example, if the an unfiltered list includes the following company names:
company1
company2
company3

If you set the startKey to company2, the list will include:
company2
company3

Request Body

org_name Mention the organization name true

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Working...

Help or comments?

  • If something's not working: Ask the Apigee Community or see Apigee Support.
  • If something's wrong with the docs: Click the "Send Feedback" button.
    (Incorrect? Unclear? Broken link? Typo?)