> ## Documentation Index
> Fetch the complete documentation index at: https://developers.leadwaycrm.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Commissions

> Retrieve the list of commissions for a account.

Retrieve the list of commissions for a account.

```http theme={null}
GET https://services.leadconnectorhq.com/affiliate-manager/{locationId}/commissions
```

## Autorización

<ParamField header="Authorization" type="string" required>
  Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
</ParamField>

<ParamField header="Version" type="string" required default="2021-07-28">
  Versión de la API.
</ParamField>

## Path parameters

<ParamField path="locationId" type="string" required default="ve9EPM428h8vShlRW1KT">
  Account Id
</ParamField>

## Query parameters

<ParamField query="campaignId" type="string" default="6385d230f6d19db03eef6fb2">
  Campaign Id
</ParamField>

<ParamField query="affiliateId" type="string" default="6385d230f6d19db03eef6fb2">
  Affiliate Id
</ParamField>

<ParamField query="status" type="string" default="pending">
  Status
</ParamField>

<ParamField query="query" type="string" default="affiliate@gmail.com">
  Query
</ParamField>

<ParamField query="skip" type="number" default="1" />

<ParamField query="limit" type="number" default="10">
  Maximum number of records to return. Maximum allowed value is 100.
</ParamField>

<ParamField query="fromDate" type="string" default="2023-10-01" />

<ParamField query="toDate" type="string" default="2023-10-01" />

## Respuestas

<Accordion title="200 - Successful response">
  <ResponseField name="commissions" type="object[]" required>
    Commission list

    <Expandable title="cada item">
      <ResponseField name="_id" type="string" required default="6385d230f6d19db03eef6fb2">
        Commission id
      </ResponseField>

      <ResponseField name="productId" type="string" default="6385d230f6d19db03eef6fb2">
        Product id
      </ResponseField>

      <ResponseField name="productName" type="string" default="Basic Plan">
        Product name
      </ResponseField>

      <ResponseField name="qty" type="number" default="1">
        Quantity
      </ResponseField>

      <ResponseField name="productCommission" type="number" default="25">
        Product commission amount
      </ResponseField>

      <ResponseField name="commissionAmount" type="number" default="25">
        Commission amount
      </ResponseField>

      <ResponseField name="amount" type="number" default="100">
        Base amount
      </ResponseField>

      <ResponseField name="unitDiscount" type="number" default="5">
        Unit discount
      </ResponseField>

      <ResponseField name="campaignName" type="string" default="Summer Promo">
        Campaign name
      </ResponseField>

      <ResponseField name="commission" type="number" default="25">
        Commission percentage or value
      </ResponseField>

      <ResponseField name="commissionType" type="string" default="percentage">
        Commission type
      </ResponseField>

      <ResponseField name="transactionAt" type="string" default="2024-06-16T00:00:00.000Z">
        Transaction time
      </ResponseField>

      <ResponseField name="transactionId" type="string" default="txn_123">
        Transaction id
      </ResponseField>

      <ResponseField name="affiliateId" type="string" default="6385d230f6d19db03eef6fb2">
        Affiliate id
      </ResponseField>

      <ResponseField name="payoutId" type="string" default="6385d230f6d19db03eef6fb2">
        Payout id
      </ResponseField>

      <ResponseField name="status" type="string" default="pending">
        Commission status
      </ResponseField>

      <ResponseField name="currency" type="string" default="USD">
        Currency
      </ResponseField>

      <ResponseField name="isTrial" type="boolean" default="False">
        Whether the item is a trial commission
      </ResponseField>

      <ResponseField name="customer" type="object">
        Customer details
      </ResponseField>

      <ResponseField name="createdAt" type="string" default="2024-06-16T00:00:00.000Z">
        Created at
      </ResponseField>

      <ResponseField name="eventId" type="string" default="evt_123">
        Event id
      </ResponseField>

      <ResponseField name="campaign" type="object">
        Campaign details
      </ResponseField>

      <ResponseField name="affiliate" type="object">
        Affiliate details
      </ResponseField>

      <ResponseField name="dueAt" type="string" default="2024-06-30T00:00:00.000Z">
        Due date
      </ResponseField>

      <ResponseField name="liveMode" type="boolean" default="True">
        Whether the commission is in live mode
      </ResponseField>

      <ResponseField name="tier" type="number" default="1">
        Commission tier
      </ResponseField>
    </Expandable>
  </ResponseField>

  <ResponseField name="meta" type="object">
    Pagination metadata
  </ResponseField>

  ```json theme={null}
  {
    "commissions": [
      {
        "_id": "6385d230f6d19db03eef6fb2",
        "productId": "6385d230f6d19db03eef6fb2",
        "productName": "Basic Plan",
        "qty": 1,
        "productCommission": 25,
        "commissionAmount": 25,
        "amount": 100,
        "unitDiscount": 5,
        "campaignName": "Summer Promo",
        "commission": 25,
        "commissionType": "percentage",
        "transactionAt": "2024-06-16T00:00:00.000Z",
        "transactionId": "txn_123",
        "affiliateId": "6385d230f6d19db03eef6fb2",
        "payoutId": "6385d230f6d19db03eef6fb2",
        "status": "pending",
        "currency": "USD",
        "isTrial": false,
        "createdAt": "2024-06-16T00:00:00.000Z",
        "eventId": "evt_123",
        "dueAt": "2024-06-30T00:00:00.000Z",
        "liveMode": true,
        "tier": 1
      }
    ]
  }
  ```
</Accordion>

<Accordion title="400 - Bad Request">
  ```json theme={null}
  {}
  ```
</Accordion>

<Accordion title="401 - Unauthorized">
  ```json theme={null}
  {}
  ```
</Accordion>

<Accordion title="422 - Unprocessable Entity">
  ```json theme={null}
  {}
  ```
</Accordion>

## Ejemplo

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET 'https://services.leadconnectorhq.com/affiliate-manager/YOUR_locationId/commissions' \
    -H 'Authorization: Bearer YOUR_TOKEN' \
    -H 'Version: 2021-07-28'
  ```

  ```javascript Node.js theme={null}
  const response = await fetch('https://services.leadconnectorhq.com/affiliate-manager/YOUR_locationId/commissions', {
    method: 'GET',
    headers: {
      Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
      Version: '2021-07-28',
    },
  });
  const data = await response.json();
  ```

  ```python Python theme={null}
  import os, requests
  response = requests.request(
      'GET',
      'https://services.leadconnectorhq.com/affiliate-manager/YOUR_locationId/commissions',
      headers={
          'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
          'Version': '2021-07-28',
      },
  )
  data = response.json()
  ```

  ```php PHP theme={null}
  <?php
  $ch = curl_init('https://services.leadconnectorhq.com/affiliate-manager/YOUR_locationId/commissions');
  curl_setopt_array($ch, [
      CURLOPT_RETURNTRANSFER => true,
      CURLOPT_CUSTOMREQUEST => 'GET',
      CURLOPT_HTTPHEADER => [
          'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
          'Version: 2021-07-28',
      ],
  ]);
  $data = json_decode(curl_exec($ch), true);
  ```
</CodeGroup>