Qargo API / Company API

The API / Company API from Qargo — 6 operation(s) for api / company.

Documentation Provider Profile APIs.io OpenAPI GitHub

Qargo API / Company API is one of 26 APIs that Qargo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include API / Company. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 14 operations across 6 paths, and defines 42 schemas. It is described by OpenAPI 3.1.0, at version 1.2.0.

Requests are made against a single base URL, https://api.qargo.com.

14 operations 6 paths 42 schemas 2 DELETE6 GET1 PATCH3 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.1.0

API Version

1.2.0

Base URL

https://api.qargo.com

Authentication

OAuth 2.0, HTTP Basic

Resource Areas

Authentication & Security 2

Qargo API / Company API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (oAuth2ClientCredentials) using the clientCredentials flow. It accepts HTTP basic authentication (BasicAuthWebhookCredentials).

Paths & Operations 14

Across 6 paths, the API surfaces 14 operations — 2 DELETE, 6 GET, 1 PATCH, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

API / Company 14

GET

/v1/companies/company

List Companies

list_companies_v1_companies_company_get 2 params → 200400401403422429500503

POST

/v1/companies/company

Create Company

create_company_v1_companies_company_post body → 200400401403422429500503

GET

/v1/companies/company/{company_id}/documents

Get Company Documents

get_company_documents_v1_companies_company__company_id__documents_get 2 params → 200400401403422429500503

POST

/v1/companies/company/{company_id}/documents

Create Company Document

create_company_document_v1_companies_company__company_id__documents_post 1 param body → 200400401403422429500503

GET

/v1/companies/company/{company_id}/validity

List Company Validities

List_company_validities_v1_companies_company__company_id__validity_get 4 params → 200400401403422429500503

POST

/v1/companies/company/{company_id}/validity

Create Company Validity Request

Create_company_validity_request_v1_companies_company__company_id__validity_post 1 param body → 200400401403422429500503

GET

/v1/companies/company/{company_id}/validity/{id}

Get Company Validity

Get_company_validity_v1_companies_company__company_id__validity__id__get 2 params → 200400401403422429500503

PUT

/v1/companies/company/{company_id}/validity/{id}

Update Company Validity

Update_company_validity_v1_companies_company__company_id__validity__id__put 2 params body → 200400401403422429500503

DELETE

/v1/companies/company/{company_id}/validity/{id}

Delete Company Validity

Delete_company_validity_v1_companies_company__company_id__validity__id__delete 2 params → 204400401403422429500503

GET

/v1/companies/company/{company_id}/validity/{id}/documents

Get Company Validity Documents

Get_company_validity_documents_v1_companies_company__company_id__validity__id__documents_get 2 params → 200400401403422429500503

GET

/v1/companies/company/{id}

Get Company

get_company_v1_companies_company__id__get 1 param → 200400401403422429500503

PUT

/v1/companies/company/{id}

Update Company

update_company_v1_companies_company__id__put 1 param body → 200400401403422429500503

PATCH

/v1/companies/company/{id}

Update Company

update_company_v1_companies_company__id__patch 1 param body → 200400401403422429500503

DELETE

/v1/companies/company/{id}

Archive Company

Archive_company_v1_companies_company__id__delete 1 param → 204400401403422429500503

Schemas 42

The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are CompanyDetailOutput (30 properties), CompanyPartialInput (27 properties), CompanyInput (27 properties), LocationOutput (13 properties). Each schema is shown below with its type and property counts.

SubcontractorValidityReason

string

SubcontractorDocumentWithValidityTypeInput

string

CompanyContactInput

object

7 properties

CompanyPartialInput

object

27 properties

Document

object

6 properties 4 required

ListCompanyValidityOutput

object

2 properties 1 required

CustomerStatus

string

ValidationErrorDetail

object

4 properties 1 required

CompanyInput

object

27 properties 1 required

TaxTypeEnum

string

CreditPolicyInput

object

1 property

PurchaseCompanyFields-Input

object

3 properties

BasePaymentTerm

object

1 property 1 required

SubcontractorDocumentWithoutValidityTypeInput

string

ValidationErrorResponse

object

2 properties 2 required

LocationOutput

object

13 properties

SalesCompanyFields-Input

object

3 properties

CompanyDetailOutput

object

30 properties 8 required

SalesCompanyFields-Output

object

3 properties

CompanyBillingEntity

object

3 properties

UploadedCompanyDocumentWithValidity

object

4 properties 3 required

CompanyValidityOutput

object

8 properties 3 required

SubcontractorStatus

string

CompanyContactOutput

object

6 properties

api__accounting__models__company__CompanyReferenceOutput

object

3 properties 2 required

CompanyDocumentOutput

object

7 properties 4 required

ListCompanyDocumentOutput

object

2 properties 1 required

CompanyValidityInput

object

8 properties 2 required

BillingLocation

object

10 properties

CustomerDocumentTypeInput

string

ValidationError

object

3 properties 3 required

CompanyReferenceNumbers

object

5 properties

UploadedDocumentBase_Union_SubcontractorDocumentWithValidityTypeInput__SubcontractorInsuranceDocumentTypeInput__

object

3 properties 3 required

ContactType

string

ListCompanyOutput

object

2 properties 1 required

HTTPValidationError

object

1 property

SubcontractorInsuranceDocumentTypeInput

string

CompanyValidity

object

7 properties 2 required

PaymentTermCode

string

BankAccount

object

2 properties

CreditPolicyOutput

object

1 property

PurchaseCompanyFields-Output

object

3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Qargo publishes across the network.

Qargo Subcontractor API

AE Profile APIs.io

Qargo Customer API

AE Profile APIs.io

Qargo API / Accounting API

AE Profile APIs.io

Qargo API / Authentication API

AE Profile APIs.io

Qargo API / Document API

AE Profile APIs.io

Qargo API / Order API

AE Profile APIs.io

Qargo API / Resource API

AE Profile APIs.io

Qargo API / Task API

AE Profile APIs.io

Qargo API / Trip API

AE Profile APIs.io

Qargo System API

AE Profile APIs.io

Qargo Use case / Accounting API

AE Profile APIs.io

Qargo Use case / Customer portal API

AE Profile APIs.io

#API / Company

← Back to Q APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Qargo API / Company API

Metadata

Authentication & Security 2

Paths & Operations 14

Schemas 42

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Qargo API / Company API

Metadata

Authentication & Security 2

Paths & Operations 14

Schemas 42

Specification

Source

More from Qargo 12

API Details

Provider

Explore more