IPMusk Tickets API
The Tickets API from IPMusk — 3 operation(s) for tickets.
The Tickets API from IPMusk — 3 operation(s) for tickets.
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/ipmusk-com:ipmusk-com-tickets-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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: IPMusk Customer Tickets API
version: 1.0.0
description: 'Read the catalogue, get residential and static proxy credentials, check usage and orders, and handle support tickets. Authenticate with an API key from the dashboard (Settings > API keys) sent as `Authorization: Bearer `; each key carries the scopes read, connect and/or support. Rate limits per key and minute: read 60, connect 20, support 30 (429 rate_limited, with a Retry-After header in seconds). JSON responses are `{ data, request_id }`; errors are `{ error: { code, message, field_errors? }, request_id }`. Money is amount_minor (minor units) with an ISO 4217 currency.'
servers:
- url: https://ipmusk.com
tags:
- name: Tickets
paths:
/api/v1/tickets:
get:
operationId: tickets_list
summary: List support tickets
description: The account's tickets, most recently updated first, filterable by status and type. Pass next_cursor back as cursor for the next page.
security:
- bearerAuth: []
x-ipmusk-scope: read
parameters:
- name: cursor
in: query
required: false
schema:
type: string
minLength: 1
maxLength: 256
- name: limit
in: query
required: false
schema:
default: 20
type: integer
minimum: 1
maximum: 100
- name: status
in: query
required: false
schema:
type: string
enum:
- open
- waiting_for_customer
- waiting_for_support
- resolved
- closed
- name: type
in: query
required: false
schema:
type: string
enum:
- technical
- billing
- other
responses:
'200':
description: List support tickets
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
items:
type: array
items:
type: object
properties:
id:
type: string
minLength: 1
maxLength: 128
type:
type: string
enum:
- technical
- billing
- other
subject:
type: string
minLength: 3
maxLength: 160
status:
type: string
enum:
- open
- waiting_for_customer
- waiting_for_support
- resolved
- closed
order_id:
anyOf:
- type: string
minLength: 1
maxLength: 128
- type: 'null'
credential_id:
anyOf:
- type: string
minLength: 1
maxLength: 128
- type: 'null'
static_proxy_id:
anyOf:
- type: string
minLength: 1
maxLength: 128
- type: 'null'
created_at:
type: string
format: date-time
pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
updated_at:
type: string
format: date-time
pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
required:
- id
- type
- subject
- status
- order_id
- credential_id
- static_proxy_id
- created_at
- updated_at
additionalProperties: false
next_cursor:
anyOf:
- type: string
- type: 'null'
required:
- items
additionalProperties: false
request_id:
type: string
minLength: 8
maxLength: 128
required:
- data
- request_id
additionalProperties: false
default:
$ref: '#/components/responses/Error'
tags:
- Tickets
post:
operationId: tickets_create
summary: Open a support ticket
description: Opens a ticket, optionally linked to an order and one of its resources. The Idempotency-Key header makes a retry return the same ticket instead of opening a second one. Rate limited per account.
security:
- bearerAuth: []
x-ipmusk-scope: support
parameters:
- name: Idempotency-Key
in: header
required: true
description: 'A unique value per logical request (8-128 of A-Z a-z 0-9 . _ : -). Retrying with the same value returns the first result.'
schema:
type: string
minLength: 8
maxLength: 128
pattern: ^[A-Za-z0-9._:-]+$
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
type:
type: string
enum:
- technical
- billing
- other
subject:
type: string
minLength: 3
maxLength: 160
message:
type: string
minLength: 1
maxLength: 10000
order_id:
type: string
minLength: 1
maxLength: 128
credential_id:
type: string
minLength: 1
maxLength: 128
static_proxy_id:
type: string
minLength: 1
maxLength: 128
required:
- type
- subject
- message
additionalProperties: false
responses:
'201':
description: Open a support ticket
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
id:
type: string
minLength: 1
maxLength: 128
type:
type: string
enum:
- technical
- billing
- other
subject:
type: string
minLength: 3
maxLength: 160
status:
type: string
enum:
- open
- waiting_for_customer
- waiting_for_support
- resolved
- closed
order_id:
anyOf:
- type: string
minLength: 1
maxLength: 128
- type: 'null'
credential_id:
anyOf:
- type: string
minLength: 1
maxLength: 128
- type: 'null'
static_proxy_id:
anyOf:
- type: string
minLength: 1
maxLength: 128
- type: 'null'
created_at:
type: string
format: date-time
pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
updated_at:
type: string
format: date-time
pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
messages:
type: array
items:
type: object
properties:
id:
type: string
minLength: 1
maxLength: 128
author:
type: string
enum:
- customer
- support
body:
type: string
minLength: 1
maxLength: 10000
created_at:
type: string
format: date-time
pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
required:
- id
- author
- body
- created_at
additionalProperties: false
required:
- id
- type
- subject
- status
- order_id
- credential_id
- static_proxy_id
- created_at
- updated_at
- messages
additionalProperties: false
request_id:
type: string
minLength: 8
maxLength: 128
required:
- data
- request_id
additionalProperties: false
default:
$ref: '#/components/responses/Error'
tags:
- Tickets
/api/v1/tickets/{ticketId}:
get:
operationId: tickets_get
summary: One ticket with its messages
description: The ticket and every message visible to the customer. 404 when it is not this account's.
security:
- bearerAuth: []
x-ipmusk-scope: read
parameters:
- name: ticketId
in: path
required: true
schema:
type: string
minLength: 1
maxLength: 128
responses:
'200':
description: One ticket with its messages
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
id:
type: string
minLength: 1
maxLength: 128
type:
type: string
enum:
- technical
- billing
- other
subject:
type: string
minLength: 3
maxLength: 160
status:
type: string
enum:
- open
- waiting_for_customer
- waiting_for_support
- resolved
- closed
order_id:
anyOf:
- type: string
minLength: 1
maxLength: 128
- type: 'null'
credential_id:
anyOf:
- type: string
minLength: 1
maxLength: 128
- type: 'null'
static_proxy_id:
anyOf:
- type: string
minLength: 1
maxLength: 128
- type: 'null'
created_at:
type: string
format: date-time
pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
updated_at:
type: string
format: date-time
pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
messages:
type: array
items:
type: object
properties:
id:
type: string
minLength: 1
maxLength: 128
author:
type: string
enum:
- customer
- support
body:
type: string
minLength: 1
maxLength: 10000
created_at:
type: string
format: date-time
pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
required:
- id
- author
- body
- created_at
additionalProperties: false
required:
- id
- type
- subject
- status
- order_id
- credential_id
- static_proxy_id
- created_at
- updated_at
- messages
additionalProperties: false
request_id:
type: string
minLength: 8
maxLength: 128
required:
- data
- request_id
additionalProperties: false
default:
$ref: '#/components/responses/Error'
tags:
- Tickets
/api/v1/tickets/{ticketId}/replies:
post:
operationId: tickets_reply
summary: Reply to a ticket
description: Adds a customer message. A resolved or closed ticket answers 409 invalid_state_transition. The Idempotency-Key header makes a retry return the same message. Rate limited per account.
security:
- bearerAuth: []
x-ipmusk-scope: support
parameters:
- name: ticketId
in: path
required: true
schema:
type: string
minLength: 1
maxLength: 128
- name: Idempotency-Key
in: header
required: true
description: 'A unique value per logical request (8-128 of A-Z a-z 0-9 . _ : -). Retrying with the same value returns the first result.'
schema:
type: string
minLength: 8
maxLength: 128
pattern: ^[A-Za-z0-9._:-]+$
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
message:
type: string
minLength: 1
maxLength: 10000
required:
- message
additionalProperties: false
responses:
'201':
description: Reply to a ticket
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
id:
type: string
minLength: 1
maxLength: 128
author:
type: string
enum:
- customer
- support
body:
type: string
minLength: 1
maxLength: 10000
created_at:
type: string
format: date-time
pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
required:
- id
- author
- body
- created_at
additionalProperties: false
request_id:
type: string
minLength: 8
maxLength: 128
required:
- data
- request_id
additionalProperties: false
default:
$ref: '#/components/responses/Error'
tags:
- Tickets
components:
responses:
Error:
description: 'Any failure: 400 validation_error, 401 authentication_required, 403 forbidden / capability_unavailable, 404 not_found, 409 invalid_state_transition / idempotency_conflict, 422 product_unavailable, 429 rate_limited, 500 internal_error.'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
schemas:
ErrorEnvelope:
type: object
properties:
error:
type: object
properties:
code:
type: string
enum:
- validation_error
- authentication_required
- region_blocked
- forbidden
- not_found
- idempotency_conflict
- invalid_state_transition
- checkout_unavailable
- product_unavailable
- capability_unavailable
- rate_limited
- challenge_required
- upstream_unavailable
- internal_error
message:
type: string
minLength: 1
maxLength: 500
field_errors:
type: object
propertyNames:
type: string
additionalProperties:
type: array
items:
type: string
minLength: 1
maxLength: 300
required:
- code
- message
additionalProperties: false
request_id:
type: string
minLength: 8
maxLength: 128
required:
- error
- request_id
additionalProperties: false
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: An IPMusk API key (ipm_live_…).