Rotageek User Classifications API
The UserClassifications API from Rotageek — 2 operation(s) for userclassifications.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/rotageek:rotageek-userclassifications-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Rotageek API v1 User Classifications API
description: Hello World!
contact:
name: Rotageek
email: office@rotageek.com
version: '1.0'
security:
- Bearer: []
tags:
- name: UserClassifications
paths:
/api/v1/users/{userId}/classifications:
get:
tags:
- UserClassifications
summary: Retrieves all user classifications for the specified user
description: Retrieves all user classifications for the user, ordered by effective date. Can return multiple results with different effective dates.
operationId: UserClassifications_GetUserClassifications
parameters:
- name: userId
in: path
description: Target user external id
required: true
schema:
type: string
responses:
'200':
description: List of user classification response models
content:
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/Rotageek.AspNetCore.PublicApi.Models.UserClassificationResponseModel'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Rotageek.AspNetCore.PublicApi.Models.UserClassificationResponseModel'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/Rotageek.AspNetCore.PublicApi.Models.UserClassificationResponseModel'
'400':
description: Request parameters are invalid
'404':
description: User not found
'500':
description: Internal Server Error
post:
tags:
- UserClassifications
summary: Creates a user classification by FixedId and AwardCode, or records "No…
description: 'Creates a user classification matching the specified FixedId and AwardCode. FixedId and AwardCode
must be provided together: if both are null or omitted, the created record represents "No Classification"
for the effective date; providing only one of the two returns a 400 response.'
operationId: UserClassifications_CreateUserClassification
parameters:
- name: userId
in: path
description: Target user external id
required: true
schema:
type: string
requestBody:
description: User classification request model. FixedId and AwardCode must both be set to assign a classification, or both left null to record "No Classification".
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/Rotageek.AspNetCore.PublicApi.Models.UserClassificationRequestModel'
application/json:
schema:
$ref: '#/components/schemas/Rotageek.AspNetCore.PublicApi.Models.UserClassificationRequestModel'
text/json:
schema:
$ref: '#/components/schemas/Rotageek.AspNetCore.PublicApi.Models.UserClassificationRequestModel'
application/*+json:
schema:
$ref: '#/components/schemas/Rotageek.AspNetCore.PublicApi.Models.UserClassificationRequestModel'
responses:
'200':
description: Created user classification response model
content:
text/plain:
schema:
$ref: '#/components/schemas/Rotageek.AspNetCore.PublicApi.Models.UserClassificationResponseModel'
application/json:
schema:
$ref: '#/components/schemas/Rotageek.AspNetCore.PublicApi.Models.UserClassificationResponseModel'
text/json:
schema:
$ref: '#/components/schemas/Rotageek.AspNetCore.PublicApi.Models.UserClassificationResponseModel'
'400':
description: Request parameters are invalid, including when only one of FixedId/AwardCode is provided
'404':
description: User or classification not found
'500':
description: Internal Server Error
put:
tags:
- UserClassifications
summary: Updates or creates a user classification by effective date.
description: 'Updates or creates a user classification based on the effective date. If a record with the specified effective date exists, it is updated with the new classification. If not found, a new record is created.
FixedId and AwardCode must be provided together: if both are null or omitted, the record is updated (or created) to represent
"No Classification" for the effective date; providing only one of the two returns a 400 response.'
operationId: UserClassifications_UpdateUserClassification
parameters:
- name: userId
in: path
description: Target user external id
required: true
schema:
type: string
requestBody:
description: User classification request model. EffectiveFrom is used to identify the record to update or create. FixedId and AwardCode must both be set to assign a classification, or both left null to record "No Classification".
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/Rotageek.AspNetCore.PublicApi.Models.UserClassificationRequestModel'
application/json:
schema:
$ref: '#/components/schemas/Rotageek.AspNetCore.PublicApi.Models.UserClassificationRequestModel'
text/json:
schema:
$ref: '#/components/schemas/Rotageek.AspNetCore.PublicApi.Models.UserClassificationRequestModel'
application/*+json:
schema:
$ref: '#/components/schemas/Rotageek.AspNetCore.PublicApi.Models.UserClassificationRequestModel'
responses:
'200':
description: Updated or created user classification response model
content:
text/plain:
schema:
$ref: '#/components/schemas/Rotageek.AspNetCore.PublicApi.Models.UserClassificationResponseModel'
application/json:
schema:
$ref: '#/components/schemas/Rotageek.AspNetCore.PublicApi.Models.UserClassificationResponseModel'
text/json:
schema:
$ref: '#/components/schemas/Rotageek.AspNetCore.PublicApi.Models.UserClassificationResponseModel'
'400':
description: Request parameters are invalid, including when only one of FixedId/AwardCode is provided
'404':
description: User or classification not found
'500':
description: Internal Server Error
/api/v1/users/{userId}/classifications/{effectiveFrom}:
delete:
tags:
- UserClassifications
summary: Deletes a user classification by effective date
description: Deletes a user classification that matches the specified effective date. The effective date is passed as a route parameter.
operationId: UserClassifications_DeleteUserClassification
parameters:
- name: userId
in: path
description: Target user external id
required: true
schema:
type: string
- name: effectiveFrom
in: path
description: The effective from date used to identify the classification record to delete.
required: true
schema:
type: string
format: date-time
responses:
'200':
description: Classification successfully deleted
'400':
description: Request parameters are invalid
'404':
description: User or classification not found
'500':
description: Internal Server Error
components:
schemas:
Rotageek.AspNetCore.PublicApi.Models.UserClassificationResponseModel:
type: object
properties:
fixedId:
type:
- integer
- 'null'
description: The fixed identifier of the classification.
format: int32
awardCode:
type:
- string
- 'null'
description: The award code associated with the classification.
effectiveFrom:
type: string
description: 'The effective from date for this classification.
Always populated in the response.'
format: date-time
additionalProperties: false
description: Response model for user classification information.
Rotageek.AspNetCore.PublicApi.Models.UserClassificationRequestModel:
required:
- effectiveFrom
type: object
properties:
fixedId:
type:
- integer
- 'null'
description: 'The fixed identifier of the classification. Must be supplied together with AwardCode, or left null
together with AwardCode to record "No Classification" for the effective date.'
format: int32
awardCode:
maxLength: 50
minLength: 0
type:
- string
- 'null'
description: 'The award code associated with the classification. Must be supplied together with FixedId, or left
null together with FixedId to record "No Classification" for the effective date.'
effectiveFrom:
type: string
description: 'The date from which this classification applies. Required; must be on or after the user''s
employee start date.'
format: date-time
additionalProperties: false
description: 'Request model for creating or updating a user classification by FixedId and AwardCode.
FixedId and AwardCode together identify the classification to assign and must be provided as a pair:
omitting or nulling both records "No Classification" for the effective date, while providing only
one of the two is rejected with a 400 response.'
securitySchemes:
Bearer:
type: http
description: Paste the JWT access token returned by POST /api/v1/auth. Swagger adds the 'Bearer ' prefix automatically.
scheme: bearer
bearerFormat: JWT
oauth2:
type: oauth2
description: OAuth2 Password Grant
flows:
password:
tokenUrl: /api/v1/auth
scopes: {}