List partners | JazzHQ AI

{
  "success": true,
  "message": "string",
  "data": {
    "data": [
      {
        "id": 1001,
        "companyName": "string",
        "description": "string",
        "website": "string",
        "country": "string",
        "companySize": "string",
        "contactName": "string",
        "contactEmailAddress": "string",
        "contactPhone": "string",
        "contactRole": "string",
        "type": "string",
        "users": [
          {
            "id": 101,
            "firstName": "string",
            "lastName": "string",
            "emailAddress": "string",
            "phoneNumber": "string",
            "jobTitle": "string",
            "lastActiveAt": "2024-01-15T09:30:00Z"
          }
        ],
        "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

401

Unauthorized Error

500

Internal Server Error