Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Qargo TMS System API
description: For support, please contact integrations@qargo.com.
version: 1.2.0
servers:
- url: https://api.qargo.com
tags:
- name: System
description: ''
paths:
/me:
get:
tags:
- System
summary: Who Am I
operationId: who_am_i_me_get
security:
- oAuth2ClientCredentials: []
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
title: Response Who Am I Me Get
'400':
description: Bad Request — invalid input or malformed request
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationErrorResponse'
'401':
description: Unauthorized — missing or invalid authentication credentials
'403':
description: Forbidden — insufficient permissions for this operation
'429':
description: Too Many Requests — rate limit exceeded. See the `Retry-After` header
'500':
description: Internal Server Error
'503':
description: Service Unavailable — temporarily unable to handle the request
components:
schemas:
ValidationErrorResponse:
properties:
message:
description: Human-readable summary of the validation failure
title: Message
type: string
errors:
description: One entry per validation failure. Always present and non-empty — a single failure yields a one-item array, so integrators can handle one and many the same way.
items:
$ref: '#/components/schemas/ValidationErrorDetail'
minItems: 1
title: Errors
type: array
required:
- message
- errors
title: ValidationErrorResponse
type: object
ValidationErrorDetail:
properties:
message:
description: Human-readable summary of this validation failure
title: Message
type: string
field:
anyOf:
- type: string
- type: 'null'
default: null
description: Name of the field that failed validation, if known
title: Field
path:
anyOf:
- type: string
- type: 'null'
default: null
description: JSON path to the field within the request payload (e.g. '$.consignor.address.country')
title: Path
detail:
anyOf:
- type: string
- type: object
- type: 'null'
default: null
description: Additional structured context about the failure, if provided by the backend
title: Detail
required:
- message
title: ValidationErrorDetail
type: object
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
scopes: {}
tokenUrl: /v1/auth/token
BasicAuthWebhookCredentials:
type: http
scheme: basic
x-tagGroups:
- name: Use cases
tags:
- Use case / Accounting
- Use case / Customer portal
- Use case / Document import
- Use case / E-invoicing
- Use case / Fleet dispatch
- Use case / Intermodal [partner]
- Use case / Location booking
- Use case / Master data sync
- Use case / Order
- Use case / Subcontractor dispatch
- Use case / Tracking
- Use case / Trip import
- Use case / Visibility
- name: API
tags:
- API / Accounting
- API / Authentication
- API / Company
- API / Document
- API / Order
- API / Resource
- API / Task
- API / Trip
- name: System
tags:
- System
- name: Webhooks
tags:
- Webhooks / Inbound
- Webhooks / Outbound
- name: ''
tags: []