# Company

## GET /company

> Getting your company profile

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"servers":[{"url":"https://api.test.roolz.tech/public-api/v1","description":"Test environment for development"}],"security":[{"getKey":[]},{"headerKey":[]}],"components":{"securitySchemes":{"getKey":{"type":"apiKey","description":"API key for authorizing requests in GET parameters","name":"apikey","in":"query"},"headerKey":{"type":"apiKey","description":"API key for authorizing requests in header","name":"X-Api-Key","in":"header"}},"parameters":{"ContentTypeHeader":{"in":"header","name":"Content-Type","required":true,"description":"","schema":{"type":"string","default":"application/json","enum":["application/json"]}},"AcceptEncodingHeader":{"in":"header","name":"Accept-Encoding","required":true,"description":"","schema":{"type":"string","default":"gzip","enum":["gzip"]}}},"schemas":{"Company":{"required":["id","owner_id","name","nickname","company_form","exchange_role","is_public","is_verified","offers_count","total_offers_count","employee_amount","order_amount","fleet_amount","foundation_year","registration_date","registration_number","legal_form","legal_form_short","legal_name","transport_license_number","forwarder_license_number","legal_address","mail_address","tax_number","momo","email","phone","website","description","registration_country_alpha2","is_transport_license","is_forwarder_license","is_transport_license_company","is_forwarder_license_company","goal","associations","international_direction","national_direction","transportation_type","cargo_type","logistics_service","customs_service","created_at","updated_at"],"properties":{"id":{"type":"string","format":"UUID","description":"Internal company ID on Roolz exchange"},"owner_id":{"type":"string","format":"UUID","description":"User ID of the company owner on Roolz exchange"},"name":{"type":"string","description":"Public name of the company on Roolz exchange"},"nickname":{"type":"string","description":"Unique nickname of the company on Roolz exchange"},"company_form":{"type":"string","description":"Legal form of organization","enum":["private_company","self_employed","partnership","public_company","government_agency","non_profit"]},"exchange_role":{"type":"string","description":"Company role on Roolz exchange","enum":["shipper","carrier","forwarder","forwarder_carrier","dispatcher","freight_broker","customs_agent","storage_provider","shipper_carrier","other"]},"is_public":{"type":"boolean","description":"This company is available for public viewing and search"},"is_verified":{"type":"boolean","description":"This company has been checked and verified on Roolz exchange"},"offers_count":{"type":"integer","description":"Number of active (published) offers"},"total_offers_count":{"type":"integer","description":"Total number of offers created on Roolz exchange since the registration"},"employee_amount":{"type":"string","description":"Average number of employees in the company","enum":["1_15","16_50","51_150","151_500","501_1500","1501_5000","5000_more"]},"order_amount":{"type":"string","description":"Number of shipments per month","enum":[0,"1_30","31_100","101_500","501_2000","2001_10000","10001_50000","50000_more"]},"fleet_amount":{"type":"string","description":"Size of the company's fleet (number of units)","nullable":true,"enum":["1_5","6_15","16_50","51_100","101_500","501_1000","1000_more"]},"foundation_year":{"type":"integer","description":"Year when the company was founded"},"registration_date":{"type":"string","description":"Date of registration of the company by the authorized body","nullable":true},"registration_number":{"type":"string","description":"Company registration number, assigned upon registration with the authorized body of the country"},"legal_form":{"type":"string","description":"Full legal form (company type)"},"legal_form_short":{"type":"string","description":"Abbreviated organizational and legal form (company type: LLC, Inc., etc.)"},"legal_name":{"type":"string","description":"Full legal name of the company with the registration form"},"transport_license_number":{"type":"string","description":"Transport license number","nullable":true},"forwarder_license_number":{"type":"string","description":"Freight forwarder license number","nullable":true},"legal_address":{"type":"string","description":"Legal address of the company"},"mail_address":{"type":"string","description":"Company mailing address"},"tax_number":{"type":"string","description":"Tax number or company ID"},"momo":{"type":"string","description":"A short slogan or motto for the company"},"email":{"type":"string","format":"email","description":"Company email address"},"phone":{"type":"string","description":"Company phone number"},"website":{"type":"string","description":"Company website"},"description":{"type":"string","description":"Company description"},"registration_country_alpha2":{"type":"string","description":"Alpha2 country code of company registration"},"is_transport_license":{"type":"boolean","description":"Availability of a transport license"},"is_forwarder_license":{"type":"boolean","description":"Availability of a carrier license"},"is_transport_license_company":{"type":"boolean","description":"Transport license is issued to this legal entity"},"is_forwarder_license_company":{"type":"boolean","description":"Carrier's license is issued to this legal entity"},"goal":{"type":"array","minItems":0,"description":"","items":{"type":"string","enum":["find_cargo","find_transport","private_exchange","api_integration","visibility","communication","crm","tms","fms","offer_service","other"]}},"associations":{"type":"array","minItems":0,"description":"List of associations the company is a member of","items":{"type":"string","enum":["us_tia","us_ooida","us_ata","tw_iofflat","cn_crta","cn_cifa","tw_tafla","tw_tfla","jp_jiffa","jp_jafa","jp_jfff","mx_amacarga","id_ilfa","th_tiffa","br_actc","ru_asmap","ru_far","fr_aftri","fr_tlf","in_ficci","in_acaai","in_fffai","es_astic","es_feteia","it_uicciaa","it_fdespedi","tr_tobb","tr_und","tr_utikad","gb_logistics_uk","gb_bifa","gb_rha","kr_kiffa","au_afif","au_cbfca","pl_zmpd","pl_piffa","de_bgl","de_dslv","de_aist","ar_aaaci","za_saaff","sy_snc_icc","sy_siffa","co_fitac","sa_sata","sa_nlc","ua_asmap_ua","ua_aiffu","ua_ukrzovnihtrans","ir_iccima","ir_itca","eg_eiffa","cl_alog_chile","ec_aseaci","pt_antram","pt_apat","my_fmff","gt_agac","ca_ciffa","gr_ofae","gr_iffag_l","nl_fenex","ma_amtri","ma_affm","ro_untrr","ro_user","be_febetra","be_forward_belgium","do_adacam","lk_slffa","cz_cesmad_boemia","cz_ssl","nz_cbaff","se_sa","se_sifa","no_nlf","no_nho_lt","kz_kazato","kz_kffa","ke_kifwa","hu_mkfe","hu_ahf","pk_pnc_icc","pk_piffa","bg_aebtri","bg_nsbs","by_bamap","by_baif","ph_pmtlai","tn_ccit","at_zv","at_aiso","kg_airto_kr","dk_dsf","dk_dtl","ch_spedlogswiss","ch_asag","af_acci","ni_anac","il_irtb","il_iffcca","sk_cesmad_slovakia","sk_zlz_sr","ug_uffa","ie_irha","ie_iifa","gh_giff","qa_qcci","kw_kiac","py_atolpar","bd_baffa","cr_acacia","om_sinyar","rs_ccis_at","md_aem_trans","md_aita","sg_saaa__singapore","sg_sla","az_abada","vn_va","hr_cce","hr_hgk","sv_asac","ge_girca","ge_afg","pa_apac","ae_atcuae","tz_taffa","tz_zfb","ae_nafl","hk_haffa","jo_racj","jo_jla","hn_ahaci","uy_audaca","zm_zcfaa","lb_cciabml","lb_lfs","zw_sfaaz","lt_linava","lt_lineka","ee_eraa","ee_elfa","cy_tda","cy_ccfaa","si_giz_itt","s_ccis","fi_skal","fi_shll","lv_latvijas_auto","lv_laff","cm_synautratra","ba_airh","ba_vtk_stk_bih","al_analtir","et_effsaa","mt_atto","mt_malta_chamber","mu_apt","mk_amerit","bn_brufa","uz_aircuz","kh_camffa","am_airca","am_aaff","mn_nartam","dj_atd","tj_abbat","mm_miffa","tm_hada","uz_uifa","me_pkcg","mn_fmff"]}},"international_direction":{"type":"array","minItems":0,"description":"Alpha2 codes of countries to/from which the company carries out international transportation","items":{"type":"string"}},"national_direction":{"type":"array","minItems":0,"description":"Alpha2 codes of countries to/from which the company carries out domestic transportation","items":{"type":"string"}},"transportation_type":{"type":"array","minItems":0,"description":"Types of transportation available","items":{"type":"string","enum":["road","ocean","air","railway","multimodal"]}},"cargo_type":{"type":"array","minItems":0,"description":"Types of cargo transported","items":{"type":"string","enum":["general","groupage","cep","last_mile","adr","oversize","project","temperature","perishable","bulk","liquid","container","passenger","animals","other_special"]}},"logistics_service":{"type":"array","minItems":0,"description":"Provided logistics services","items":{"type":"string","enum":["transportation","forwarding","dispatching","freight_brokerage","inventory_mngmt","order_mngmt","responsible_storage","storage_rent","transport_rent","cargo_consolidation","cross_docking","loader_work","cargo_insurance","transport_insurance","return_mngmt"]}},"customs_service":{"type":"array","minItems":0,"description":"Additional provided services","items":{"type":"string","enum":["declaration","statistical_declaration","document_handling","representation","consulting","customs_guarantee","temporary_storage"]}},"created_at":{"type":"string","description":"Date and time of the company profile creation (in UTC)"},"updated_at":{"type":"string","description":"Date and time of the last modification of the company profile (in UTC)"}}},"ErrorObject":{"required":["state","message","internal"],"properties":{"state":{"type":"string","description":"Request execution status","enum":["error"]},"message":{"type":"string","description":"Additional information"},"validations":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"path":{"type":"string"},"reason":{"type":"string"}}}},"internal":{"type":"object","description":"Internal information from Roolz exchange platform to analyze the problem when executing a request","required":["roolz_debug_id"],"properties":{"roolz_debug_id":{"type":"string"}}}}}}},"paths":{"/company":{"get":{"tags":["companies"],"operationId":"getMyCompanyProfile","summary":"Getting your company profile","parameters":[{"$ref":"#/components/parameters/ContentTypeHeader"},{"$ref":"#/components/parameters/AcceptEncodingHeader"}],"responses":{"200":{"description":"Successful execution of the request","content":{"application/json":{"schema":{"type":"object","required":["company"],"properties":{"company":{"$ref":"#/components/schemas/Company"}}}}}},"400":{"description":"Error in input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorObject"}}}},"401":{"description":"Request not authorized. API key may be missing."},"403":{"description":"This operation is not permitted."}}}}}}
```

## GET /company/users

> Getting a list of the users of your company

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"servers":[{"url":"https://api.test.roolz.tech/public-api/v1","description":"Test environment for development"}],"security":[{"getKey":[]},{"headerKey":[]}],"components":{"securitySchemes":{"getKey":{"type":"apiKey","description":"API key for authorizing requests in GET parameters","name":"apikey","in":"query"},"headerKey":{"type":"apiKey","description":"API key for authorizing requests in header","name":"X-Api-Key","in":"header"}},"parameters":{"ContentTypeHeader":{"in":"header","name":"Content-Type","required":true,"description":"","schema":{"type":"string","default":"application/json","enum":["application/json"]}},"AcceptEncodingHeader":{"in":"header","name":"Accept-Encoding","required":true,"description":"","schema":{"type":"string","default":"gzip","enum":["gzip"]}}},"schemas":{"User":{"required":["id","phone","email","nickname","first_name","last_name","middle_name","work_email","work_phone","own_email","own_phone","site"],"properties":{"id":{"type":"string","format":"UUID","description":"Internal user ID on Roolz exchange"},"phone":{"type":"string","description":"User's phone number specified during registration and/or used to log into the account","nullable":true},"email":{"type":"string","description":"User's email specified during registration and/or used to log into the account","nullable":true},"nickname":{"type":"string","description":"Unique username of the user on Roolz exchange"},"first_name":{"type":"string","description":"First name of the user"},"last_name":{"type":"string","description":"Last name of the user"},"middle_name":{"type":"string","description":"Middle name of the user","nullable":true},"work_email":{"type":"string","description":"Work email address","nullable":true},"work_phone":{"type":"string","description":"Work phone number","nullable":true},"own_email":{"type":"string","description":"Personal email address","nullable":true},"own_phone":{"type":"string","description":"Personal phone number","nullable":true},"site":{"type":"string","description":"Website","nullable":true}}},"ErrorObject":{"required":["state","message","internal"],"properties":{"state":{"type":"string","description":"Request execution status","enum":["error"]},"message":{"type":"string","description":"Additional information"},"validations":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"path":{"type":"string"},"reason":{"type":"string"}}}},"internal":{"type":"object","description":"Internal information from Roolz exchange platform to analyze the problem when executing a request","required":["roolz_debug_id"],"properties":{"roolz_debug_id":{"type":"string"}}}}}}},"paths":{"/company/users":{"get":{"tags":["companies"],"operationId":"getMyCompanyUsers","summary":"Getting a list of the users of your company","parameters":[{"$ref":"#/components/parameters/ContentTypeHeader"},{"$ref":"#/components/parameters/AcceptEncodingHeader"},{"name":"limit","in":"query","required":false,"description":"Limit on the number of users listed per pagination iteration","schema":{"type":"integer","minimum":1,"maximum":50,"default":25}},{"name":"offset","in":"query","required":false,"description":"Offset of the paginated users selection relative to the previous selection","schema":{"type":"integer","minimum":0,"default":0}}],"responses":{"200":{"description":"Successful execution of the request","content":{"application/json":{"schema":{"type":"object","required":["total","count","users"],"properties":{"total":{"type":"integer","description":"Total number of users listed"},"count":{"type":"integer","description":"Number of users listed in this pagination iteration"},"users":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}}}}},"400":{"description":"Error in input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorObject"}}}},"401":{"description":"Request not authorized. API key may be missing."},"403":{"description":"This operation is not permitted."}}}}}}
```

