Get company

Request

This endpoint gets a company by ID.

Security

Bearer

Path

companyIdstringrequired

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

Example:4974a66b-7493-4f41-908c-58ba81093947

x-application-idstring, (uuid)

Example:4974a66b-7493-4f41-908c-58ba81093947

curl -i -X GET \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/companies/4974a66b-7493-4f41-908c-58ba81093947 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-application-id: 4974a66b-7493-4f41-908c-58ba81093947'

Responses

Bodyapplication/json

idobject(CompanyId)required

Company ID

namestringrequired

Company name

Example:"Spotnana"

emailDomainsArray of strings, unique

List of the company email domains

Example:

[
  "spotnana.com"
]

billingCurrencystringrequired

Billing currency of the company

Example:"INR"

phoneNumbersArray of objects(PhoneNumber)

List of company phone numbers

emergencyContactInfosArray of objects(EmergencyContactInfo)

List of company emergency contacts

announcementsArray of objects(Announcement)

Company announcements

companyLogoobject(Image)

Company logo

contractedByobject(CompanyId)

Company ID which have contracted this company.

isActiveboolean

Boolean to show if this is an active company.

companyRolesArray of stringsrequired

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.

Example:false

orgTypestring(CompanyOrgType)read-only

Org type of the company. Read only, ignored on update.

Enum:"CORPORATE""LEISURE""SPONSOR"

Example:"CORPORATE"

ccEmailAddressesArray of strings

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

Example:

[
  "example@gmail.com"
]

bccEmailAddressesArray of strings

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

Example:

[
  "example@gmail.com"
]

connectorsArray of objects(Connector)

Connectors related to company.

postalAddressobject(PostalAddress)

Postal address of the company.

redirectUrlstring

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

tmcDefaultConfigurationobject(TmcDefaultConfiguration)

Default Booking configuration for the TMC. It is applicable only for company roles 'TMC'

expensePartnerConfigobject(ExpensePartnerConfig)

Expense Partner Configuration

mobileRedirectUrlstring

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

applicableCustomFieldTypesArray of strings

List of custom fields supported by the company.

oauthPartnerConfigobject(OAuthConfig)

Config for token exchange in case of partner's have their own IDP.

privacySettingsobject(PrivacySettings)

Privacy settings for a company.

designationTreeobject(DesignationNode)

Designation tree for company showing who reports whom.

externalIdstring

External id to be linked with this.

Example:"MyCompanyId"

emailClientConfigobject(EmailClientConfig)

Email client configuration representing the email provider to be used.

isFakeboolean

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

Default:false

Example:false

tmcPartnerRoleMappingsArray of objects(TmcPartnerRoleMapping)

list of individual role mappings between spotnana and partner.

supportConfigsobject(SupportConfigs)

loyaltyBlockedCountriesArray of strings

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

Example:

[
  "US",
  "IN"
]

allowDomainBasedAuthConfigboolean

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

Default:false

carbonCostConfigobject(CarbonCostConfig)

The config is used to calculate carbon cost of CO2 emission.

defaultBookingTmcIdobject(CompanyId)

Default booking TMC id. For PARTNER_TMC companies only.

bookingTmcIdobject(CompanyId)

Booking TMC ID for the company. Applicable for ORG role companies.

companySpecifiedAttributesArray of objects(CompanySpecifiedAttributeCompany)

Company-specified custom attributes.

isSelfSignUpEnabledbooleandeprecated

Boolean to show if company has self sign up enabled.

Example:true

supportConfigobject(SupportConfig)deprecated

Support Configuration for company

rewardsProgramobject(RewardsProgram)deprecated

Reward Program corresponding to partner. It is applicable only for company roles 'PARTNER_TMC'.

Response

