List - Truckers

GET 
/api/trucker

List trucker users associated with your company.

Request

Query Parameters

page string

Listing page.

limit string

Number of data per page.

Header Parameters

apikey stringrequired

Apikey of a company linked to a user

Responses

200

Example response

application/json

Schema

Schema

status integer
data object
docs object[]
Array [
_id string
position object
Array of services and their last known position
deliveries object[]
role string
Account role ("driver", "dev", "manager" or "admin")
status boolean
Account status (Locked or active in boolean).
reason string
Account blocking reason.
emailVerified boolean
Boolean that indicates whether the email is verified.
phone string
Trucker's phone.
country string
Country of residence of the trucker.
timezone string
Trucker time zone.
image string
Trucker image.
recovery_token string
Password recovery token.
i18n string
Language of the trucker user.
deleted boolean
Boolean indicating whether the user has been deleted.
name string
Name of the trucker.
lastname string
Truck driver's last name.
email string
Trucker email (Must be unique)
taxid string
Truck's identity document (Must be unique).
password string
Hashed password of the trucker account.
]
totalDocs integer
limit integer
totalPages integer
page integer
pagingCounter integer
hasPrevPage boolean
hasNextPage boolean
prevPage integer
nextPage integer

Example (from schema)

{
  "status": 0,
  "data": {
    "docs": [
      {
        "_id": "65e1fc46a39d32135b12c7e0",
        "position": {
          "deliveries": []
        },
        "role": "driver",
        "status": true,
        "reason": "NONE",
        "emailVerified": false,
        "phone": "34668936908",
        "country": "esp",
        "timezone": "europe/madrid",
        "image": "",
        "recovery_token": "XXX",
        "i18n": "es",
        "deleted": false,
        "name": "Name",
        "lastname": "Lastname",
        "email": "email@example.com",
        "taxid": "12345678A",
        "password": "XXX"
      }
    ],
    "totalDocs": 0,
    "limit": 0,
    "totalPages": 0,
    "page": 0,
    "pagingCounter": 0,
    "hasPrevPage": true,
    "hasNextPage": true,
    "prevPage": 0,
    "nextPage": 0
  }
}

Example 1

{
  "status": 0,
  "data": {
    "docs": [
      {
        "_id": "65e1fc46a39d32135b12c7e0",
        "position": {
          "deliveries": []
        },
        "role": "driver",
        "status": true,
        "reason": "NONE",
        "emailVerified": false,
        "phone": "34668936908",
        "country": "esp",
        "timezone": "europe/madrid",
        "image": "",
        "recovery_token": "XXX",
        "i18n": "es",
        "deleted": false,
        "name": "Name",
        "lastname": "Lastname",
        "email": "email@example.com",
        "taxid": "12345678A",
        "password": "XXX"
      }
    ],
    "totalDocs": 0,
    "limit": 0,
    "totalPages": 0,
    "page": 2,
    "pagingCounter": 0,
    "hasPrevPage": true,
    "hasNextPage": true,
    "prevPage": 1,
    "nextPage": 3
  }
}

Loading...