--- updatedAt: 2025-09-10T20:58:39.000Z agentTools: projectIndex: https://shipcars.readme.io/llms.txt --- # My Requests Set up the welcome page for your API to help users make their first call. # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "User Management", "description": "Ship.Cars User Management", "contact": { "url": "https://ship.cars", "email": "support@ship.cars" }, "version": "1.0.0" }, "components": { "securitySchemes": { "bearerAuth": { "type": "oauth2", "flows": { "password": { "tokenUrl": "https://auth.ship.cars/auth/realms/master/protocol/openid-connect/token", "scopes": {} } } } } }, "servers": [ { "url": "https://ship.cars/api" } ], "paths": { "/usermanagement/v2/users/current": { "get": { "tags": [ "Users API" ], "summary": "Get currently logged-in user", "description": "This method returns an user based on their authentication token.", "operationId": "getCurrentUser", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "example": "U-KHDBCYFIUVCBLBVNIXDAVTS6UU" }, "keycloakId": { "type": "string", "example": "8b41402e-3258-4a27-8a86-2da15f59ba37" }, "mainUserId": { "type": "string", "description": "This is filled only for linked users", "example": "U-KHDBCYFIUVCBLBVNIXDAVTS6UU" }, "mainUserEmail": { "type": "string", "description": "This is filled only for linked users", "example": "email@email.com" }, "mainCompanyId": { "type": "string", "description": "This is filled only for linked users", "example": "C-KHDBCYFIUVCBLBVNIXDAVTS6UU" }, "name": { "pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$", "type": "string", "example": "John Smith" }, "password": { "type": "array", "writeOnly": true, "example": "password", "items": { "type": "string", "writeOnly": true, "example": "password" } }, "owner": { "type": "boolean", "example": true }, "admin": { "type": "boolean", "description": "Determines whether the account is an admin" }, "street": { "pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,200}$", "type": "string", "description": "Street", "example": "161 W Cherry St" }, "city": { "pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$", "type": "string", "description": "City", "example": "Albion" }, "state": { "pattern": "^{0}|[a-zA-Z]{2}$", "type": "string", "description": "Two-letter abbreviation of the state", "example": "IL", "enum": [ "AL", "AK", "AS", "AZ", "AR", "AA", "AE", "AP", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "GU", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "MP", "OH", "OK", "OR", "PA", "PR", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VI", "VA", "WA", "WV", "WI", "WY" ] }, "zipCode": { "pattern": "^{0}|\\d{5}(-\\d{4})?$", "type": "string", "description": "US postal code of the area or district", "example": "62806" }, "email": { "type": "string", "example": "email@email.com" }, "phoneNumber": { "pattern": "^{0}|(\\+?1[ -]?)?\\(?\\d{3}\\)?[ -]?\\d{3}[ -]?\\d{4}$", "type": "string", "description": "User account phone number.", "example": "1234567890" }, "company": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "example": "C-KHDBCYFIUVCBLBVNIXDAVTS6UU" }, "active": { "type": "boolean", "description": "Whether the company is active or not", "example": true }, "name": { "pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$", "type": "string", "example": "Tycoon LLC" }, "companyType": { "type": "string", "example": "SHIPPER", "enum": [ "SHIPPER", "CARRIER", "API_INTEGRATOR" ] }, "companySubtype": { "type": "string", "example": "BROKER", "enum": [ "DEALER", "AUCTION", "BROKER", "CARRIER", "PRIVATE" ] }, "usDotNumber": { "pattern": "^{0}|[1-9]\\d{0,49}$", "type": "string", "description": "US DOT", "example": "1234567" }, "mcNumber": { "pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,50}$", "type": "string", "description": "Transportation MC number", "example": "62806" }, "street": { "pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,200}$", "type": "string", "description": "Street", "example": "161 W Cherry St" }, "city": { "pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$", "type": "string", "description": "City", "example": "Albion" }, "state": { "pattern": "^{0}|[a-zA-Z]{2}$", "type": "string", "description": "Two-letter abbreviation of the state", "example": "IL", "enum": [ "AL", "AK", "AS", "AZ", "AR", "AA", "AE", "AP", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "GU", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "MP", "OH", "OK", "OR", "PA", "PR", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VI", "VA", "WA", "WV", "WI", "WY" ] }, "zipCode": { "pattern": "^{0}|\\d{5}(-\\d{4})?$", "type": "string", "description": "US postal code of the area or district", "example": "62806" }, "email": { "type": "string", "example": "email@email.com" }, "accountingEmail": { "type": "string", "example": "email@email.com" }, "phoneNumber": { "pattern": "^{0}|(\\+?1[ -]?)?\\(?\\d{3}\\)?[ -]?\\d{3}[ -]?\\d{4}$", "type": "string", "description": "Company phone number.", "example": "1234567890" }, "termsAndConditions": { "type": "string", "description": "Terms and Conditions", "example": "We do prefer..." }, "allowInstantBooking": { "type": "boolean", "example": true }, "centralDispatchId": { "pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,50}$", "type": "string", "description": "Central dispatch ID", "example": "CD62806" }, "logoUrl": { "type": "string", "description": "URL of the logo", "example": "https://image.com/logo.jpg" }, "ownerName": { "type": "string", "example": "John Smith" }, "ownerId": { "type": "string", "example": "U-DTCN6AO45FG4DJZZRPCDVPROBY" }, "useGpsTracking": { "type": "boolean", "description": "GPS Tracking toggle", "example": true }, "paymentDetails": { "type": "object", "properties": { "subscriptionName": { "type": "string", "example": "LoadMate" }, "subscriptionStatus": { "type": "string", "example": "ACTIVE", "enum": [ "CANCELED", "ACTIVE", "TRIALING", "PAST_DUE", "INCOMPLETE", "INCOMPLETE_EXPIRED" ] }, "addons": { "type": "array", "example": "AIDamageInspection, LogyText", "items": { "type": "string", "example": "AIDamageInspection, LogyText" } }, "subscriptionPrice": { "type": "integer", "format": "int64", "example": 9000 }, "subscriptionCurrency": { "type": "string", "example": "usd" }, "nextPaymentDueTo": { "type": "string", "format": "date-time" }, "trialExpiryDate": { "type": "string", "description": "Trial expiration date.", "format": "date-time", "example": "2022-05-26T08:49:50Z" }, "paymentMethodProvided": { "type": "boolean", "description": "Describes whether a payment method is provided", "example": true }, "lastPaymentResult": { "type": "string", "example": "SUCCESS", "enum": [ "SUCCESS", "FAIL" ] }, "subscriptionQuantity": { "type": "integer", "description": "Describes accumulated quantity", "format": "int64", "example": 13 }, "currentPeriodStart": { "type": "string", "description": "Beginning of current billing period date.", "format": "date-time", "example": "2022-05-26T08:49:50Z" }, "currentPeriodEnd": { "type": "string", "description": "End of current billing period date.", "format": "date-time", "example": "2022-05-26T08:49:50Z" }, "hasUnpaidInvoices": { "type": "boolean", "description": "Indicates if the customer has any pending invoices" }, "cancelAtPeriodEnd": { "type": "boolean", "description": "Indicates if the current plan will cancel at the end of the period" }, "currentTier": { "type": "object", "properties": { "name": { "type": "string", "example": "Tier II" }, "upTo": { "type": "integer", "description": "Up to which quantity is this tier", "format": "int64", "example": 50 }, "flatAmount": { "type": "integer", "description": "Flat amount in cents", "format": "int64", "example": 13000 }, "unitAmount": { "type": "integer", "description": "Unit amount in cents", "format": "int64", "example": 1300 } } }, "nextTier": { "type": "object", "properties": { "name": { "type": "string", "example": "Tier II" }, "upTo": { "type": "integer", "description": "Up to which quantity is this tier", "format": "int64", "example": 50 }, "flatAmount": { "type": "integer", "description": "Flat amount in cents", "format": "int64", "example": 13000 }, "unitAmount": { "type": "integer", "description": "Unit amount in cents", "format": "int64", "example": 1300 } } } } }, "singleOwnerOperator": { "type": "boolean", "example": true }, "createdAt": { "type": "string", "description": "Created at", "format": "date-time", "example": "2023-05-09T08:45:00Z" }, "lastModified": { "type": "string", "description": "Last modified", "format": "date-time", "example": "2023-05-09T10:12:00Z" }, "parentCompanyId": { "type": "string", "example": "C-KHDBCYFIUVCBLBVNIXDAVTS6UU" } } }, "profilePictureUrl": { "type": "string", "example": "https://image.com/picture.jpg" }, "active": { "type": "boolean", "example": true }, "roles": { "type": "array", "example": "Driver", "items": { "type": "string", "example": "Driver", "enum": [ "ACCOUNTANT", "DISPATCHER", "DRIVER", "SUPERVISOR" ] } }, "primaryRole": { "type": "string", "enum": [ "ACCOUNTANT", "DISPATCHER", "DRIVER", "SUPERVISOR" ] }, "createdAt": { "type": "string", "description": "Created at", "format": "date-time", "example": "2023-05-09T08:45:00Z" }, "lastModified": { "type": "string", "description": "Last modified", "format": "date-time", "example": "2023-05-09T10:12:00Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time" }, "httpStatus": { "type": "integer", "format": "int32" }, "errorCode": { "type": "integer", "format": "int32" }, "errorMessage": { "type": "string" }, "errorDetails": { "type": "array", "items": { "type": "string" } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time" }, "httpStatus": { "type": "integer", "format": "int32" }, "errorCode": { "type": "integer", "format": "int32" }, "errorMessage": { "type": "string" }, "errorDetails": { "type": "array", "items": { "type": "string" } } } } } } } }, "security": [ { "bearerAuth": [] } ] } } }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true } } ```