Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

QuotaPath deal API

The deal API from QuotaPath — 3 operation(s) for deal.

QuotaPath deal API is one of 7 APIs that QuotaPath publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 7 operations across 3 paths, and defines 5 schemas. It is described by OpenAPI 3.0.0, at version v1.

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

7 operations 3 paths 5 schemas 1 DELETE2 GET1 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v1
Base URL
https://api.quotapath.com/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

QuotaPath deal API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (token_auth). By default, every request must be authenticated.

  • token_auth — API Key authentication header. Prefix QuotaPath-generated api key with 'Token ' in Authorization header value. Example: 'Token abcdef12345'

Paths & Operations 7

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

deal 7
GET
/deal/
List filtered deals or create deal with payload. No query params will list all deals. Supported query params are 'id', 'integrationid', 'pathid', and 'useremail'.
deal_list 2 params → 200
POST
/deal/
List filtered deals or create deal with payload. No query params will list all deals. Supported query params are 'id', 'integrationid', 'pathid', and 'useremail'.
deal_create body → 201
POST
/deal/bulk/
Bulk update or create deals.
deal_bulk_create body → 201
GET
/deal/{uuid}/
View for retrieve, update, delete based on deal uuid
deal 1 param → 200
PUT
/deal/{uuid}/
View for retrieve, update, delete based on deal uuid
deal_update 1 param body → 200
PATCH
/deal/{uuid}/
View for retrieve, update, delete based on deal uuid
deal_partial_update 1 param body → 200
DELETE
/deal/{uuid}/
View for retrieve, update, delete based on deal uuid
deal_delete 1 param → 204

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are ExternalBulkDeal (12 properties), ExternalDeal (12 properties), ExternalDealMetadata (3 properties), ExternalDealValue (2 properties). Each schema is shown below with its type and property counts.

ExternalBulkDealInput
object
1 property 1 required
ExternalDealMetadata
object
3 properties 3 required
ExternalDealValue
object
2 properties 2 required
ExternalDeal
object
12 properties 3 required
ExternalBulkDeal
object
12 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

quotapath-deal-api-openapi.yml Raw ↑

Other APIs QuotaPath publishes across the network.

QuotaPath data API
QuotaPath path API
QuotaPath payout API
QuotaPath plan API
QuotaPath team API
QuotaPath user API