> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://developers.jazzhq.ai/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.jazzhq.ai/_mcp/server. # List partners GET https://api.jazzhq.ai/api/v1/vendors/partners Returns partners connected to your vendor account, paginated. Reference: https://developers.jazzhq.ai/api-reference/vendor-customer-ap-is/partner/list-partners ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: jazzhq-vendor-apis version: 1.0.0 paths: /api/v1/vendors/partners: get: operationId: listPartners summary: List partners description: Returns partners connected to your vendor account, paginated. tags: - partner parameters: - name: page in: query description: Zero-based page number. required: false schema: type: integer default: 0 - name: perPage in: query description: Number of results per page. required: false schema: type: integer default: 20 - name: sortBy in: query description: Field to sort results by. required: false schema: type: string default: id - name: X-API-KEY in: header description: >- Your vendor API key. Required on every request under /api/v1/vendors/**. required: true schema: type: string responses: '200': description: Partners retrieved successfully. content: application/json: schema: $ref: '#/components/schemas/PartnerListResponseEnvelope' '403': description: > Authentication failed - the X-API-KEY header was missing or invalid, or the request path is outside the /api/v1/vendors/ namespace this key is authorized for. content: application/json: schema: $ref: '#/components/schemas/AuthErrorResponse' '500': description: An unexpected error occurred. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' servers: - url: https://api.jazzhq.ai description: Production components: schemas: PartnerType: type: string enum: - RESELLER - DISTRIBUTOR title: PartnerType Partner: type: object properties: id: type: integer format: int64 companyName: type: string description: type: - string - 'null' website: type: - string - 'null' country: type: - string - 'null' companySize: type: - string - 'null' contactName: type: string contactEmailAddress: type: string format: email contactPhone: type: - string - 'null' contactRole: type: - string - 'null' type: oneOf: - $ref: '#/components/schemas/PartnerType' - type: 'null' invitedAt: type: - string - 'null' format: date-time createdAt: type: string format: date-time title: Partner PartnerPage: type: object properties: data: type: array items: $ref: '#/components/schemas/Partner' page: type: integer perPage: type: integer totalItems: type: integer format: int64 title: PartnerPage PartnerListResponseEnvelope: type: object properties: success: type: boolean message: type: - string - 'null' data: $ref: '#/components/schemas/PartnerPage' timestamp: type: string format: date-time title: PartnerListResponseEnvelope AuthErrorResponse: type: object properties: success: type: boolean message: type: string description: 'One of: API_KEY_MISSING, INVALID_API_KEY, UNKNOWN_API_NAMESPACE.' data: oneOf: - description: Any type - type: 'null' timestamp: type: string format: date-time description: > Error shape returned specifically for authentication failures (HTTP 403), before a request ever reaches business logic. Note this differs from ErrorResponse: there is no `status` field and no `errors` array. title: AuthErrorResponse ValidationErrorDetail: type: object properties: field: type: string description: Name of the request field this error relates to. error: type: string description: Human-readable description of what's wrong. title: ValidationErrorDetail ErrorResponse: type: object properties: message: type: string description: > Machine-readable error code. One of: VALIDATION_FAILED, INVALID_REQUEST, DUPLICATE_ENTRY, RESOURCE_NOT_FOUND, INTERNAL_SERVER_ERROR. status: type: integer success: type: boolean errors: type: array items: $ref: '#/components/schemas/ValidationErrorDetail' timestamp: type: string format: date-time description: > Standard error shape for validation, duplicate, not-found, and server errors (HTTP 400, 404, 500). Authentication failures (HTTP 403) use a different, simpler shape - see AuthErrorResponse. title: ErrorResponse securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-API-KEY description: Your vendor API key. Required on every request under /api/v1/vendors/**. ``` ## Examples **Request** ```json {} ``` **Response** ```json { "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" } ``` **SDK Code** ```python import requests url = "https://api.jazzhq.ai/api/v1/vendors/partners" payload = {} headers = { "X-API-KEY": "", "Content-Type": "application/json" } response = requests.get(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.jazzhq.ai/api/v1/vendors/partners'; const options = { method: 'GET', headers: {'X-API-KEY': '', 'Content-Type': 'application/json'}, body: '{}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.jazzhq.ai/api/v1/vendors/partners" payload := strings.NewReader("{}") req, _ := http.NewRequest("GET", url, payload) req.Header.Add("X-API-KEY", "") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.jazzhq.ai/api/v1/vendors/partners") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["X-API-KEY"] = '' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.jazzhq.ai/api/v1/vendors/partners") .header("X-API-KEY", "") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('GET', 'https://api.jazzhq.ai/api/v1/vendors/partners', [ 'body' => '{}', 'headers' => [ 'Content-Type' => 'application/json', 'X-API-KEY' => '', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.jazzhq.ai/api/v1/vendors/partners"); var request = new RestRequest(Method.GET); request.AddHeader("X-API-KEY", ""); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "X-API-KEY": "", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.jazzhq.ai/api/v1/vendors/partners")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```