Skip to main content
GET
/
v1
/
partners
/
{id}
Get partner
curl --request GET \
  --url https://api.example.com/v1/partners/{id}
{
  "data": {
    "email": "[email protected]",
    "created_at": "2025-04-30T16:44:13.000000Z",
    "updated_at": "2025-04-30T16:44:13.000000Z",
    "name": "John",
    "id": "partner_123",
    "surname": "Doe",
    "tos": false,
    "approved": true,
    "status": "active",
    "referrals": {
      "clicks": 150,
      "signups": 12,
      "revenue": [
        {
          "currency": "USD",
          "amount": 1250.00
        }
      ],
      "sales_count": 8,
      "paid_accounts": 5
    },
    "commissions": {
      "paid": 375.00,
      "pending": [
        {
          "currency": "USD",
          "amount": 125.00
        }
      ],
      "not_paid": [
        {
          "currency": "USD",
          "amount": 50.00
        }
      ]
    },
    "custom_field_values": [],
    "custom_fields": [],
    "referrals_count": 12,
    "tags": [
      {
        "value": "premium"
      }
    ],
    "referral_link": "https://yourcompany.com?aff=ref_123",
    "referral_links": [
      "https://yourcompany.com?aff=ref_123"
    ]
  },
  "status": 1
}

​
Endpoint

GET https://api.partnero.com/v1/partners/{id}

​
Path parameters

ParameterTypeRequiredDescription
idstringYesPartner’s unique ID

​
Request

cURL
curl --location 'https://api.partnero.com/v1/partners/partner_123' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY'

​
Response

{
  "data": {
    "email": "[email protected]",
    "created_at": "2025-04-30T16:44:13.000000Z",
    "updated_at": "2025-04-30T16:44:13.000000Z",
    "name": "John",
    "id": "partner_123",
    "surname": "Doe",
    "tos": false,
    "approved": true,
    "status": "active",
    "referrals": {
      "clicks": 150,
      "signups": 12,
      "revenue": [
        {
          "currency": "USD",
          "amount": 1250.00
        }
      ],
      "sales_count": 8,
      "paid_accounts": 5
    },
    "commissions": {
      "paid": 375.00,
      "pending": [
        {
          "currency": "USD",
          "amount": 125.00
        }
      ],
      "not_paid": [
        {
          "currency": "USD",
          "amount": 50.00
        }
      ]
    },
    "custom_field_values": [],
    "custom_fields": [],
    "referrals_count": 12,
    "tags": [
      {
        "value": "premium"
      }
    ],
    "referral_link": "https://yourcompany.com?aff=ref_123",
    "referral_links": [
      "https://yourcompany.com?aff=ref_123"
    ]
  },
  "status": 1
}

​
Response fields

FieldTypeDescription
idstringUnique partner identifier
emailstringPartner’s email address
namestringPartner’s first name
surnamestringPartner’s last name
statusstringPartner status: active, pending, archived, deleted
approvedbooleanWhether the partner is approved
tosbooleanWhether the partner accepted terms of service
custom_fieldsarrayCustom signup field key-value pairs
custom_field_valuesarrayCustom field values (raw)
referrals_countintegerTotal number of referred customers
tagsarrayPartner tags (each with a value key)
referral_linkstringPrimary referral link
referral_linksarrayAll referral links
created_atstringISO 8601 timestamp
updated_atstringISO 8601 timestamp
FieldTypeDescription
clicksintegerTotal referral link clicks
signupsintegerTotal referred sign-ups
revenuearrayRevenue by currency (each with currency and amount)
sales_countintegerTotal sales count
paid_accountsintegerTotal paid accounts from referrals
FieldTypeDescription
paidnumberTotal paid commissions
pendingarrayPending commissions by currency
not_paidarrayUnpaid commissions by currency