How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Small Improvements users-resource API

Users Resource

Small Improvements users-resource API is one of 115 APIs that Small Improvements publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include users-resource. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

This API exposes 36 operations across 35 paths, and defines 15 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://app.small-improvements.com/api.

36 operations 35 paths 15 schemas 2 DELETE22 GET12 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://app.small-improvements.com/api/v2
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Small Improvements users-resource API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — Personal access token generated from user profile settings

Paths & Operations 36

Across 35 paths, the API surfaces 36 operations — 2 DELETE, 22 GET, 12 POST. Each is listed below with its method, path, parameters, and response codes.

users-resource 36

Users Resource

GET
/v2/users
listUsers
listUsersUsingGET 3 params → 200401403404
GET
/v2/users-for-company/{companyId}
listUsers
listUsersUsingGET_1 1 param → 200401403404
GET
/v2/users-for-company/{companyId}/medium
listUsersMedium
listUsersMediumUsingGET 3 params → 200401403404
GET
/v2/users-for-company/{companyId}/medium/super-users
listSuperUsersMedium
listSuperUsersMediumUsingGET_1 1 param → 200401403404
GET
/v2/users/by-ids
getUsersById
getUsersByIdUsingGET 1 param → 200401403404
GET
/v2/users/export_csv
generateCsvExport
generateCsvExportUsingGET 1 param → 200401403404
GET
/v2/users/export_excel
generateExcelExport
generateExcelExportUsingGET 1 param → 200401403404
GET
/v2/users/hrs
getHrs
getHrsUsingGET 1 param → 200401403404
POST
/v2/users/invite
inviteUsers
inviteUsersUsingPOST 1 param body → 200201401403404
POST
/v2/users/invite-onboarding/
inviteUsersInOnboarding
inviteUsersInOnboardingUsingPOST body → 200201401403404
POST
/v2/users/mail/new-reports
batchSendManagerNewReportsMails
batchSendManagerNewReportsMailsUsingPOST body → 200201401403404
POST
/v2/users/mail/password-reset
batchSendPasswordResetMails
batchSendPasswordResetMailsUsingPOST body → 200201401403404
POST
/v2/users/mail/profile-nudge
batchSendProfileNudgeMails
batchSendProfileNudgeMailsUsingPOST body → 200201401403404
POST
/v2/users/mail/welcome
batchSendWelcomeMails
batchSendWelcomeMailsUsingPOST body → 200201401403404
POST
/v2/users/mail/welcome-all
sendWelcomeMailToAll
sendWelcomeMailToAllUsingPOST → 200201401403404
GET
/v2/users/me
getCurrentUser
getCurrentUserUsingGET → 200401403404
GET
/v2/users/medium
listUsersMedium
listUsersMediumUsingGET_1 3 params → 200401403404
GET
/v2/users/medium/by-external-system-id/{externalSystemId}
getMediumUserByExternalSystemId
getMediumUserByExternalSystemIdUsingGET 1 param → 200401403404
GET
/v2/users/medium/by-id
getMediumUserById
getMediumUserByIdUsingGET 1 param → 200401403404
GET
/v2/users/medium/by-ids
getMediumUsersById
getMediumUsersByIdUsingGET 1 param → 200401403404
GET
/v2/users/medium/by-login
getMediumUserByLoginname
getMediumUserByLoginnameUsingGET 1 param → 200401403404
POST
/v2/users/medium/by-logins
getMediumUsersByLoginname
getMediumUsersByLoginnameUsingPOST body → 200201401403404
POST
/v2/users/medium/invite
inviteUsersMedium
inviteUsersMediumUsingPOST body → 200201401403404
GET
/v2/users/medium/super-users
listSuperUsersMedium
listSuperUsersMediumUsingGET → 200401403404
GET
/v2/users/relationship/{a}/{b}
getRelationship
getRelationshipUsingGET 2 params → 200401403404
GET
/v2/users/search
search
searchUsingGET 1 param → 200401403404
GET
/v2/users/search-wicket
searchForWicket
searchForWicketUsingGET 4 params → 200401403404
GET
/v2/users/{userId}
getUserById
getUserByIdUsingGET 1 param → 200401403404
DELETE
/v2/users/{userId}
delete
deleteUsingDELETE_19 1 param → 200204401403
GET
/v2/users/{userId}/badges
badges
badgesUsingGET 1 param → 200401403404
GET
/v2/users/{userId}/calendars
getByUserId
getByUserIdUsingGET 1 param → 200401403404
GET
/v2/users/{userId}/isLoggedIn
isLoggedIn
isLoggedInUsingGET 1 param → 200401403404
POST
/v2/users/{userId}/mail/password-reset
sendPasswordResetMail
sendPasswordResetMailUsingPOST 1 param → 200201401403404
POST
/v2/users/{userId}/mail/profile-nudge
sendProfileNudgeMail
sendProfileNudgeMailUsingPOST 1 param → 200201401403404
POST
/v2/users/{userId}/mail/welcome
sendWelcomeMail
sendWelcomeMailUsingPOST 1 param → 200201401403404
DELETE
/v2/users/{userId}/password
clearPassword
clearPasswordUsingDELETE 1 param → 200204401403

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. Each schema is shown below with its type and property counts.

UserRelationship
object
BadgeDTO
object
UserInvitationDTO
object
Iterable_UserProfileDto_
object
CalendarDTO
object
Iterable_MediumUser_
object
UserOnboardingInvitationDTO
object
CurrentUserDto
object
Download
object
UserSessionStatusDTO
object
Iterable_UserListDto_
object
Iterable_WicketUser_
object
UserProfileDto
object
MediumUser
object
ObserverUserDto
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

small-improvements-users-resource-api-openapi.yml Raw ↑

Other APIs Small Improvements publishes across the network.

Small Improvements action-item-resource API
Small Improvements activity-stream-resource API
Small Improvements admin-overview-link-resource API
Small Improvements anytime-feedback-default-resource API
Small Improvements anytime-feedback-export-resource API
Small Improvements anytime-feedback-resource API
Small Improvements assessment-admin-resource API
Small Improvements assessment-resource API
Small Improvements audit-record-resource API
Small Improvements automations-options-resource API
Small Improvements automations-resource API
Small Improvements automations-settings-resource API
Where this information came from

This is an independent, third-party profile of Small Improvements users-resource API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.