Skip to content
API reference
/
Company
/
/
Get grade

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

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

Create grade

Request

This endpoint creates a grade.

Security
Bearer
Path
companyIdstring(uuid)required

Identifier for company.

Example: 4974a66b-7493-4f41-908c-58ba81093947
Bodyapplication/jsonrequired
namestringrequired

Name of the grade

Example: "Senior Engineer"
curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/companies/4974a66b-7493-4f41-908c-58ba81093947/grades \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Senior Engineer"
  }'

Responses

OK

Bodyapplication/json
idstring(uuid)required
Example: "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3"
Response
application/json
{
  "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3"
}

Get grade

Request

This endpoint gets a grade by ID.

Security
Bearer
Path
companyIdstring(uuid)required

Identifier for company.

Example: 4974a66b-7493-4f41-908c-58ba81093947
gradeIdstring(uuid)required

Identifier for grade.

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

Responses

OK

Bodyapplication/json
idstring(uuid)required
Example: "831ccbcb-1416-7fe2-e236-d324dfbe7424"
namestringrequired

Name of the grade

Example: "Grade"
Response
application/json
{
  "id": "831ccbcb-1416-7fe2-e236-d324dfbe7424",
  "name": "Grade"
}

Update grade

Request

This endpoint updates grade by ID.

Security
Bearer
Path
companyIdstring(uuid)required

Identifier for company.

Example: 4974a66b-7493-4f41-908c-58ba81093947
gradeIdstring(uuid)required

Identifier for grade.

Example: 4974a66b-7493-4f41-908c-58ba81093947
Bodyapplication/jsonrequired
namestringrequired

Name of the grade

Example: "Grade"
curl -i -X PUT \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/companies/4974a66b-7493-4f41-908c-58ba81093947/grades/4974a66b-7493-4f41-908c-58ba81093947 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Grade"
  }'

Responses

Updated Successfully

Response
No content

Delete grade

Request

This endpoint deletes grade by ID.

Security
Bearer
Path
companyIdstring(uuid)required

Identifier for company.

Example: 4974a66b-7493-4f41-908c-58ba81093947
gradeIdstring(uuid)required

Identifier for grade.

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

Responses

Deleted Successfully

Response
No content

List grades

Request

This endpoint lists grades of a company.

Security
Bearer
Path
companyIdstring(uuid)required

Identifier for company.

Example: 4974a66b-7493-4f41-908c-58ba81093947
Bodyapplication/jsonrequired
searchTextstring

Search string entered by the user

Example: "Senior Engineer"
paginationParamsobject(OffsetBasedPaginationRequestParams)required

Pagination information.

paginationParams.​offsetinteger(int32)>= 0

The starting index in the list from which results are returned. The value must be greater than or equal to 0.

Default 0
paginationParams.​limitinteger(int32)>= 1

Maximum number of results to be fetched.

Default 100
filtersArray of objects(ListGradesFilter)

List of filters. Grades matching with any filter would be returned.

curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/companies/4974a66b-7493-4f41-908c-58ba81093947/grades/list \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "searchText": "Senior Engineer",
    "paginationParams": {
      "offset": 0,
      "limit": 100
    },
    "filters": [
      {
        "gradeIds": [
          "831ccbcb-1416-7fe2-e236-d324dfbe7424"
        ]
      }
    ]
  }'

Responses

OK

Bodyapplication/json
paginationParamsobject(OffsetBasedPaginationResponseParams)required

Pagination information.

paginationParams.​totalNumResultsinteger(int32)required

Total number of results.

gradesArray of objects(GradeInfo)

List of grades containing id and name.

Response
application/json
{
  "paginationParams": {
    "totalNumResults": 0
  },
  "grades": [
    { … }
  ]
}

Service Charge Plan

APIs to manage service charge plans.

Operations

Partner Public Keys

APIs to manage partner public keys for token exchange authentication.

Operations

Service Charge

Operations

Company Enrollment

Operations

Company Tier

Operations

Stealth Config

Operations
Copyright © 2026 Spotnana Technology, Inc.