Company

Getting your company profile

get

Authorizations

apikeystringRequired

API key for authorizing requests in GET parameters

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/company

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": "[e-mail]",
    "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

apikeystringRequired

API key for authorizing requests in GET parameters

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

totalintegerRequired

Total number of users listed

countintegerRequired

Number of users listed in this pagination iteration

400

Error in input data

application/json

401

Request not authorized. API key may be missing.

403

This operation is not permitted.

get/company/users

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": []
}