Help Center
Go to Roolz appsupport@roolz.net
English
English
  • 馃憢Welcome
  • Getting Started
    • 馃挕What is Roolz?
    • 馃挵Plans and subscriptions
      • Can Roolz be used for free?
      • How to buy a subscription?
      • How to unsubscribe?
      • How to change a subscription plan?
      • How are subscription fees calculated?
      • What does it mean to say 芦the total company limit is formed from the sum of the limits per user禄?
      • What are credits and how to buy them?
  • 馃専How we are different?
  • 馃幆Our values
  • Registration and Login
    • PC registration
    • Mobile registration
    • Registration via the invitation link
    • Login
    • How to change login method
  • User profile
    • What is a user profile?
      • Which optional info can you add in your profile?
      • How to change user profile information?
  • Contacts and people search
    • My contacts
    • People search
  • Companies
    • Company creation
      • How to add/change details about your company profile?
    • Company profile
      • Completed company profile
      • Can we make a private company public?
      • Private and public profiles: what's the difference?
    • Inviting colleagues and the roles
  • Switching company spaces
  • Company verification
  • Working in the company space
  • Company directory
    • All you need to know
      • The information displayed in the profile
      • Criteria for searching companies in the directory
      • How to promote your company in the directory
  • EXCHANGE AND OFFERS: FREIGHT AND TRANSPORT MARKET
    • Public vs private exchange: the difference
  • Vehicle search
  • Freight search
  • Automatic matching of freight and transport offers
  • Freight offers
    • Bidding modes for freight offers
  • Vehicle offers
  • Offers: editing, activity and statuses
    • How to create offer templates?
    • How to delete or edit an offer?
    • How to publish an offer as an individual if I have a company?
    • How to respond to an offer?
    • How to receive notifications about responses to my offer?
    • What are the offer statuses?
  • Offers: managing and exporting to EXCEL, CSV, JSON
  • Private exchange: partnerships
  • Private exchange: sending offers
  • BIDS
    • Placing bids
  • "Bargain" bidding mode
  • "Auction" bidding mode
  • Bid's privacy
  • MESSENGER
    • Full guide
      • Chat types and what you can do with them
      • How do I know if someone read my message?
      • Blocking users and blacklist
  • READY INTEGRATIONS
    • 馃SpotGo
  • OPEN API
    • Introduction
    • Offers
    • Company
    • System
    • Field values
      • Company
        • Role in logistics | exchange_role
        • Number of shipments per month | order_amount
        • Types of cargo and packaging | cargo_type
        • Company types | company_form
        • Customs services | customs_service
        • Number of employees | employee_amount
        • Fleet size | fleet_amount
        • Logistics services | logistics_service
        • Types of transportation | transportation_type
        • Associations | associations
      • Offers
        • Types of cargo and packaging | cargo_types
        • Shipping modes | shipping_modes
        • Vehicle categories | transport_types
        • Truck body types | truck_bodies
        • Options and truck body features | extra_equipment
        • Loading/unloading methods | loading_types
        • Waypoint types | point_types
        • Payment terms | payment_cond
        • Payment methods | payment_methods
        • Reasons for removing offer from publication | publ_autocancel_reasons
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. OPEN API

Company

PreviousOffersNextSystem

Last updated 28 days ago

Was this helpful?

Getting your company profile

get
Authorizations
Header parameters
Content-Typestring 路 enumRequiredDefault: application/jsonPossible values:
Accept-Encodingstring 路 enumRequiredDefault: gzipPossible values:
Responses
200
Successful execution of the request
application/json
400
Error in input data
application/json
401
Request not authorized. API key may be missing.
403
This operation is not permitted.
get
GET /public-api/v1/company HTTP/1.1
Host: api.test.roolz.tech
Content-Type: application/json
Accept-Encoding: gzip
Accept: */*
{
  "company": {
    "id": "text",
    "owner_id": "text",
    "name": "text",
    "nickname": "text",
    "company_form": "private_company",
    "exchange_role": "shipper",
    "is_public": true,
    "is_verified": true,
    "offers_count": 1,
    "total_offers_count": 1,
    "employee_amount": "1_15",
    "order_amount": 0,
    "fleet_amount": "1_5",
    "foundation_year": 1,
    "registration_date": "Y-m-d",
    "registration_number": "text",
    "legal_form": "text",
    "legal_form_short": "text",
    "legal_name": "text",
    "transport_license_number": "text",
    "forwarder_license_number": "text",
    "legal_address": "text",
    "mail_address": "text",
    "tax_number": "text",
    "momo": "text",
    "email": "name@gmail.com",
    "phone": "text",
    "website": "text",
    "description": "text",
    "registration_country_alpha2": "text",
    "is_transport_license": true,
    "is_forwarder_license": true,
    "is_transport_license_company": true,
    "is_forwarder_license_company": true,
    "goal": [
      "find_cargo"
    ],
    "associations": [
      "us_tia"
    ],
    "international_direction": [
      "text"
    ],
    "national_direction": [
      "text"
    ],
    "transportation_type": [
      "road"
    ],
    "cargo_type": [
      "general"
    ],
    "logistics_service": [
      "transportation"
    ],
    "customs_service": [
      "declaration"
    ],
    "created_at": "Y-m-dTHH:mm:ss.SSSZ",
    "updated_at": "Y-m-dTHH:mm:ss.SSSZ"
  }
}

Getting a list of the users of your company

get
Authorizations
Query parameters
limitinteger 路 min: 1 路 max: 50Optional

Limit on the number of users listed per pagination iteration

Default: 25
offsetintegerOptional

Offset of the paginated users selection relative to the previous selection

Default: 0
Header parameters
Content-Typestring 路 enumRequiredDefault: application/jsonPossible values:
Accept-Encodingstring 路 enumRequiredDefault: gzipPossible values:
Responses
200
Successful execution of the request
application/json
400
Error in input data
application/json
401
Request not authorized. API key may be missing.
403
This operation is not permitted.
get
GET /public-api/v1/company/users HTTP/1.1
Host: api.test.roolz.tech
Content-Type: application/json
Accept-Encoding: gzip
Accept: */*
{
  "total": 1,
  "count": 1,
  "users": []
}
  • GETGetting your company profile
  • GETGetting a list of the users of your company