Overview
The EPISHIP Users API provides comprehensive management of user identities within your organization. You can develop applications that automate user registration, manage secure password updates, retrieve detailed user profiles, and handle account lifecycle events like soft-deletion and restoration.
View Doc →
The following figure shows the relationship between your EPISHIP app, the EPISHIP API, and User services.
Figure 1. EPISHIP API relationship diagram. User registration, authentication, and profile management flow.
EPISHIP App
EPISHIP’s user management interface allows administrators to control access to the platform. It serves as the central hub for inviting new team members, assigning roles (e.g., admin, shipper), and monitoring account status across the organization.
EPISHIP API
The REST API that handles all user-related operations. It supports retrieving the currently authenticated user’s details, listing all users within a company, and performing administrative tasks such as manual email verification and CSRF token refreshing.
Authentication
Secured via Bearer tokens in the Authorization header. The API also includes endpoints for refreshing CSRF tokens, ensuring secure session management for browser-based integrations alongside standard API token usage.
Lifecycle Management
A flexible system for handling user accounts. The API supports “soft-deletes,” allowing users to be deactivated without permanent data loss, and includes a dedicated restore endpoint to reactivate accounts if needed.
What can users do with the EPISHIP Users API?
Users can use the EPISHIP Users API to perform common workflows, such as:
- Retrieve details of the currently logged-in user or specific team members
- Register new user accounts associated with a specific Company ID
- Update user profiles, roles, and passwords securely
- Soft-delete and restore user accounts to manage access
- Validate user data fields before submission to prevent errors
User properties available to view and filter through the EPISHIP Users API:
- User ID
- First and Last Name
- Email Address
- Role (e.g., admin)
- Company ID
- Account Status (Active/Inactive)