1. Companies
  • Introduction
  • Getting Started
  • Authentication
  • Error Handling
  • Contact Support
  • Modaltrans API
    • Get Auth Token
      • Get Bearer Token
    • Accounting
      • Invoices
        • Retrieve an Invoice
        • List all Invoices
    • Customs
      • NCTS Declarations
        • List all NCTS Declarations
        • Retrieve an NCTS Declaration
        • Create an NCTS Declaration with XML Data
        • Create an Ens Declaration from JSON
        • Update an NCTS Declaration
        • Download an NCTS Declaration
        • List Timelines of NCTS Declaration
        • List Messages of NCTS Decalaration
      • Customs Declarations
        • List all Customs Declarations
        • Retrieve a Custom Declaration
        • Create a Customs Declaration
        • Update a Custom Declaration
        • Delete a Custom Declaration
        • Retrieve a Declaration History
        • Retrieve an MRN Status of Declaration
      • Declaration Requests
        • List all Declaration Orders
        • Retrieve a Declaration Request
        • Create a Declaration Request
        • Update a Declaration Request
        • Delete a Declaration Request
    • Logistics
      • Bookings
        • Retrieve a Booking
        • List all Bookings
        • Create a Booking
        • Update a Booking
      • Locations
        • List all Locations
        • Retrieve a Location
      • Positions
        • Update a Transport
      • Tracking
        • Available Shipping Lines
        • Retrieve a Tracking Data
        • Subscribe to Tracking
      • Shipments
        • Retrieve a Shipment
        • List All Shipments
        • Retrieve Financials of Shipment
        • List Contacts of the Shipment
        • Create a Shipment
        • Update a Shipment
    • Depot
      • Orders
        • Retrieve an Order
        • List all Orders
        • Create an Order
        • Update an Order
      • Products
        • Retrieve a Product
        • List all Products
        • Create a Product
        • Update a Product
        • List Product Stocks
      • Inventories
        • List all Inventories
    • Fleet Management
      • Drivers
        • Retrieve a Driver
        • Retrieve a Driver's Vehicle
        • List Driver Positions
        • Update a Driver
      • Vehicles
        • Retrieve a Vehicle
        • Update a Vehicle
      • Gps Service Controller
        • Create Gps Responses
      • Service Logs
        • List all Service Logs
        • Retrieve a Service Log
        • Create a Service Log
        • Delete a Service Log
        • Update a Service Log
      • Periodic Documents
        • Retrieve a Periodic Document
        • Update a Periodic Document
        • Create a Periodic Document
    • CRM
      • Companies
        • List all Companies
          GET
        • Retrieve a Company
          GET
        • Create a Company
          POST
        • Update a Company
          PATCH
        • Delete a Company
          DELETE
    • Timelines
      • Retrieve a Timeline
      • List Timelines
      • Create a Timeline
    • S3 Files
      • List all S3Files
      • Create an S3File
      • Delete an S3File
    • Notifications
      • List all Notifications
      • Update a Notification Status
    • User Details
      • List User Details
      • Update User Details
  1. Companies

List all Companies

Developing
Testing Env
https://demo.modaltrans.com
Testing Env
https://demo.modaltrans.com
GET
/api/v1/companies
Returns a list of all Companies.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params
page
number 
optional
Page number of list. (The result is limited to 50 Companies per page.)
Example:
1

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://demo.modaltrans.com/api/v1/companies?page=1'

Responses

