SPspotnana
Companies

Get company

Changed on

This endpoint gets a company by ID.

get/v2/companies/{companyId}

Request

  • Base URL
    https://api-ext-sboxmeta.partners.spotnana.com
  • Auth
    HTTP bearer

Path parameters

companyIdstring required

Identifier for company. External id can be supplied in X prefixed form. For instance, if external_id = abc, then Xabc, has to be passed.

Headers

x-application-idstring uuid

Response

OK

namestring required

Company name

emailDomainsstring[]

List of the company email domains

billingCurrencystring required

Billing currency of the company

isSelfSignUpEnabledboolean

Boolean to show if company has self sign up enabled.

isActiveboolean

Boolean to show if this is an active company.

companyRolesCompanyRole[] required

Company roles

isDemoboolean

True for a Demo company, whose supplier calls all go to emulators. Set at creation and immutable. Omitted on create means false; omitted on update keeps the stored value.

orgType'CORPORATE' | 'LEISURE' | 'SPONSOR'

Type of the organization. CORPORATE is a regular business org, LEISURE is a family org where an employee books personal travel, and SPONSOR is the org that sponsors a corporate org's leisure program.

ccEmailAddressesstring[]

List of email addresses on which all confirmation emails will be cced. This is applicable only for company roles 'ORG'

bccEmailAddressesstring[]

List of email addresses on which all confirmation emails will be bcced. This is applicable only for company roles 'ORG'

redirectUrlstring

Redirect URL for the company. It is applicable only for company roles 'PARTNER_TMC'

mobileRedirectUrlstring

Redirect URL for the company for mobile. It is applicable only for company roles 'PARTNER_TMC'

applicableCustomFieldTypesCustomFieldType[]

List of custom fields supported by the company.

externalIdstring

External id to be linked with this.

isFakeboolean

Whether the company is a fake company for testing. This is for internal use.

loyaltyBlockedCountriesstring[]

List of 2 letter country codes where business travelers should not be allowed to add loyalty info.

allowDomainBasedAuthConfigboolean

Whether to allow user to get auth config based on email domain

Changes

  • 7dfd37fd8978Revision changes
    • warning

      added the new DELAYED_PAYMENT enum value to the //// response property for the response status

    • warning

      added the new DELAYED_PAYMENT enum value to the // response property for the response status

    • info

      added the optional property to the response with the status

  • f9546a529d75Revision changes
    • info

      added the optional property to the response with the status

    • info

      response property isSelfSignUpEnabled deprecated with sunset date 2027-07-01