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 Core Persistence Services enabled, a maximum of 1,000 companies are returned per API call. You can control the number of companies returned (under 1,000) as well as which compnay is first in the list with the optional count and startKey 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

Optional.

CPS This parameter can only be used in organizations with Core Persistence Services enabled.

Limits the list to the number you specify. Use with the startKey parameter to provide more targeted filtering. The limit is 1000.

startKey

Optional.

CPS This parameter can only be used in organizations with Core Persistence Services enabled.

To filter the keys that are returned, enter the email of a developer that the list will start with. For example, if the an unfiltered list returns:

company1
company2
company3

and your startKey is company2, the returned list will be:

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?)