Conductores de la organización

GET

/api/v1/drivers

const url = 'https://notiauto.co/api/v1/drivers?per_page=20';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://notiauto.co/api/v1/drivers?per_page=20' \
  --header 'X-API-Key: <X-API-Key>'

Requiere el scope drivers.read. Los elementos vienen en data.data.

Authorizations

ApiKey

Parameters

Query Parameters

per_page

integer

default: 20

Responses

200

Listado paginado, con licencias por conductor

application/json

object

success

boolean

data

object

data

Array<object>

object

integer

name

string

document

string

type_document

string

estado_conductor

string

has_active_license

boolean

licenses

Array<object>

object

active_infractions

integer

total_infractions

integer

meta

PaginationMeta

object

current_page

Top-level OpenAPI document: info, servers, the API-key scheme, shared schemas and the endpoints that live in routes/api.php as closures rather than on a controller.

Everything here describes what the code actually returns, including the paginator-inside-data shape of the list endpoints — that is the published contract and consumers depend on it.

integer

total

integer

per_page

integer

last_page

integer

Example

{
  "success": true,
  "data": {
    "data": [
      {
        "id": 7,
        "name": "ANA GOMEZ",
        "document": "12345678",
        "type_document": "C",
        "estado_conductor": "ACTIVO",
        "has_active_license": true,
        "active_infractions": 0,
        "total_infractions": 2
      }
    ]
  },
  "meta": {
    "current_page": 1,
    "total": 42,
    "per_page": 20,
    "last_page": 3
  }
}

403

La key no tiene el scope drivers.read

application/json

Error

object

success

boolean

message

string

Example

{
  "success": false,
  "message": "API key inválida o expirada."
}