Puzzle Customers API
The Customers API from Puzzle — 2 operation(s) for customers.
The Customers API from Puzzle — 2 operation(s) for customers.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/puzzle-customers-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Puzzle Customers API
description: Puzzle Api
version: '0'
servers:
- url: https://staging.southparkdata.com/rest/v0
tags:
- name: Customers
paths:
/company/{id}/customers:
get:
operationId: customersApi
summary: Get Customers
description: 'Retrieves a list of all of the company''s customers.
Required scope: write:customer'
tags:
- Customers
parameters:
- name: id
in: path
required: true
description: The company ID
schema:
type: string
minLength: 1
description: Partner-facing external identifier
- name: name
in: query
required: false
schema:
type: string
- name: type
in: query
required: false
schema:
type: string
enum:
- Individual
- Business
- Unknown
- name: status
in: query
required: false
schema:
type: string
enum:
- Active
- Inactive
- Unknown
- name: count
in: query
required: false
schema:
type: integer
- name: after
in: query
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
items:
type: array
items:
type: object
properties:
id:
type: string
minLength: 1
description: Partner-facing external identifier
name:
type:
- string
- 'null'
email:
type:
- string
- 'null'
phoneNumber:
type:
- string
- 'null'
billingAddressJson:
type:
- object
- 'null'
properties:
zip:
type: string
city:
type: string
addressLine1:
type: string
addressLine2:
type: string
state:
anyOf:
- type: string
enum:
- ''
- type: object
properties:
label:
type: string
value:
type: string
required:
- label
- value
country:
anyOf:
- type: string
enum:
- ''
- type: object
properties:
label:
type: string
value:
type: string
required:
- label
- value
required:
- zip
- city
- addressLine1
- addressLine2
companyName:
type:
- string
- 'null'
contactName:
type:
- string
- 'null'
description:
type:
- string
- 'null'
website:
type:
- string
- 'null'
status:
type:
- string
- 'null'
enum:
- Active
- Inactive
- Unknown
type:
type:
- string
- 'null'
enum:
- Individual
- Business
- Unknown
required:
- id
- name
- email
- phoneNumber
- billingAddressJson
- companyName
- contactName
- description
- website
- status
- type
pageInfo:
type: object
properties:
endCursor:
type:
- string
- 'null'
hasNextPage:
type: boolean
total:
type:
- integer
- 'null'
required:
- endCursor
- hasNextPage
- total
required:
- items
- pageInfo
post:
operationId: createCustomerApi
summary: Create Customer
description: 'Creates a new Customer for the company.
Required scope: write:customer'
tags:
- Customers
parameters:
- name: id
in: path
required: true
description: The company ID
schema:
type: string
minLength: 1
description: Partner-facing external identifier
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
minLength: 1
email:
type: string
phoneNumber:
type: string
billingAddressJson:
type:
- object
- 'null'
properties:
zip:
type: string
city:
type: string
addressLine1:
type: string
addressLine2:
type: string
state:
anyOf:
- type: string
enum:
- ''
- type: object
properties:
label:
type: string
value:
type: string
required:
- label
- value
country:
anyOf:
- type: string
enum:
- ''
- type: object
properties:
label:
type: string
value:
type: string
required:
- label
- value
required:
- zip
- city
- addressLine1
- addressLine2
companyName:
type: string
contactName:
type: string
description:
type: string
website:
type: string
status:
type: string
enum:
- Active
- Inactive
- Unknown
type:
type: string
enum:
- Individual
- Business
- Unknown
required:
- name
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
id:
type: string
minLength: 1
description: Partner-facing external identifier
name:
type:
- string
- 'null'
email:
type:
- string
- 'null'
phoneNumber:
type:
- string
- 'null'
billingAddressJson:
type:
- object
- 'null'
properties:
zip:
type: string
city:
type: string
addressLine1:
type: string
addressLine2:
type: string
state:
anyOf:
- type: string
enum:
- ''
- type: object
properties:
label:
type: string
value:
type: string
required:
- label
- value
country:
anyOf:
- type: string
enum:
- ''
- type: object
properties:
label:
type: string
value:
type: string
required:
- label
- value
required:
- zip
- city
- addressLine1
- addressLine2
companyName:
type:
- string
- 'null'
contactName:
type:
- string
- 'null'
description:
type:
- string
- 'null'
website:
type:
- string
- 'null'
status:
type:
- string
- 'null'
enum:
- Active
- Inactive
- Unknown
type:
type:
- string
- 'null'
enum:
- Individual
- Business
- Unknown
required:
- id
- name
- email
- phoneNumber
- billingAddressJson
- companyName
- contactName
- description
- website
- status
- type
/company/{id}/customers/{customerId}:
patch:
operationId: updateCustomerApi
summary: Update Customer
description: 'Updates a Customer for the company.
Required scope: write:customer'
tags:
- Customers
parameters:
- name: id
in: path
required: true
description: The company ID
schema:
type: string
minLength: 1
description: Partner-facing external identifier
- name: customerId
in: path
required: true
description: The customer ID
schema:
type: string
minLength: 1
description: Partner-facing external identifier
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
email:
type: string
phoneNumber:
type: string
billingAddressJson:
type:
- object
- 'null'
properties:
zip:
type: string
city:
type: string
addressLine1:
type: string
addressLine2:
type: string
state:
anyOf:
- type: string
enum:
- ''
- type: object
properties:
label:
type: string
value:
type: string
required:
- label
- value
country:
anyOf:
- type: string
enum:
- ''
- type: object
properties:
label:
type: string
value:
type: string
required:
- label
- value
required:
- zip
- city
- addressLine1
- addressLine2
companyName:
type: string
contactName:
type: string
description:
type: string
website:
type: string
status:
type: string
enum:
- Active
- Inactive
- Unknown
type:
type: string
enum:
- Individual
- Business
- Unknown
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
id:
type: string
minLength: 1
description: Partner-facing external identifier
name:
type:
- string
- 'null'
email:
type:
- string
- 'null'
phoneNumber:
type:
- string
- 'null'
billingAddressJson:
type:
- object
- 'null'
properties:
zip:
type: string
city:
type: string
addressLine1:
type: string
addressLine2:
type: string
state:
anyOf:
- type: string
enum:
- ''
- type: object
properties:
label:
type: string
value:
type: string
required:
- label
- value
country:
anyOf:
- type: string
enum:
- ''
- type: object
properties:
label:
type: string
value:
type: string
required:
- label
- value
required:
- zip
- city
- addressLine1
- addressLine2
companyName:
type:
- string
- 'null'
contactName:
type:
- string
- 'null'
description:
type:
- string
- 'null'
website:
type:
- string
- 'null'
status:
type:
- string
- 'null'
enum:
- Active
- Inactive
- Unknown
type:
type:
- string
- 'null'
enum:
- Individual
- Business
- Unknown
required:
- id
- name
- email
- phoneNumber
- billingAddressJson
- companyName
- contactName
- description
- website
- status
- type