Skip to main content
GET
/
v1
/
disputes
List delivery disputes
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://sandbox.api.enfinitos.com/v1/disputes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "ok": true,
  "data": {
    "disputes": [
      {
        "id": "<string>",
        "orgId": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "openedBy": "<string>",
        "openedAt": "2023-11-07T05:31:56Z",
        "disputedPeriod": {
          "start": "2023-11-07T05:31:56Z",
          "end": "2023-11-07T05:31:56Z"
        },
        "affectedSurface": {
          "campaignId": "<string>",
          "screenIds": [
            "<string>"
          ],
          "substrateId": "<string>"
        },
        "claimedShortfall": {
          "unit": "<string>",
          "amount": "<string>"
        },
        "evidenceBundle": {
          "proofPackIds": [
            "<string>"
          ],
          "meteringSnapshotIds": [
            "<string>"
          ],
          "settlementApplicationIds": [
            "<string>"
          ],
          "attachmentRefs": [
            "<string>"
          ],
          "auditorReportRef": "<string>"
        },
        "operatorResponse": {
          "at": "2023-11-07T05:31:56Z",
          "by": "<string>",
          "notes": "<string>",
          "proposedRemedy": {
            "amount": "<string>",
            "makegoodWindow": {
              "start": "2023-11-07T05:31:56Z",
              "end": "2023-11-07T05:31:56Z"
            }
          }
        },
        "advertiserResponse": {
          "at": "2023-11-07T05:31:56Z",
          "by": "<string>",
          "notes": "<string>"
        },
        "resolution": {
          "creditNoteId": "<string>",
          "makegoodCampaignId": "<string>",
          "settlementAdjustmentId": "<string>",
          "resolvedAt": "2023-11-07T05:31:56Z",
          "resolvedBy": "<string>",
          "notes": "<string>"
        },
        "timeline": [
          {
            "at": "2023-11-07T05:31:56Z",
            "actor": "<string>",
            "notes": "<string>"
          }
        ]
      }
    ],
    "total": 123,
    "filteredCount": 123,
    "counts": {}
  },
  "contractVersion": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key sent as Authorization: Bearer <api-key>.

Query Parameters

​
state
enum<string>

Filter to a single dispute state. Delivery-dispute lifecycle. RESOLVED and WITHDRAWN are terminal; ESCALATED is not (it can later resolve, withdraw, or rejoin negotiation).

Available options:
OPENED,
INVESTIGATING,
EVIDENCE_GATHERED,
OPERATOR_RESPONDED,
ADVERTISER_RESPONDED,
RESOLVED,
WITHDRAWN,
ESCALATED

Response

Disputes (optionally filtered) plus per-state counts.

​
ok
boolean
required
​
data
object
required

Route-specific payload. Operation responses refine this.

​
contractVersion
string
required
Allowed value: "v1.0"