Companies API

download spec authorize
Companies API
Company

Company

Company.

Schema

Company
apps

array

Output only. Apps associated with the company.

name

string

Name of the company. Required when creating a company. Notes:

  • Company names must use a unique sequence of characters, regardless of case. For example, if you create a company named CompanyA and subsequently attempt to create a company named companya, an error is thrown.
  • Do not set the company name to 0 (number or string). This value is not supported and will cause unexpected results. See naming restrictions.
displayName

string

Display name for the company.

organization

string

Output only. Organization name.

status

string

Output only. Status of the company. Valid values are active or inactive. Defaults to active when creating the company. To change the value, see Update a company.

attributes

array

Name/value formatted attributes used to extend the default company profile. Note: With Apigee Edge for Public Cloud, the custom attribute limit is 18.

object
name

string

Name of the attribute.

value

string

Value of the attribute.

createdAt

integer

Output only. Time when the company was last modified in seconds since epoch.

lastModifiedAt

integer

Output only. Time when the company was last modified in seconds since epoch.

lastModifiedBy

string

Output only. Email address of developer that last modified the company.

Paths

The following paths use this type:

/organizations/{org_name}/companies/post

Creates a company in an organization.

You must set the ADMIN_EMAIL attribute to the email of the company administrator.

The company is always created with a status of active. To set the status explicitly, see Update a company.

To set the company's billing type (PREPAID or POSTPAID), make sure the organization profile is configured to support your setting (for example, set to accept BOTH). See Edit the organization profile.

For a list of attributes that are supported for monetization, see Configuring monetization attibutes.

/organizations/{org_name}/companies/{company_name}/delete

Deletes a company.

/organizations/{org_name}/companies/{company_name}/get

Gets company details.

/organizations/{org_name}/companies/{company_name}/put

Updates an existing company.

Send the complete company record as a payload with any changes you want to make. For a list of attributes that are supported for monetization, see Configuring monetization attibutes.

To update the status of a company, set the action query parameter to active or inactive and Content-type to application/octet-stream. If you set the status to inactive, you cannot access the developers and apps associated with the company. In this case, the API returns a 204: No Content status.

Notes:

  • You cannot update the status of a company by passing the value in the request body.
  • Currently, updating the status of a company cannot be executed using the Try this API panel.

If you want to change the company's billing type (PREPAID or POSTPAID), make sure the organization profile is configured to support your setting (for example, set to accept BOTH). See Edit the organization profile.