Get Onboarded Carriers

This endpoint allows external systems to retrieve onboarded carrier contacts configured for the authenticated customer.

Authentication

• Include your Access-Token in the header of your requests.

• Include your x-api-key The API key provided by GenLogs. This header must be included in the request.

Permissions

The external-api-get-onboarded-carrier-contact permission is required to access this endpoint.

Endpoint

• URL: https://api.genlogs.io/onboarded-carrier/contacts

• Method: GET

Headers

• Access-Token: (string, required): Access token obtained from the "Create Access Token" endpoint.

• x-api-key (string, required): The API key provided by GenLogs.

Request Body:

• usdot_number (string, optional): Carrier USDOT number or numbers comma separated. Must be a non-empty value.

• page (string, optional): Expected page to be listed.

• page_size (string, optional): Amount of items per page

Request Example:

curl --location 'https://api.genlogs.io/onboarded-carrier/contacts?page=4&page_size=2' \
--header 'access-token: <your-access-token>' \
--header 'x-api-key: <your-x-api-key>'

Response:

• 200 OK: A JSON object containing the information of carrier contacts.

• 400 Bad Request: If the provided parameters are malformed or invalid.

• 401 Unauthorized: If the authentication credentials (Access-Token) is missing or incorrect.

• 403 Forbidden: If the permission has not been added to your user.

• 500 Internal Server Error: If there is an issue on the server that prevents processing the request.

Response Body:

200 OK – Contacts listed Successfully

{
  "contacts": [
    {
      "contact_id": "00-11-22-33-44",
      "dot_number": "123456",
      "customer_id": 3,
      "contact_name": "John",
      "contact_email": "[email protected]",
      "contact_phone": "[phone]",
      "contact_source": "GENLOGS"
    },
    {
      "contact_id": "11-22-33-44-55",
      "dot_number": "765432",
      "customer_id": 3,
      "contact_name": "Mike",
      "contact_email": "[email protected]",
      "contact_phone": "[phone]",
      "contact_source": "GENLOGS"
    }
  ],
  "pagination": {
    "page_size": 2,
    "current_page": 4,
    "total_pages": 10
  }
}

400 Bad RequestReturned when:

• usdot_number is invalid, empty or equal to zero

• page value is out of bounds or not a valid integer

• page_size value is out of bounds or not a valid integer

{
    "detail": "usdot_number cannot be empty"
}

{
    "detail": "page 2 is out of range. Maximum page is 1"
}

403 Forbidden

{
  "detail": "User not allowed to access this endpoint"
}

Retrieve onboarded carrier contacts

get

Returns a paginated list of onboarded carrier contacts for the authenticated customer. Only contacts belonging to the customer identified in the JWT are returned. Requires the external-api-get-onboarded-carrier-contact permission.

Authorizations

Access-Token & X-Api-Key

Access-TokenstringRequired

JWT provided directly in the Access-Token header.

x-api-keystringRequired

API key provided by GenLogs.

Query parameters

pageinteger · min: 1Optional

Page number of results to return.

Default: 1Example: 1

page_sizeinteger · min: 1 · max: 200Optional

Number of results per page (max 200).

Default: 50Example: 50

usdot_numberstringOptional

USDOT number(s) to filter by. Supports a single value or a comma-separated list.

Example: 942132,635760

Responses

200

Onboarded carrier contacts retrieved successfully.

application/json

400

Bad Request – Invalid query parameters.

application/json

401

Unauthorized – Invalid or missing authentication headers.

application/json

403

Forbidden – User does not have required permission.

application/json

500

Internal Server Error.

application/json

get

/onboarded-carrier/contacts

HTTPcURLJavaScriptPython

GET /onboarded-carrier/contacts HTTP/1.1
Host: api.genlogs.io
Access-Token: YOUR_API_KEY
x-api-key: YOUR_API_KEY
Accept: */*

{
  "contacts": [
    {
      "contact_id": "00-00-00-00-00",
      "dot_number": "942132",
      "customer_id": 3,
      "contact_name": "John Doe",
      "contact_email": "[email protected]",
      "contact_phone": "[phone]",
      "contact_source": "GENLOGS"
    }
  ],
  "pagination": {
    "page_size": 20,
    "current_page": 1,
    "total_pages": 5
  }
}