Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nash Users API

User, role, and organization-membership management.

Nash Users API is one of 30 APIs that Nash publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Users. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, an AsyncAPI specification, and rate-limit docs.

This API exposes 9 operations across 5 paths, and defines 10 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 4 base URLs: https://api.sandbox.usenash.com, https://api.sandbox.ap-southeast-2.usenash.com, https://api.usenash.com, https://api.ap-southeast-2.usenash.com.

9 operations 5 paths 10 schemas 1 DELETE4 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.usenash.com/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Nash Users API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT, API Key) (Token).

Paths & Operations 9

Across 5 paths, the API surfaces 9 operations — 1 DELETE, 4 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Users 9

User, role, and organization-membership management.

GET
/v1/organization-management/roles
List Roles
users_v1_list_roles_route_roles_get → 200422
GET
/v1/organization-management/roles/{role_id}/users
List Users In Role
users_v1_list_users_in_role_route_roles__role_id__users_get 1 param → 200422
GET
/v1/organization-management/users
List Users
users_v1_list_users_route_users_get → 200422
POST
/v1/organization-management/users
Create User
users_v1_create_user_route_users_post body → 200422
POST
/v1/organization-management/users/invite
Invite Existing User Into Org
users_v1_invite_user_route_users_invite_post body → 200422
GET
/v1/organization-management/users/{user_id}/roles
List User Roles
users_v1_get_user_roles_route_users__user_id__roles_get 1 param → 200422
POST
/v1/organization-management/users/{user_id}/roles
Add User Roles
users_v1_add_user_roles_route_users__user_id__roles_post 1 param body → 200422
DELETE
/v1/organization-management/users/{user_id}/roles
Remove User Roles
users_v1_remove_user_roles_route_users__user_id__roles_delete 1 param body → 200422
PATCH
/v1/organization-management/users/{user_id}/roles
Replace User Roles
users_v1_replace_user_roles_route_users__user_id__roles_patch 1 param body → 200422

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are UserRead (9 properties), UserCreate (8 properties), RoleRead (4 properties), NashErrorDetails (3 properties). Each schema is shown below with its type and property counts.

UserRead
object
9 properties 2 required
MutationResult
object
Standard success response for role mutation endpoints.
1 property
RoleIds
object
1 property 1 required
NashErrorDetails
object
3 properties 2 required
RolesListResponse
object
1 property 1 required
UserInvite
object
2 properties 2 required
UsersListResponse
object
1 property 1 required
NashValidationError
object
3 properties 3 required
UserCreate
object
8 properties 1 required
RoleRead
object
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nash-users-api-openapi.yml Raw ↑

Other APIs Nash publishes across the network.

Nash AI Functions API
Nash Annotate API
Nash Batch Job API
Nash Contracts API
Nash Couriers API
Nash Delivery Windows API
Nash Dispatch Strategies API
Nash Feedback API
Nash Fleet API
Nash Job API
Nash Messaging API
Nash Miscellaneous API