This endpoint enables the retrieval of an authentication token and a redirection link for accessing the CargoMART portal.

get/users

Request

  • Base URL
    https://api.cargoai.co/solutions
  • URL
    https://api.cargoai.co/solutions/users
  • Auth
    API key in header x-api-key

Query parameters

emailstring required

user's registered email

Headers

x-api-keystring required

Response

200

status'Activated' | 'Manual activation' | 'Pending validation' | 'Pending company validation'

account status of the user. Omitted when the status is not one of the listed values.

messagestring

result of the request

tokenstring

authentication token for the CargoMART portal

linkstring

redirection link to the CargoMART portal, including the token

Changes