🟢200OK
application/json
Body
array of:
uuid
string 
required
UUID of the company
name
string 
required
Name of the company
title
string 
required
Title of the company
company_type
string 
required
Type of the company
tel
string 
required
Telephone number of the company
fax
string 
required
Fax number of the company
gsm
string 
required
GSM number of the company
voip
string 
required
VOIP number of the company
email
string 
required
Email address of the company
website
string 
required
Website of the company
sector
string 
required
Sector in which the company operates
postcode
string 
required
Postal code of the company's address
address
string 
required
Address of the company
district
string 
required
District where the company is located
city_name
string 
required
City where the company is located
state
string 
required
State where the company is located
country_id
string 
required
Country ID for the company's location
status
string 
required
Status of the company
gmaps
boolean 
required
Indicates if the company is listed on Google Maps
notes
string 
required
Additional notes about the company
company_no
string 
required
Company No
eori_code
string 
required
EORI No of the company
taxno
string 
required
Tax No of the company
taxoffice
string 
required
Tax office of the company
last_lead_date
string <date>
required
Date of the last quote
last_invoice_date
string <date>
required
Date of the last invoice
company_group
string 
required
Company Group
has_export
boolean 
required
Indicates if the company has export operations
export_countries
array[string]
required
Countries to which the company exports
export_notes
string 
required
Notes about the company's export operations
has_import
boolean 
required
Indicates if the company has import operations
import_countries
string 
required
Countries from which the company imports
import_notes
string 
required
Notes about the company's import operations
has_warehouse
boolean 
required
Indicates if the company has a warehouse
has_depot
boolean 
required
Indicates if the company has a depot
twitter
string 
required
Twitter handle of the company
facebook
string 
required
Facebook page of the company
linkedin
string 
required
LinkedIn profile of the company
business_type
string 
required
Company Sector
has_domestic
boolean 
required
Indicates if the company has domestic operations
due_dets
string 
required
Due details of company.
curr
string 
required
Currency used by the company
due_days
integer 
required
Payment Term of the company
payment_notes
string 
required
Notes about payments
credit_limit
number 
required
Company Limit
financial_status
string 
required
Financial status of the company
financial_notes
string 
required
Notes about the financial status
invoice_type
string 
required
Type of invoice
financial_email
string 
required
Financial email address
curr_type
string 
required
Type of currency used
debt_email
boolean 
required
Debt email status
remind_payment
string 
required
Debt notifications detail
information_email
string 
required
Information email address of the company
invoice_notes
string 
required
Invoice notes of the company
credit_limit_curr
string 
required
Currency of the company limit
iata_code
string 
required
Carrier code of the company
duns_code
string 
required
DUNS number of the company
edi_code
string 
required
EDI code of the company
company_balance
array [object {6}] 
required
Balance details of the company
id
integer 
required
ID of the company balance record
debit
number 
required
Debit amount
credit
number 
required
Credit amount
curr
string 
required
Currency of the balance
debit_local
number 
required
Debit amount in local currency
credit_local
number 
required
Credit amount in local currency
Example
[
    {
        "uuid": "string",
        "name": "string",
        "title": "string",
        "company_type": "string",
        "tel": "string",
        "fax": "string",
        "gsm": "string",
        "voip": "string",
        "email": "string",
        "website": "string",
        "sector": "string",
        "postcode": "string",
        "address": "string",
        "district": "string",
        "city_name": "string",
        "state": "string",
        "country_id": "string",
        "status": "string",
        "gmaps": true,
        "notes": "string",
        "company_no": "string",
        "eori_code": "string",
        "taxno": "string",
        "taxoffice": "string",
        "last_lead_date": "2019-08-24",
        "last_invoice_date": "2019-08-24",
        "company_group": "string",
        "has_export": true,
        "export_countries": [
            "[\"\", \"AT\", \"BE\", \"CH\", \"CZ\", \"DE\", \"FR\", \"IT\"]"
        ],
        "export_notes": "string",
        "has_import": true,
        "import_countries": "string",
        "import_notes": "string",
        "has_warehouse": true,
        "has_depot": true,
        "twitter": "string",
        "facebook": "string",
        "linkedin": "string",
        "business_type": "string",
        "has_domestic": true,
        "due_dets": "string",
        "curr": "string",
        "due_days": 0,
        "payment_notes": "string",
        "credit_limit": 0,
        "financial_status": "string",
        "financial_notes": "string",
        "invoice_type": "string",
        "financial_email": "string",
        "curr_type": "string",
        "debt_email": true,
        "remind_payment": "string",
        "information_email": "string",
        "invoice_notes": "string",
        "credit_limit_curr": "string",
        "iata_code": "string",
        "duns_code": "string",
        "edi_code": "string",
        "company_balance": [
            {
                "id": 0,
                "debit": 0,
                "credit": 0,
                "curr": "string",
                "debit_local": 0,
                "credit_local": 0
            }
        ]
    }
]
🟠400Bad Request
🟠403Forbidden
🟠404Record Not Found
Modified at 2024-08-26 09:14:03
Previous
Create a Periodic Document
Next
Retrieve a Company
Built with