{
  "id": {
    "id": "f49d00fe-1eda-4304-ba79-a980f565281d"
  },
  "name": "Spotnana",
  "emailDomains": [
    "spotnana.com"
  ],
  "billingCurrency": "INR",
  "phoneNumbers": [
    { … }
  ],
  "emergencyContactInfos": [
    { … }
  ],
  "isSelfSignUpEnabled": true,
  "announcements": [
    { … }
  ],
  "companyLogo": {
    "data": "6935813e12584abda0e43d71cd2ea260",
    "dimensions": { … },
    "url": "https://static.wixstatic.com/media/73f2e2_6935813e12584abda0e43d71cd2ea260~mv2.png/v1/fill/w_630,h_94,al_c,q_85,usm_0.66_1.00_0.01/Spotnana%403x.webp",
    "metadata": { … }
  },
  "contractedBy": {
    "id": "f49d00fe-1eda-4304-ba79-a980f565281d"
  },
  "isActive": true,
  "companyRoles": [
    "ORG"
  ],
  "isDemo": false,
  "orgType": "CORPORATE",
  "supportConfig": {
    "contactNumbers": [ … ],
    "emailAddresses": [ … ],
    "freshdeskConfig": { … },
    "tier": "SEAT1A",
    "genesysConfig": { … },
    "portalUrls": [ … ],
    "zendeskConfig": { … },
    "genesysCloudConfig": { … },
    "twilioChatConfig": { … },
    "cognigyChatConfig": { … }
  },
  "ccEmailAddresses": [
    "example@gmail.com"
  ],
  "bccEmailAddresses": [
    "example@gmail.com"
  ],
  "connectors": [
    { … }
  ],
  "postalAddress": {
    "addressLines": [ … ],
    "administrativeArea": "CA",
    "administrativeAreaName": "California",
    "description": "San Francisco Home",
    "isDefault": true,
    "languageCode": "en",
    "locality": "San Francisco",
    "locationCode": "LAX",
    "organization": "Spotnana",
    "postalCode": "94130",
    "continentCode": "AF",
    "recipients": [ … ],
    "regionCode": "US",
    "regionName": "America",
    "revision": 1,
    "sortingCode": "Jamaica",
    "sublocality": "string",
    "timezone": "America/Los_Angeles",
    "coordinates": { … }
  },
  "redirectUrl": "string",
  "rewardsProgram": {
    "allowedUserRoles": [ … ],
    "conversionRate": { … },
    "redeemablePaymentMethods": [ … ],
    "backingCurrency": [ … ]
  },
  "tmcDefaultConfiguration": {
    "defaultBookingTmcId": "734f4ea2-e9ed-4c90-853c-9eed62f1254b",
    "countryWiseBookingTmcs": [ … ]
  },
  "expensePartnerConfig": {
    "partner": "EXPENSIFY",
    "emailConfig": { … },
    "travelType": [ … ],
    "isExpensePartnerEnabled": true,
    "reportCustomFields": true,
    "personalCardExpenseOwner": { … },
    "centralCardExpenseOwner": { … },
    "partnerReferralId": "1234hgd",
    "itineraryConfig": { … }
  },
  "mobileRedirectUrl": "string",
  "applicableCustomFieldTypes": [
    "QUESTION"
  ],
  "oauthPartnerConfig": {
    "name": "string",
    "userDetailEndpoint": { … },
    "tokenVerifier": { … },
    "doPersistToken": true
  },
  "privacySettings": {
    "allowCompanyAdminAccessToRelativesInfo": true
  },
  "designationTree": {
    "name": "string",
    "children": [ … ]
  },
  "externalId": "MyCompanyId",
  "emailClientConfig": {
    "client": "SENDGRID",
    "credentials": { … },
    "defaultSenderAddress": "test@somedomain.com",
    "defaultSenderName": "Test Sender"
  },
  "isFake": false,
  "tmcPartnerRoleMappings": [
    { … }
  ],
  "supportConfigs": {
    "length": 0,
    "elements": [ … ]
  },
  "loyaltyBlockedCountries": [
    "US",
    "IN"
  ],
  "allowDomainBasedAuthConfig": false,
  "carbonCostConfig": {
    "price": { … },
    "weight": { … }
  },
  "defaultBookingTmcId": {
    "id": "f49d00fe-1eda-4304-ba79-a980f565281d"
  },
  "bookingTmcId": {
    "id": "f49d00fe-1eda-4304-ba79-a980f565281d"
  },
  "companySpecifiedAttributes": [
    { … }
  ]
}

Get company

Request

Path

Headers

Responses