APappdirect
Companies

Read a company

Changed on

Retrieve a marketplace company by ID or external ID. If you use the ID, you can omit a prefix or use 'id:' as the prefix. If you use the external ID, you must always specify the 'externalId:' prefix.

Examples:

  • By ID: GET /api/account/v2/companies/d689b970-f3f9-42a6-a974-90e2bdadf860
  • By external ID: GET /api/account/v2/companies/externalId:37ac4899-0847-41ac-8e6b-adfde0363b37
get/account/v2/companies/{companyUuid}

Request

Path parameters

companyUuidstring required

Unique identifier of the company. Pass the company UUID (optionally with an id: prefix), or the company external ID with a required externalId: prefix. Examples: d689b970-f3f9-42a6-a974-90e2bdadf860, id:d689b970-f3f9-42a6-a974-90e2bdadf860, externalId:37ac4899-0847-41ac-8e6b-adfde0363b37.

Response

Success

uuidstring

Company ID

namestring nullable

Company name

enabledboolean

Indicates whether company is enabled

allowLoginboolean

Indicates whether a company's users are managed users (false) or not (true). Managed users access their products directly, not through the marketplace, therefore they cannot log in. The default is "true"

companySize'SMALL' | 'MEDIUM' | 'ENTERPRISE'

Company size types

creationDatenumber

Company creation date

industrystring

Company industry sector

emailAddressstring

Company email address

websitestring

Company website URL

picturestring nullable

Company profile picture URL

vendorboolean

Indicates whether the company has Vendor access

resellerboolean

Indicates whether the company has Reseller access

channelAdminboolean

Indicates whether the company has Channel Admin access

referralboolean

Indicates whether the company has Referral access

externalIdstring

Company external ID

phoneNumberstring nullable

Company phone number

defaultRolestring

The default role newly created users receive

countryCodestring

Company country code defined by ISO ALPHA-2 standard

status'ACTIVE' | 'INACTIVE'

Company status

thirtyDaysPurchaseLimitnumber

Monthly spend limit of marketplace

thirtyDaysPurchaseRemainingAmtnumber

Monthly remaining spending amount

dailyPurchaseLimitnumber

Daily spend limit of marketplace

dailyPurchaseRemainingAmtnumber

Daily remaining spending amount

thirtyDaysPurchaseLimitExemptboolean

Indicates if company is exempt from the marketplace default thirty day spend limit

thirtyDaysPurchaseLimitOverrideAmtnumber

Company-level override amount of marketplace default thirty day spend limit

dailyPurchaseLimitExemptboolean

Indicates if company is exempt from the marketplace default daily spend limit

dailyPurchaseLimitOverrideAmtnumber

Company-level override amount of marketplace default daily spend limit

onlyAdminsCanBuyboolean

Indicates if only selected roles in company that can make purchases or all roles in company can make purchases

importAppsEnabledboolean

The import apps feature is enabled for this company

billingDayOfMonthinteger

(Optional) Use this property in company creation requests to set the billing cycle start date. The date applies to all purchases made through the specified company, and overrides the marketplace-level billing cycle date.

mosiCustomerIdstring

Microsoft customer account linked to the company

partnerstring

Partner name

Example response

{
  "uuid": "d689b970-f3f9-42a6-a974-90e2bdadf860",
  "name": "Company 7078259907",
  "enabled": true,
  "address": {
    "city": "San Francisco",
    "country": "United Stated of America",
    "state": "California",
    "street1": "5th Ave",
    "street2": "#400",
    "zip": "32455"
  },
  "companySize": "SMALL",
  "customAttributes": [
    {
      "name": "Geographic Region",
      "attributeType": "TEXT",
      "label": "Geographic Region",
      "hint": "US West, US Central, or US East",
      "value": "US"
    },
    {
      "name": "Company Details",
      "attributeType": "MULTISELECT",
      "label": "Label Names",
      "hint": "",
      "valueKeys": [
        "great option"
      ]
    }
  ],
  "creationDate": 123455,
  "industry": "IT",
  "salesAgent": {
    "rel": "sales",
    "href": "http://appdirect/api/account/v2/users/d689b970-f3f9-42a6-a974-90e2bdadf860"
  },
  "emailAddress": "info@company.com",
  "website": "http://www.company.com",
  "picture": "http://localhost:8080/profilePics/http://cdn/company.png",
  "vendor": false,
  "reseller": false,
  "channelAdmin": false,
  "externalId": "d689b970-f3f9-42a6-a974-90e2bdadf860",
  "phoneNumber": "9259221234",
  "defaultRole": "USER",
  "countryCode": "US",
  "status": "INACTIVE",
  "thirtyDaysPurchaseLimit": 0,
  "thirtyDaysPurchaseLimitExempt": false,
  "thirtyDaysPurchaseLimitOverrideAmt": null,
  "thirtyDaysPurchaseRemainingAmt": null,
  "dailyPurchaseLimit": 0,
  "dailyPurchaseLimitExempt": false,
  "dailyPurchaseLimitOverrideAmt": 10,
  "dailyPurchaseRemainingAmt": null,
  "mosiCustomerId": "dda1de23-f062-4391-b213-4deab524552a",
  "partner": "APPDIRECT",
  "links": [
    {
      "rel": "self",
      "href": "http://appdirect/api/account/v2/companies/d689b970-f3f9-42a6-a974-90e2bdadf860"
    },
    {
      "rel": "memberships",
      "href": "http://appdirect/api/account/v2/companies/d689b970-f3f9-42a6-a974-90e2bdadf860/memberships"
    }
  ]
}

Changes