{"openapi":"3.1.0","info":{"title":"Getlogiq API","version":"v1","description":"Versioned partner API for shipments, webhooks, billing, audit and connector integrations. Authenticate with a tenant API key in the x-aether-api-key header. Documentation: /api-docs. All customer operations require an authorized tenant key."},"servers":[{"url":"https://get-logiq.com/api/v1"}],"paths":{"/shipments":{"get":{"summary":"List shipments","operationId":"get_shipments","description":"List shipments. Requires the tenant permissions documented by the API; no customer access is granted by this schema.","responses":{"200":{"description":"Successful operation; the response shape depends on the endpoint."},"401":{"description":"Authentication required or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"The key lacks access to this operation or tenant.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"The tenant request quota or rate limit was exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"post":{"summary":"Create shipment","operationId":"post_shipments","description":"Create shipment. Requires the tenant permissions documented by the API; no customer access is granted by this schema.","responses":{"200":{"description":"Successful operation; the response shape depends on the endpoint."},"401":{"description":"Authentication required or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"The key lacks access to this operation or tenant.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"The tenant request quota or rate limit was exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/shipments/{ref}":{"get":{"summary":"Retrieve one shipment by reference","operationId":"get_shipments_ref","description":"Retrieve one shipment by reference. Requires the tenant permissions documented by the API; no customer access is granted by this schema.","parameters":[{"name":"ref","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation; the response shape depends on the endpoint."},"401":{"description":"Authentication required or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"The key lacks access to this operation or tenant.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"The tenant request quota or rate limit was exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/webhooks":{"get":{"summary":"List webhooks","operationId":"get_webhooks","description":"List webhooks. Requires the tenant permissions documented by the API; no customer access is granted by this schema.","responses":{"200":{"description":"Successful operation; the response shape depends on the endpoint."},"401":{"description":"Authentication required or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"The key lacks access to this operation or tenant.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"The tenant request quota or rate limit was exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"post":{"summary":"Register webhook","operationId":"post_webhooks","description":"Register webhook. Requires the tenant permissions documented by the API; no customer access is granted by this schema.","responses":{"200":{"description":"Successful operation; the response shape depends on the endpoint."},"401":{"description":"Authentication required or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"The key lacks access to this operation or tenant.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"The tenant request quota or rate limit was exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/webhooks/{id}":{"patch":{"summary":"Update a webhook subscription","operationId":"patch_webhooks_id","description":"Update a webhook subscription. Requires the tenant permissions documented by the API; no customer access is granted by this schema.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation; the response shape depends on the endpoint."},"401":{"description":"Authentication required or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"The key lacks access to this operation or tenant.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"The tenant request quota or rate limit was exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"delete":{"summary":"Remove a webhook subscription","operationId":"delete_webhooks_id","description":"Remove a webhook subscription. Requires the tenant permissions documented by the API; no customer access is granted by this schema.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation; the response shape depends on the endpoint."},"401":{"description":"Authentication required or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"The key lacks access to this operation or tenant.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"The tenant request quota or rate limit was exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/webhooks/{id}/replay":{"post":{"summary":"Replay a delivered webhook event","operationId":"post_webhooks_id_replay","description":"Replay a delivered webhook event. Requires the tenant permissions documented by the API; no customer access is granted by this schema.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation; the response shape depends on the endpoint."},"401":{"description":"Authentication required or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"The key lacks access to this operation or tenant.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"The tenant request quota or rate limit was exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/webhooks/{id}/reenable":{"post":{"summary":"Re-enable a webhook disabled by repeated failure","operationId":"post_webhooks_id_reenable","description":"Re-enable a webhook disabled by repeated failure. Requires the tenant permissions documented by the API; no customer access is granted by this schema.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation; the response shape depends on the endpoint."},"401":{"description":"Authentication required or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"The key lacks access to this operation or tenant.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"The tenant request quota or rate limit was exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/webhooks/{id}/dead-letter":{"get":{"summary":"Dead-lettered deliveries for one webhook","operationId":"get_webhooks_id_dead_letter","description":"Dead-lettered deliveries for one webhook. Requires the tenant permissions documented by the API; no customer access is granted by this schema.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation; the response shape depends on the endpoint."},"401":{"description":"Authentication required or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"The key lacks access to this operation or tenant.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"The tenant request quota or rate limit was exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/webhooks/dead-letter":{"get":{"summary":"Dead-lettered deliveries across all webhooks","operationId":"get_webhooks_dead_letter","description":"Dead-lettered deliveries across all webhooks. Requires the tenant permissions documented by the API; no customer access is granted by this schema.","responses":{"200":{"description":"Successful operation; the response shape depends on the endpoint."},"401":{"description":"Authentication required or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"The key lacks access to this operation or tenant.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"The tenant request quota or rate limit was exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/webhooks/dead-letter/queue":{"get":{"summary":"Dead-letter queue depth and oldest entry","operationId":"get_webhooks_dead_letter_queue","description":"Dead-letter queue depth and oldest entry. Requires the tenant permissions documented by the API; no customer access is granted by this schema.","responses":{"200":{"description":"Successful operation; the response shape depends on the endpoint."},"401":{"description":"Authentication required or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"The key lacks access to this operation or tenant.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"The tenant request quota or rate limit was exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/tenants/me":{"get":{"summary":"Authenticated tenant profile, usage and tier limits","operationId":"get_tenants_me","description":"Authenticated tenant profile, usage and tier limits. Requires the tenant permissions documented by the API; no customer access is granted by this schema.","responses":{"200":{"description":"Successful operation; the response shape depends on the endpoint."},"401":{"description":"Authentication required or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"The key lacks access to this operation or tenant.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"The tenant request quota or rate limit was exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/tenants/api-keys":{"get":{"summary":"List API keys","operationId":"get_tenants_api_keys","description":"List API keys. Requires the tenant permissions documented by the API; no customer access is granted by this schema.","responses":{"200":{"description":"Successful operation; the response shape depends on the endpoint."},"401":{"description":"Authentication required or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"The key lacks access to this operation or tenant.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"The tenant request quota or rate limit was exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"post":{"summary":"Rotate API key","operationId":"post_tenants_api_keys","description":"Rotate API key. Requires the tenant permissions documented by the API; no customer access is granted by this schema.","responses":{"200":{"description":"Successful operation; the response shape depends on the endpoint."},"401":{"description":"Authentication required or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"The key lacks access to this operation or tenant.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"The tenant request quota or rate limit was exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/tenants/register":{"post":{"summary":"Self-serve tenant registration","operationId":"post_tenants_register","description":"Self-serve tenant registration. Requires the tenant permissions documented by the API; no customer access is granted by this schema.","responses":{"200":{"description":"Successful operation; the response shape depends on the endpoint."},"401":{"description":"Authentication required or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"The key lacks access to this operation or tenant.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"The tenant request quota or rate limit was exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/tenants/invite":{"post":{"summary":"Issue one-time invite credentials for a tenant","operationId":"post_tenants_invite","description":"Issue one-time invite credentials for a tenant. Requires the tenant permissions documented by the API; no customer access is granted by this schema.","responses":{"200":{"description":"Successful operation; the response shape depends on the endpoint."},"401":{"description":"Authentication required or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"The key lacks access to this operation or tenant.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"The tenant request quota or rate limit was exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/billing/plans":{"get":{"summary":"Available subscription tiers and their limits","operationId":"get_billing_plans","description":"Available subscription tiers and their limits. Requires the tenant permissions documented by the API; no customer access is granted by this schema.","responses":{"200":{"description":"Successful operation; the response shape depends on the endpoint."},"401":{"description":"Authentication required or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"The key lacks access to this operation or tenant.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"The tenant request quota or rate limit was exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/billing/usage":{"get":{"summary":"Current-month API call and shipment counts against tier limits","operationId":"get_billing_usage","description":"Current-month API call and shipment counts against tier limits. Requires the tenant permissions documented by the API; no customer access is granted by this schema.","responses":{"200":{"description":"Successful operation; the response shape depends on the endpoint."},"401":{"description":"Authentication required or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"The key lacks access to this operation or tenant.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"The tenant request quota or rate limit was exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/connectors":{"get":{"summary":"Connector inventory for the authenticated tenant","operationId":"get_connectors","description":"Connector inventory for the authenticated tenant. Requires the tenant permissions documented by the API; no customer access is granted by this schema.","responses":{"200":{"description":"Successful operation; the response shape depends on the endpoint."},"401":{"description":"Authentication required or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"The key lacks access to this operation or tenant.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"The tenant request quota or rate limit was exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/connectors/capabilities":{"get":{"summary":"Capability matrix: which operations each connector supports","operationId":"get_connectors_capabilities","description":"Capability matrix: which operations each connector supports. Requires the tenant permissions documented by the API; no customer access is granted by this schema.","responses":{"200":{"description":"Successful operation; the response shape depends on the endpoint."},"401":{"description":"Authentication required or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"The key lacks access to this operation or tenant.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"The tenant request quota or rate limit was exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/control-tower/alerts":{"post":{"summary":"Analyse a shipment payload and return control-tower alerts","operationId":"post_control_tower_alerts","description":"Analyse a shipment payload and return control-tower alerts. Requires the tenant permissions documented by the API; no customer access is granted by this schema.","responses":{"200":{"description":"Successful operation; the response shape depends on the endpoint."},"401":{"description":"Authentication required or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"The key lacks access to this operation or tenant.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"The tenant request quota or rate limit was exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/approvals":{"post":{"summary":"Record a server-side approval for a high-value booking workflow","operationId":"post_approvals","description":"Record a server-side approval for a high-value booking workflow. Requires the tenant permissions documented by the API; no customer access is granted by this schema.","responses":{"200":{"description":"Successful operation; the response shape depends on the endpoint."},"401":{"description":"Authentication required or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"The key lacks access to this operation or tenant.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"The tenant request quota or rate limit was exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/workbench/{module}":{"post":{"summary":"Invoke a workbench module handler by name","operationId":"post_workbench_module","description":"Invoke a workbench module handler by name. Requires the tenant permissions documented by the API; no customer access is granted by this schema.","parameters":[{"name":"module","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation; the response shape depends on the endpoint."},"401":{"description":"Authentication required or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"The key lacks access to this operation or tenant.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"The tenant request quota or rate limit was exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/intent":{"post":{"summary":"Resolve a natural-language operations query to a structured intent","operationId":"post_intent","description":"Resolve a natural-language operations query to a structured intent. Requires the tenant permissions documented by the API; no customer access is granted by this schema.","responses":{"200":{"description":"Successful operation; the response shape depends on the endpoint."},"401":{"description":"Authentication required or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"The key lacks access to this operation or tenant.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"The tenant request quota or rate limit was exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/knowledge":{"post":{"summary":"Query the accounting and operations knowledge base","operationId":"post_knowledge","description":"Query the accounting and operations knowledge base. Requires the tenant permissions documented by the API; no customer access is granted by this schema.","responses":{"200":{"description":"Successful operation; the response shape depends on the endpoint."},"401":{"description":"Authentication required or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"The key lacks access to this operation or tenant.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"The tenant request quota or rate limit was exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/audit/export":{"get":{"summary":"SIEM-compatible NDJSON audit stream","operationId":"get_audit_export","description":"SIEM-compatible NDJSON audit stream. Requires the tenant permissions documented by the API; no customer access is granted by this schema.","responses":{"200":{"description":"Successful operation; the response shape depends on the endpoint."},"401":{"description":"Authentication required or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"The key lacks access to this operation or tenant.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"The tenant request quota or rate limit was exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/health":{"get":{"summary":"Health and contract readiness","operationId":"get_health","description":"Health and contract readiness. Requires the tenant permissions documented by the API; no customer access is granted by this schema.","responses":{"200":{"description":"Successful operation; the response shape depends on the endpoint."},"401":{"description":"Authentication required or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"The key lacks access to this operation or tenant.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"The tenant request quota or rate limit was exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/metrics":{"get":{"summary":"Runtime metrics for monitoring scrapes","operationId":"get_metrics","description":"Runtime metrics for monitoring scrapes. Requires the tenant permissions documented by the API; no customer access is granted by this schema.","responses":{"200":{"description":"Successful operation; the response shape depends on the endpoint."},"401":{"description":"Authentication required or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"The key lacks access to this operation or tenant.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"The tenant request quota or rate limit was exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-aether-api-key"}},"schemas":{"ApiError":{"type":"object","properties":{"error":{"type":"string","description":"Error code or explanation returned by the endpoint."}},"required":["error"],"additionalProperties":true}}},"security":[{"ApiKeyAuth":[]}]}