List partners | JazzHQ AI

{
  "success": true,
  "message": null,
  "data": {
    "data": [
      {
        "id": 1001,
        "companyName": "Acme Solutions Ltd.",
        "description": "Leading provider of cloud integration services.",
        "website": "https://www.acmesolutions.com",
        "country": "USA",
        "companySize": "51-200 employees",
        "contactName": "Jane Doe",
        "contactEmailAddress": "jane.doe@acmesolutions.com",
        "contactPhone": "+1-555-123-4567",
        "contactRole": "Partner Manager",
        "type": "RESELLER",
        "invitedAt": "2024-01-15T09:30:00Z",
        "createdAt": "2024-01-15T09:30:00Z"
      }
    ],
    "page": 1,
    "perPage": 1,
    "totalItems": 1
  },
  "timestamp": "2024-01-15T09:30:00Z"
}

Returns partners connected to your vendor account, paginated.

Authentication

X-API-KEYstring

Your vendor API key. Required on every request under /api/v1/vendors/**.

Query parameters

pageintegerOptionalDefaults to 0

Zero-based page number.

perPageintegerOptionalDefaults to 20

Number of results per page.

sortBystringOptionalDefaults to id

Field to sort results by.

Response

Partners retrieved successfully.

successbooleanOptional

messagestring or nullOptional

dataobjectOptional

timestampdatetimeOptional

Errors

403

Forbidden Error

500

Internal Server Error

$	curl https://api.jazzhq.ai/api/v1/vendors/partners \
>	-H "X-API-KEY: <apiKey>" \
>	-H "Content-Type: application/json"