Company API (v2)

Download OpenAPI description
Languages
Servers
Staging URL
https://apis.spotnana.com/
Spotnana mock server
https://developer.spotnana.com/_mock/openapi/companyapi/

Companies

APIs to onboard and manage company.

Operations

Delete white label config

Request

This endpoint deletes the white label config for the company.

Path
companyIdstring(uuid)required

Identifier for company.

Example: 4974a66b-7493-4f41-908c-58ba81093947
Query
companyRolestring(CompanyRole)required

Role of the company.

Enum"ORG""TMC""PARTNER_TMC""HR_FEED_CONNECTOR""TRIPS_DATA_CONNECTOR""GLOBAL"
Example: companyRole=ORG
curl -i -X DELETE \
  'https://apis.spotnana.com/v2/companies/4974a66b-7493-4f41-908c-58ba81093947/white-label-config?companyRole=ORG' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Response
No content

Updates company managers config

Request

This endpoint stores company managers config (account managers and customer success managers) for the company at different entity levels.

Path
companyIdstring(uuid)required

Identifier for company.

Example: 4974a66b-7493-4f41-908c-58ba81093947
Query
companyRolestring(CompanyRole)required

Role of the company.

Enum"ORG""TMC""PARTNER_TMC""HR_FEED_CONNECTOR""TRIPS_DATA_CONNECTOR""GLOBAL"
Example: companyRole=ORG
Bodyapplication/jsonrequired
accountManagersArray of objects(CompanyManagerInfo)

List of detailed account manager information

customerSuccessManagersArray of objects(CompanyManagerInfo)

List of detailed customer success manager information

curl -i -X PUT \
  'https://apis.spotnana.com/v2/companies/4974a66b-7493-4f41-908c-58ba81093947/managers-config?companyRole=ORG' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "accountManagers": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "fullName": "John Doe",
        "email": "john.doe@company.com",
        "profilePictureUrl": "https://example.com/profiles/john-doe.jpg",
        "isActive": true
      }
    ],
    "customerSuccessManagers": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "fullName": "John Doe",
        "email": "john.doe@company.com",
        "profilePictureUrl": "https://example.com/profiles/john-doe.jpg",
        "isActive": true
      }
    ]
  }'

Responses

OK

Response
No content

Get company managers config

Request

This endpoint fetches the company managers config for the company.

Path
companyIdstring(uuid)required

Identifier for company.

Example: 4974a66b-7493-4f41-908c-58ba81093947
Query
companyRolestring(CompanyRole)required

Role of the company.

Enum"ORG""TMC""PARTNER_TMC""HR_FEED_CONNECTOR""TRIPS_DATA_CONNECTOR""GLOBAL"
Example: companyRole=ORG
curl -i -X GET \
  'https://apis.spotnana.com/v2/companies/4974a66b-7493-4f41-908c-58ba81093947/managers-config?companyRole=ORG' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
accountManagersArray of objects(CompanyManagerInfo)

List of detailed account manager information

customerSuccessManagersArray of objects(CompanyManagerInfo)

List of detailed customer success manager information

Response
application/json
{ "accountManagers": [ {} ], "customerSuccessManagers": [ {} ] }

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

Service Charge Plan

APIs to manage service charge plans.

Operations

Service Charge

Operations

Company Enrollment

Operations

Company Tier

Operations