## The Company object

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"components":{"schemas":{"Company":{"required":["id","owner_id","name","nickname","company_form","exchange_role","is_public","is_verified","offers_count","total_offers_count","employee_amount","order_amount","fleet_amount","foundation_year","registration_date","registration_number","legal_form","legal_form_short","legal_name","transport_license_number","forwarder_license_number","legal_address","mail_address","tax_number","momo","email","phone","website","description","registration_country_alpha2","is_transport_license","is_forwarder_license","is_transport_license_company","is_forwarder_license_company","goal","associations","international_direction","national_direction","transportation_type","cargo_type","logistics_service","customs_service","created_at","updated_at"],"properties":{"id":{"type":"string","format":"UUID","description":"Internal company ID on Roolz exchange"},"owner_id":{"type":"string","format":"UUID","description":"User ID of the company owner on Roolz exchange"},"name":{"type":"string","description":"Public name of the company on Roolz exchange"},"nickname":{"type":"string","description":"Unique nickname of the company on Roolz exchange"},"company_form":{"type":"string","description":"Legal form of organization","enum":["private_company","self_employed","partnership","public_company","government_agency","non_profit"]},"exchange_role":{"type":"string","description":"Company role on Roolz exchange","enum":["shipper","carrier","forwarder","forwarder_carrier","dispatcher","freight_broker","customs_agent","storage_provider","shipper_carrier","other"]},"is_public":{"type":"boolean","description":"This company is available for public viewing and search"},"is_verified":{"type":"boolean","description":"This company has been checked and verified on Roolz exchange"},"offers_count":{"type":"integer","description":"Number of active (published) offers"},"total_offers_count":{"type":"integer","description":"Total number of offers created on Roolz exchange since the registration"},"employee_amount":{"type":"string","description":"Average number of employees in the company","enum":["1_15","16_50","51_150","151_500","501_1500","1501_5000","5000_more"]},"order_amount":{"type":"string","description":"Number of shipments per month","enum":[0,"1_30","31_100","101_500","501_2000","2001_10000","10001_50000","50000_more"]},"fleet_amount":{"type":"string","description":"Size of the company's fleet (number of units)","nullable":true,"enum":["1_5","6_15","16_50","51_100","101_500","501_1000","1000_more"]},"foundation_year":{"type":"integer","description":"Year when the company was founded"},"registration_date":{"type":"string","description":"Date of registration of the company by the authorized body","nullable":true},"registration_number":{"type":"string","description":"Company registration number, assigned upon registration with the authorized body of the country"},"legal_form":{"type":"string","description":"Full legal form (company type)"},"legal_form_short":{"type":"string","description":"Abbreviated organizational and legal form (company type: LLC, Inc., etc.)"},"legal_name":{"type":"string","description":"Full legal name of the company with the registration form"},"transport_license_number":{"type":"string","description":"Transport license number","nullable":true},"forwarder_license_number":{"type":"string","description":"Freight forwarder license number","nullable":true},"legal_address":{"type":"string","description":"Legal address of the company"},"mail_address":{"type":"string","description":"Company mailing address"},"tax_number":{"type":"string","description":"Tax number or company ID"},"momo":{"type":"string","description":"A short slogan or motto for the company"},"email":{"type":"string","format":"email","description":"Company email address"},"phone":{"type":"string","description":"Company phone number"},"website":{"type":"string","description":"Company website"},"description":{"type":"string","description":"Company description"},"registration_country_alpha2":{"type":"string","description":"Alpha2 country code of company registration"},"is_transport_license":{"type":"boolean","description":"Availability of a transport license"},"is_forwarder_license":{"type":"boolean","description":"Availability of a carrier license"},"is_transport_license_company":{"type":"boolean","description":"Transport license is issued to this legal entity"},"is_forwarder_license_company":{"type":"boolean","description":"Carrier's license is issued to this legal entity"},"goal":{"type":"array","minItems":0,"description":"","items":{"type":"string","enum":["find_cargo","find_transport","private_exchange","api_integration","visibility","communication","crm","tms","fms","offer_service","other"]}},"associations":{"type":"array","minItems":0,"description":"List of associations the company is a member of","items":{"type":"string","enum":["us_tia","us_ooida","us_ata","tw_iofflat","cn_crta","cn_cifa","tw_tafla","tw_tfla","jp_jiffa","jp_jafa","jp_jfff","mx_amacarga","id_ilfa","th_tiffa","br_actc","ru_asmap","ru_far","fr_aftri","fr_tlf","in_ficci","in_acaai","in_fffai","es_astic","es_feteia","it_uicciaa","it_fdespedi","tr_tobb","tr_und","tr_utikad","gb_logistics_uk","gb_bifa","gb_rha","kr_kiffa","au_afif","au_cbfca","pl_zmpd","pl_piffa","de_bgl","de_dslv","de_aist","ar_aaaci","za_saaff","sy_snc_icc","sy_siffa","co_fitac","sa_sata","sa_nlc","ua_asmap_ua","ua_aiffu","ua_ukrzovnihtrans","ir_iccima","ir_itca","eg_eiffa","cl_alog_chile","ec_aseaci","pt_antram","pt_apat","my_fmff","gt_agac","ca_ciffa","gr_ofae","gr_iffag_l","nl_fenex","ma_amtri","ma_affm","ro_untrr","ro_user","be_febetra","be_forward_belgium","do_adacam","lk_slffa","cz_cesmad_boemia","cz_ssl","nz_cbaff","se_sa","se_sifa","no_nlf","no_nho_lt","kz_kazato","kz_kffa","ke_kifwa","hu_mkfe","hu_ahf","pk_pnc_icc","pk_piffa","bg_aebtri","bg_nsbs","by_bamap","by_baif","ph_pmtlai","tn_ccit","at_zv","at_aiso","kg_airto_kr","dk_dsf","dk_dtl","ch_spedlogswiss","ch_asag","af_acci","ni_anac","il_irtb","il_iffcca","sk_cesmad_slovakia","sk_zlz_sr","ug_uffa","ie_irha","ie_iifa","gh_giff","qa_qcci","kw_kiac","py_atolpar","bd_baffa","cr_acacia","om_sinyar","rs_ccis_at","md_aem_trans","md_aita","sg_saaa__singapore","sg_sla","az_abada","vn_va","hr_cce","hr_hgk","sv_asac","ge_girca","ge_afg","pa_apac","ae_atcuae","tz_taffa","tz_zfb","ae_nafl","hk_haffa","jo_racj","jo_jla","hn_ahaci","uy_audaca","zm_zcfaa","lb_cciabml","lb_lfs","zw_sfaaz","lt_linava","lt_lineka","ee_eraa","ee_elfa","cy_tda","cy_ccfaa","si_giz_itt","s_ccis","fi_skal","fi_shll","lv_latvijas_auto","lv_laff","cm_synautratra","ba_airh","ba_vtk_stk_bih","al_analtir","et_effsaa","mt_atto","mt_malta_chamber","mu_apt","mk_amerit","bn_brufa","uz_aircuz","kh_camffa","am_airca","am_aaff","mn_nartam","dj_atd","tj_abbat","mm_miffa","tm_hada","uz_uifa","me_pkcg","mn_fmff"]}},"international_direction":{"type":"array","minItems":0,"description":"Alpha2 codes of countries to/from which the company carries out international transportation","items":{"type":"string"}},"national_direction":{"type":"array","minItems":0,"description":"Alpha2 codes of countries to/from which the company carries out domestic transportation","items":{"type":"string"}},"transportation_type":{"type":"array","minItems":0,"description":"Types of transportation available","items":{"type":"string","enum":["road","ocean","air","railway","multimodal"]}},"cargo_type":{"type":"array","minItems":0,"description":"Types of cargo transported","items":{"type":"string","enum":["general","groupage","cep","last_mile","adr","oversize","project","temperature","perishable","bulk","liquid","container","passenger","animals","other_special"]}},"logistics_service":{"type":"array","minItems":0,"description":"Provided logistics services","items":{"type":"string","enum":["transportation","forwarding","dispatching","freight_brokerage","inventory_mngmt","order_mngmt","responsible_storage","storage_rent","transport_rent","cargo_consolidation","cross_docking","loader_work","cargo_insurance","transport_insurance","return_mngmt"]}},"customs_service":{"type":"array","minItems":0,"description":"Additional provided services","items":{"type":"string","enum":["declaration","statistical_declaration","document_handling","representation","consulting","customs_guarantee","temporary_storage"]}},"created_at":{"type":"string","description":"Date and time of the company profile creation (in UTC)"},"updated_at":{"type":"string","description":"Date and time of the last modification of the company profile (in UTC)"}}}}}}
```

## The User object

```json
{"openapi":"3.0.1","info":{"title":"Roolz Public API","version":"1.1"},"components":{"schemas":{"User":{"required":["id","phone","email","nickname","first_name","last_name","middle_name","work_email","work_phone","own_email","own_phone","site"],"properties":{"id":{"type":"string","format":"UUID","description":"Internal user ID on Roolz exchange"},"phone":{"type":"string","description":"User's phone number specified during registration and/or used to log into the account","nullable":true},"email":{"type":"string","description":"User's email specified during registration and/or used to log into the account","nullable":true},"nickname":{"type":"string","description":"Unique username of the user on Roolz exchange"},"first_name":{"type":"string","description":"First name of the user"},"last_name":{"type":"string","description":"Last name of the user"},"middle_name":{"type":"string","description":"Middle name of the user","nullable":true},"work_email":{"type":"string","description":"Work email address","nullable":true},"work_phone":{"type":"string","description":"Work phone number","nullable":true},"own_email":{"type":"string","description":"Personal email address","nullable":true},"own_phone":{"type":"string","description":"Personal phone number","nullable":true},"site":{"type":"string","description":"Website","nullable":true}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.roolz.net/en/open-api/company.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.