Skip to content
API reference
/
Company
/
/
Read company preference t...

Company API (v2)

Download OpenAPI description
CompanyApi.json
CompanyApi.yaml
Languages
Servers
Sandbox URL
https://api-ext-sboxmeta.partners.spotnana.com
Spotnana mock server
https://developer.spotnana.com/_mock/openapi/companyapi

Companies

APIs to onboard and manage company.

Operations

Store tier levels with labels

Request

This endpoint store the tiers with respective label for a company.

Security
Bearer
Path
companyIdstring(uuid)required

Identifier for company.

Example: 4974a66b-7493-4f41-908c-58ba81093947
Bodyapplication/jsonrequired
preferenceTiersPerBookingTypeArray of objects(PreferenceTiersPerBookingType)required

List of preference tiers with respective labels for different booking types.

preferenceTiersPerBookingType[].​allowedEntityTypesArray of strings(PreferenceEntityType)non-emptyrequired

Different entity types that are allowed for defining preference.

Items Enum"COMPANY""LEGAL_ENTITY""COUNTRY"
preferenceTiersPerBookingType[].​bookingTypestring(BookingType)required

What type of travel booking it is.

Enum"AIR""HOTEL""CAR""RAIL""LIMO"
preferenceTiersPerBookingType[].​preferenceTiersArray of objects(PreferenceTier)required

List of preference tiers with respective labels.

preferenceTiersPerBookingType[].​preferenceTiers[].​levelstring(PreferenceTierLevel)required

Different levels of tier.

Enum"TIER_1""TIER_2""TIER_3""TIER_4""TIER_5""TIER_6"
preferenceTiersPerBookingType[].​preferenceTiers[].​labelstringrequired

Text to be used to display given tier.

preferenceTiersPerBookingType[].​preferenceTiers[].​descriptionstring

Short description about the tier level.

preferenceTiersPerBookingType[].​preferenceTiers[].​showLabelbooleanrequired

Whether to show label in search result for the given tier.

Default false
curl -i -X PUT \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/companies/4974a66b-7493-4f41-908c-58ba81093947/preference-tiers \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "preferenceTiersPerBookingType": [
      {
        "allowedEntityTypes": [
          "COMPANY"
        ],
        "bookingType": "AIR",
        "preferenceTiers": [
          {
            "level": "TIER_1",
            "label": "string",
            "description": "string",
            "showLabel": false
          }
        ]
      }
    ]
  }'

Responses

OK

Response
No content

Read company preference tiers

Request

Read all preference tiers with respective label for a company.

Security
Bearer
Path
companyIdstring(uuid)required

Identifier for company.

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

Responses

OK

Bodyapplication/json
preferenceTiersPerBookingTypeArray of objects(PreferenceTiersPerBookingType)required

List of preference tiers with respective labels for different booking types.

preferenceTiersPerBookingType[].​allowedEntityTypesArray of strings(PreferenceEntityType)non-emptyrequired

Different entity types that are allowed for defining preference.

Items Enum"COMPANY""LEGAL_ENTITY""COUNTRY"
preferenceTiersPerBookingType[].​bookingTypestring(BookingType)required

What type of travel booking it is.

Enum"AIR""HOTEL""CAR""RAIL""LIMO"
preferenceTiersPerBookingType[].​preferenceTiersArray of objects(PreferenceTier)required

List of preference tiers with respective labels.

preferenceTiersPerBookingType[].​preferenceTiers[].​levelstring(PreferenceTierLevel)required

Different levels of tier.

Enum"TIER_1""TIER_2""TIER_3""TIER_4""TIER_5""TIER_6"
preferenceTiersPerBookingType[].​preferenceTiers[].​labelstringrequired

Text to be used to display given tier.

preferenceTiersPerBookingType[].​preferenceTiers[].​descriptionstring

Short description about the tier level.

preferenceTiersPerBookingType[].​preferenceTiers[].​showLabelbooleanrequired

Whether to show label in search result for the given tier.

Default false
Response
application/json
{
  "preferenceTiersPerBookingType": [
    { … }
  ]
}

Get company support config

Request

Security
Bearer
Path
companyIdstring(uuid)required

Identifier for company.

Example: 4974a66b-7493-4f41-908c-58ba81093947
Headers
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/support-config \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-application-id: 4974a66b-7493-4f41-908c-58ba81093947'

Responses

OK

Bodyapplication/json
contactNumbersArray of objects(PhoneNumber)

List of support phone numbers.

emailAddressesArray of stringsunique

List of the support email addresses.

Example: ["support@spotnana.com"]
freshdeskConfigobject(FreshdeskConfig)

Configuration for freshdesk.

tierstring(Tier)

Tier of User. Note: In default UI, BASIC is displayed as Standard, and SEAT1A is displayed as VIP. Display names for other tiers are driven by the company tier configuration.

Default "BASIC"
Enum"BASIC""SEAT1A""TIER_2""TIER_3""TIER_4""TIER_5""TIER_6""TIER_7""TIER_8""TIER_9"
genesysConfigobject(GenesysConfig)

Configuration for genesys.

portalUrlsArray of stringsunique

List of the support portal urls.

Example: ["www.support.spotnana.com"]
zendeskConfigobject(ZendeskConfig)

Configuration for zendesk.

genesysCloudConfigobject(GenesysCloudConfig)

Configuration for Genesys cloud.

twilioChatConfigobject(TwilioChatConfig)

Configuration for Twilio Chat.

cognigyChatConfigobject(CognigyChatConfig)

Cognigy Chat Config.

Response
application/json
{
  "contactNumbers": [
    { … }
  ],
  "emailAddresses": [
    "support@spotnana.com"
  ],
  "freshdeskConfig": {
    "enabled": true,
    "hasCredentials": false,
    "credentials": { … }
  },
  "tier": "SEAT1A",
  "genesysConfig": {
    "enabled": true,
    "dataUrl": "string"
  },
  "portalUrls": [
    "www.support.spotnana.com"
  ],
  "zendeskConfig": {
    "enabled": true,
    "integrationId": "1234567890",
    "androidIntegrationId": "1234567890",
    "iosIntegrationId": "1234567890"
  },
  "genesysCloudConfig": {
    "enabled": true,
    "deploymentId": "52dc2a6f-772a-4edf-96d3-b3f0c49400a7",
    "environment": "usa-1",
    "genesysScriptUrl": "https://test.test.com",
    "clientId": "1ab2cd3efghijklmnop4qr5s6t"
  },
  "twilioChatConfig": {
    "enabled": true
  },
  "cognigyChatConfig": {
    "enabled": true,
    "scriptUrl": "https://your-cognigy-instance.com/script/abcdef123456",
    "initWebchatEndpoint": "https://your-cognigy-instance.com/initWebchat",
    "sessionTimeout": 30,
    "cssUrl": "https://your-server.com/css/chat.css"
  }
}

Cost Centers

APIs to create and manage company cost centers.

Operations

Offices

APIs to create and manage company offices.

Operations

Departments

APIs to create and manage departments.

Operations

Grades

APIs to create and manage grades.

Operations

Service Charge Plan

APIs to manage service charge plans.

Operations

Partner Public Keys

APIs to manage partner public keys for token exchange authentication.

Operations

Tenant Encryption

APIs to enable per-tenant encryption (PTE) for a company.

Operations

Service Charge

Operations

Company Enrollment

Operations

Company Tier

Operations

Stealth Config

Operations
Copyright © 2026 Spotnana Technology, Inc.