Download OpenAPI specification:Download
This is the API documentation for the CLIENTXCMS New Gen API.
| email required | string <email> |
| password required | string <password> |
{- "password": "password123"
}{- "token": "string",
- "token_type": "Bearer",
- "requires_2fa": true,
- "customer": { }
}| email required | string <email> |
| password required | string <password> |
| password_confirmation required | string <password> |
| firstname required | string |
| lastname required | string |
| address | string |
| address2 | string |
| city | string |
| zipcode | string |
| region | string |
| phone | string |
| country required | string |
{- "password": "pa$$word",
- "password_confirmation": "pa$$word",
- "firstname": "string",
- "lastname": "string",
- "address": "string",
- "address2": "string",
- "city": "string",
- "zipcode": "string",
- "region": "string",
- "phone": "string",
- "country": "FR"
}{- "message": "string",
- "token": "string",
- "customer": { }
}| email required | string <email> |
{- "email": "[email protected]"
}{- "message": "string"
}| token required | string |
| email required | string <email> |
| password required | string <password> |
| password_confirmation required | string <password> |
{- "token": "string",
- "password": "pa$$word",
- "password_confirmation": "pa$$word"
}{- "message": "string"
}{- "data": {
- "id": 0,
- "email": "string",
- "firstname": "string",
- "lastname": "string",
- "address": "string",
- "city": "string",
- "country": "string",
- "phone": "string",
- "balance": 0,
- "two_factor_enabled": true,
- "created_at": "2019-08-24T14:15:22Z"
}
}| firstname | string |
| lastname | string |
| address | string |
| address2 | string |
| city | string |
| zipcode | string |
| region | string |
| country | string |
| phone | string |
{- "firstname": "string",
- "lastname": "string",
- "address": "string",
- "address2": "string",
- "city": "string",
- "zipcode": "string",
- "region": "string",
- "country": "string",
- "phone": "string"
}{- "message": "string",
- "data": { }
}| current_password required | string |
| password required | string |
| password_confirmation required | string |
{- "current_password": "string",
- "password": "string",
- "password_confirmation": "string"
}| code required | string |
| secret | string Required when enabling 2FA |
{- "code": "123456",
- "secret": "string"
}{- "message": "string",
- "enabled": true,
- "recovery_codes": [
- "string"
]
}| security_question_id required | integer |
| security_answer required | string |
| current_password required | string |
{- "security_question_id": 0,
- "security_answer": "string",
- "current_password": "string"
}| department_id required | integer |
| subject required | string |
| content required | string |
| priority required | string Enum: "low" "medium" "high" |
| related_id | integer |
| related_type | string |
{- "department_id": 0,
- "subject": "string",
- "content": "string",
- "priority": "low",
- "related_id": 0,
- "related_type": "string"
}{ }Returns a paginated list of pricing entries with optional filtering and sorting.
| per_page | integer Default: 15 Number of results per page |
| filter[related_id] | integer Filter by related ID |
| filter[related_type] | string Filter by related type (e.g. product, config_option) |
| filter[currency] | string Example: filter[currency]=EUR Filter by currency |
| filter[monthly] | number <float> Filter by monthly price ou can replace this with any other pricing field |
| sort[] | Array of strings Example: sort[]=monthly Sort fields (use - for descending) |
{- "related_id": 123,
- "related_type": "product",
- "currency": "USD",
- "onetime": 99.99,
- "monthly": 9.99,
- "quarterly": 24.99,
- "semiannually": 49.99,
- "annually": 99.99,
- "biennially": 199.99,
- "triennially": 299.99,
- "setup_onetime": 19.99,
- "setup_monthly": 4.99,
- "setup_quarterly": 9.99,
- "setup_semiannually": 14.99,
- "setup_annually": 29.99,
- "setup_biennially": 49.99,
- "setup_triennially": 69.99
}Creates a new pricing entry for a product or config option
| related_id required | integer ID of the related product/service |
| related_type required | string Type of the related entity (e.g. product, config_option) |
| currency required | string Currency code (ISO 4217) |
| onetime | number or null <float> |
| monthly | number or null <float> |
| quarterly | number or null <float> |
| semiannually | number or null <float> |
| annually | number or null <float> |
| biennially | number or null <float> |
| triennially | number or null <float> |
| setup_onetime | number or null <float> |
| setup_monthly | number or null <float> |
| setup_quarterly | number or null <float> |
| setup_semiannually | number or null <float> |
| setup_annually | number or null <float> |
| setup_biennially | number or null <float> |
| setup_triennially | number or null <float> |
{- "related_id": 123,
- "related_type": "product",
- "currency": "EUR",
- "onetime": 99.99,
- "monthly": 9.99,
- "quarterly": 27.99,
- "semiannually": 55.99,
- "annually": 99.99,
- "biennially": 189.99,
- "triennially": 279.99,
- "setup_onetime": 9.99,
- "setup_monthly": 2.99,
- "setup_quarterly": 5.99,
- "setup_semiannually": 8.99,
- "setup_annually": 12.99,
- "setup_biennially": 22.99,
- "setup_triennially": 32.99
}{- "related_id": 123,
- "related_type": "product",
- "currency": "USD",
- "onetime": 99.99,
- "monthly": 9.99,
- "quarterly": 24.99,
- "semiannually": 49.99,
- "annually": 99.99,
- "biennially": 199.99,
- "triennially": 299.99,
- "setup_onetime": 19.99,
- "setup_monthly": 4.99,
- "setup_quarterly": 9.99,
- "setup_semiannually": 14.99,
- "setup_annually": 29.99,
- "setup_biennially": 49.99,
- "setup_triennially": 69.99
}Returns the pricing identified by id
| id required | integer |
{- "related_id": 123,
- "related_type": "product",
- "currency": "USD",
- "onetime": 99.99,
- "monthly": 9.99,
- "quarterly": 24.99,
- "semiannually": 49.99,
- "annually": 99.99,
- "biennially": 199.99,
- "triennially": 299.99,
- "setup_onetime": 19.99,
- "setup_monthly": 4.99,
- "setup_quarterly": 9.99,
- "setup_semiannually": 14.99,
- "setup_annually": 29.99,
- "setup_biennially": 49.99,
- "setup_triennially": 69.99
}Updates an existing pricing record
| id required | integer |
| related_id required | integer ID of the related product/service |
| related_type required | string Type of the related entity (e.g. product, config_option) |
| currency required | string Currency code (ISO 4217) |
| onetime | number or null <float> |
| monthly | number or null <float> |
| quarterly | number or null <float> |
| semiannually | number or null <float> |
| annually | number or null <float> |
| biennially | number or null <float> |
| triennially | number or null <float> |
| setup_onetime | number or null <float> |
| setup_monthly | number or null <float> |
| setup_quarterly | number or null <float> |
| setup_semiannually | number or null <float> |
| setup_annually | number or null <float> |
| setup_biennially | number or null <float> |
| setup_triennially | number or null <float> |
{- "related_id": 123,
- "related_type": "product",
- "currency": "EUR",
- "onetime": 99.99,
- "monthly": 9.99,
- "quarterly": 27.99,
- "semiannually": 55.99,
- "annually": 99.99,
- "biennially": 189.99,
- "triennially": 279.99,
- "setup_onetime": 9.99,
- "setup_monthly": 2.99,
- "setup_quarterly": 5.99,
- "setup_semiannually": 8.99,
- "setup_annually": 12.99,
- "setup_biennially": 22.99,
- "setup_triennially": 32.99
}{- "related_id": 123,
- "related_type": "product",
- "currency": "USD",
- "onetime": 99.99,
- "monthly": 9.99,
- "quarterly": 24.99,
- "semiannually": 49.99,
- "annually": 99.99,
- "biennially": 199.99,
- "triennially": 299.99,
- "setup_onetime": 19.99,
- "setup_monthly": 4.99,
- "setup_quarterly": 9.99,
- "setup_semiannually": 14.99,
- "setup_annually": 29.99,
- "setup_biennially": 49.99,
- "setup_triennially": 69.99
}Deletes a pricing from the system
| id required | integer |
{- "related_id": 123,
- "related_type": "product",
- "currency": "USD",
- "onetime": 99.99,
- "monthly": 9.99,
- "quarterly": 24.99,
- "semiannually": 49.99,
- "annually": 99.99,
- "biennially": 199.99,
- "triennially": 299.99,
- "setup_onetime": 19.99,
- "setup_monthly": 4.99,
- "setup_quarterly": 9.99,
- "setup_semiannually": 14.99,
- "setup_annually": 29.99,
- "setup_biennially": 49.99,
- "setup_triennially": 69.99
}Returns list of products with optional filters, sorting, relations and pagination.
| filter[id] | integer Filter by product ID |
| filter[name] | string Filter by product name |
| filter[status] | string Enum: "active" "hidden" "unreferenced" Filter by product status |
| filter[description] | string Filter by description |
| filter[group_id] | integer Filter by group ID |
| filter[stock] | integer Filter by stock |
| filter[type] | string Filter by product type |
| filter[pinned] | boolean Filter by pinned status |
| sort | string Enum: "id" "name" "status" "description" "sort_order" "group_id" "stock" "type" "pinned" Sort field (e.g. sort=name or sort=-name for descending) |
| include | string Example: include=metadata,pricing,group Include relations (e.g. metadata, pricing, group) |
| per_page | integer Default: 12 Number of items per page |
Creates a new product and its pricing.
| name required | string |
| description | string |
| status required | string Enum: "active" "hidden" "unreferenced" |
| group_id required | integer |
| stock required | integer |
| type required | string |
| pinned | boolean |
Array of objects (Shop pricing) Array of pricing definitions for the product | |
| image | string or null <binary> Product image file (jpeg, png, jpg, gif, svg) |
| remove_image | string Enum: "true" "false" Flag to remove existing product image |
{- "name": "VPS SSD 2 vCPU",
- "description": "High performance VPS with SSD storage",
- "status": "active",
- "group_id": 1,
- "stock": 20,
- "type": "vps",
- "pinned": true,
- "pricing": [
- {
- "related_id": 123,
- "related_type": "product",
- "currency": "USD",
- "onetime": 99.99,
- "monthly": 9.99,
- "quarterly": 24.99,
- "semiannually": 49.99,
- "annually": 99.99,
- "biennially": 199.99,
- "triennially": 299.99,
- "setup_onetime": 19.99,
- "setup_monthly": 4.99,
- "setup_quarterly": 9.99,
- "setup_semiannually": 14.99,
- "setup_annually": 29.99,
- "setup_biennially": 49.99,
- "setup_triennially": 69.99
}
], - "image": "string",
- "remove_image": "false"
}{- "id": "10",
- "name": "Sample Item",
- "status": "active",
- "description": "This is a sample item description.",
- "sort_order": 1,
- "group_id": 123,
- "stock": 50,
- "type": "pterodactyl",
- "pinned": true,
- "image": "storage/products/sample.jpg"
}Returns product data
| id required | integer product id |
| include | string Example: include=metadata,pricing,group Include relations (e.g. metadata, pricing, group) |
{- "id": "10",
- "name": "Sample Item",
- "status": "active",
- "description": "This is a sample item description.",
- "sort_order": 1,
- "group_id": 123,
- "stock": 50,
- "type": "pterodactyl",
- "pinned": true,
- "image": "storage/products/sample.jpg"
}Updates product details including pricing and image.
| id required | integer ID of the product to update |
| name required | string |
| description | string |
| status required | string Enum: "active" "hidden" "unreferenced" |
| group_id required | integer |
| stock required | integer |
| type required | string |
| pinned | boolean |
Array of objects (Shop pricing) Array of pricing definitions for the product | |
| image | string or null <binary> Product image file (jpeg, png, jpg, gif, svg) |
| remove_image | string Enum: "true" "false" Flag to remove existing product image |
{- "name": "VPS SSD 2 vCPU",
- "description": "High performance VPS with SSD storage",
- "status": "active",
- "group_id": 1,
- "stock": 20,
- "type": "vps",
- "pinned": true,
- "pricing": [
- {
- "related_id": 123,
- "related_type": "product",
- "currency": "USD",
- "onetime": 99.99,
- "monthly": 9.99,
- "quarterly": 24.99,
- "semiannually": 49.99,
- "annually": 99.99,
- "biennially": 199.99,
- "triennially": 299.99,
- "setup_onetime": 19.99,
- "setup_monthly": 4.99,
- "setup_quarterly": 9.99,
- "setup_semiannually": 14.99,
- "setup_annually": 29.99,
- "setup_biennially": 49.99,
- "setup_triennially": 69.99
}
], - "image": "string",
- "remove_image": "false"
}{- "id": "10",
- "name": "Sample Item",
- "status": "active",
- "description": "This is a sample item description.",
- "sort_order": 1,
- "group_id": 123,
- "stock": 50,
- "type": "pterodactyl",
- "pinned": true,
- "image": "storage/products/sample.jpg"
}Deletes the specified product.
| id required | integer ID of the product to delete |
{- "id": "10",
- "name": "Sample Item",
- "status": "active",
- "description": "This is a sample item description.",
- "sort_order": 1,
- "group_id": 123,
- "stock": 50,
- "type": "pterodactyl",
- "pinned": true,
- "image": "storage/products/sample.jpg"
}Returns list of groups with optional filters, sorting and relations
| filter[name] | string Filter by name |
| filter[slug] | string Filter by slug |
| sort | string Sort by field, e.g. sort=name or sort=-name for descending |
| include | string Example: include=products,groups Include relations (products, groups, metadata) |
| per_page | integer Default: 12 Number of results per page |
| name required | string <= 255 characters |
| description required | string |
| status required | string Enum: "active" "hidden" "unreferenced" |
| slug required | string <= 255 characters |
| sort_order required | integer |
| pinned | boolean or null |
| image | string or null <binary> |
| parent_id | integer or null |
| use_image_as_background | boolean or null |
{- "name": "string",
- "description": "string",
- "status": "active",
- "slug": "string",
- "sort_order": 0,
- "pinned": true,
- "image": "string",
- "parent_id": 0,
- "use_image_as_background": true
}Returns group data
| id required | integer Group id |
| include | string Example: include=products,groups Include relations (products, groups, metadata) |
{- "id": "10",
- "name": "Sample Item",
- "slug": "sample-item",
- "status": "active",
- "description": "This is a sample item description.",
- "sort_order": 1,
- "group_id": 1,
- "pinned": true,
- "image": "groups/filename.jpg",
- "parent_id": 1
}| id required | integer Group ID |
| name | string <= 255 characters |
| description | string <= 1000 characters |
| status | string Enum: "active" "hidden" "unreferenced" |
| slug | string <= 255 characters |
| sort_order | integer |
| pinned | boolean or null |
| image | string or null <binary> |
| remove_image | string or null Enum: "true" "false" |
| parent_id | integer or null |
| use_image_as_background | string or null Enum: "true" "false" |
{- "name": "string",
- "description": "string",
- "status": "active",
- "slug": "string",
- "sort_order": 0,
- "pinned": true,
- "image": "string",
- "remove_image": "true",
- "parent_id": 0,
- "use_image_as_background": "true"
}Delete group data
| id required | integer group id |
{- "id": "10",
- "name": "Sample Item",
- "slug": "sample-item",
- "status": "active",
- "description": "This is a sample item description.",
- "sort_order": 1,
- "group_id": 1,
- "pinned": true,
- "image": "groups/filename.jpg",
- "parent_id": 1
}Returns a list of services
| page | integer Default: 1 Page number |
| page | integer Default: 1 Page number |
| per_page | integer Default: 10 Number of items per page |
| sort | string Default: "created_at" Sort order |
| filter | string Filter services |
| include | string Default: "customer,metadata,pricings,configoptions" Related resources to include |
Returns service data
| id required | string service id or uuid |
{- "customer_id": 123,
- "uuid": "550e8400-e29b-41d4-a716-446655440000",
- "name": "Service name",
- "type": "proxmox",
- "billing": "monthly",
- "server_id": 1,
- "product_id": 1,
- "invoice_id": 123,
- "status": "active",
- "expires_at": "2021-01-01 00:00:00",
- "suspended_at": "2021-01-01 00:00:00",
- "cancelled_at": "2021-01-01 00:00:00",
- "cancelled_reason": "Service cancelled",
- "notes": "Service notes",
- "delivery_errors": "Delivery errors",
- "delivery_attempts": 1,
- "renewals": 1,
- "trial_ends_at": "2021-01-01 00:00:00",
- "max_renewals": 1,
- "data": {
- "key": "value"
}, - "currency": "USD",
- "suspend_reason": "Service suspended"
}Delete service data
| id required | string service id or uuid |
{- "customer_id": 123,
- "uuid": "550e8400-e29b-41d4-a716-446655440000",
- "name": "Service name",
- "type": "proxmox",
- "billing": "monthly",
- "server_id": 1,
- "product_id": 1,
- "invoice_id": 123,
- "status": "active",
- "expires_at": "2021-01-01 00:00:00",
- "suspended_at": "2021-01-01 00:00:00",
- "cancelled_at": "2021-01-01 00:00:00",
- "cancelled_reason": "Service cancelled",
- "notes": "Service notes",
- "delivery_errors": "Delivery errors",
- "delivery_attempts": 1,
- "renewals": 1,
- "trial_ends_at": "2021-01-01 00:00:00",
- "max_renewals": 1,
- "data": {
- "key": "value"
}, - "currency": "USD",
- "suspend_reason": "Service suspended"
}Returns service data and result
| id required | string service id or uuid |
| force | boolean |
{- "force": false
}{- "customer_id": 123,
- "uuid": "550e8400-e29b-41d4-a716-446655440000",
- "name": "Service name",
- "type": "proxmox",
- "billing": "monthly",
- "server_id": 1,
- "product_id": 1,
- "invoice_id": 123,
- "status": "active",
- "expires_at": "2021-01-01 00:00:00",
- "suspended_at": "2021-01-01 00:00:00",
- "cancelled_at": "2021-01-01 00:00:00",
- "cancelled_reason": "Service cancelled",
- "notes": "Service notes",
- "delivery_errors": "Delivery errors",
- "delivery_attempts": 1,
- "renewals": 1,
- "trial_ends_at": "2021-01-01 00:00:00",
- "max_renewals": 1,
- "data": {
- "key": "value"
}, - "currency": "USD",
- "suspend_reason": "Service suspended"
}Returns service data and result
| id required | string service id or uuid |
| reason | string |
| notify | boolean |
{- "reason": "unpaid",
- "notify": false
}{- "customer_id": 123,
- "uuid": "550e8400-e29b-41d4-a716-446655440000",
- "name": "Service name",
- "type": "proxmox",
- "billing": "monthly",
- "server_id": 1,
- "product_id": 1,
- "invoice_id": 123,
- "status": "active",
- "expires_at": "2021-01-01 00:00:00",
- "suspended_at": "2021-01-01 00:00:00",
- "cancelled_at": "2021-01-01 00:00:00",
- "cancelled_reason": "Service cancelled",
- "notes": "Service notes",
- "delivery_errors": "Delivery errors",
- "delivery_attempts": 1,
- "renewals": 1,
- "trial_ends_at": "2021-01-01 00:00:00",
- "max_renewals": 1,
- "data": {
- "key": "value"
}, - "currency": "USD",
- "suspend_reason": "Service suspended"
}Returns service data and result
| id required | string service id or uuid |
{- "customer_id": 123,
- "uuid": "550e8400-e29b-41d4-a716-446655440000",
- "name": "Service name",
- "type": "proxmox",
- "billing": "monthly",
- "server_id": 1,
- "product_id": 1,
- "invoice_id": 123,
- "status": "active",
- "expires_at": "2021-01-01 00:00:00",
- "suspended_at": "2021-01-01 00:00:00",
- "cancelled_at": "2021-01-01 00:00:00",
- "cancelled_reason": "Service cancelled",
- "notes": "Service notes",
- "delivery_errors": "Delivery errors",
- "delivery_attempts": 1,
- "renewals": 1,
- "trial_ends_at": "2021-01-01 00:00:00",
- "max_renewals": 1,
- "data": {
- "key": "value"
}, - "currency": "USD",
- "suspend_reason": "Service suspended"
}| email required | string <email> |
| password | string or null <password> |
| firstname required | string <= 255 characters |
| lastname required | string <= 255 characters |
| address required | string <= 255 characters |
| address2 | string or null <= 255 characters |
| city required | string <= 255 characters |
| zipcode required | string <= 255 characters |
| phone | string or null <= 15 characters |
| region required | string <= 255 characters |
| verified | boolean or null |
| balance | number <float> |
| locale required | string |
| country required | string |
| confirmed | boolean or null |
| company_name | string or null <= 255 characters |
| billing_details | string or null <= 255 characters |
{- "password": "MyS3cretPwd!",
- "firstname": "John",
- "lastname": "Doe",
- "address": "123 Rue Principale",
- "address2": "Appartement 4B",
- "city": "Paris",
- "zipcode": "75000",
- "phone": "+33600000000",
- "region": "Île-de-France",
- "verified": true,
- "balance": 99.99,
- "locale": "fr",
- "country": "FR",
- "confirmed": true,
- "company_name": "Doe Enterprises",
- "billing_details": "Billing details here"
}| id required | integer |
string <email> | |
| password | string or null <password> |
| firstname | string <= 50 characters |
| lastname | string <= 50 characters |
| address | string <= 250 characters |
| address2 | string or null <= 250 characters |
| city | string <= 250 characters |
| zipcode | string <= 255 characters |
| phone | string or null <= 255 characters |
| region | string <= 250 characters |
| verified | boolean or null |
| balance | number <float> |
| country | string <= 255 characters |
| locale | string <= 255 characters |
| company_name | string or null <= 255 characters |
| billing_details | string or null <= 255 characters |
{- "password": "MyN3wS3cret!",
- "firstname": "John",
- "lastname": "Doe",
- "address": "456 Avenue République",
- "address2": "Bâtiment B",
- "city": "Lyon",
- "zipcode": "69000",
- "phone": "+33700000000",
- "region": "Auvergne-Rhône-Alpes",
- "verified": false,
- "balance": 250.5,
- "country": "FR",
- "locale": "fr",
- "company_name": "Doe Industries",
- "billing_details": "Details de facturation ici"
}| id required | integer |
| action required | string Enum: "suspend" "reactivate" "ban" "disable2FA" Action name |
| reason | string |
| notify | boolean |
| force | boolean |
{- "reason": "Violation of terms",
- "notify": true,
- "force": false
}| page | integer Default: 1 Page number |
| per_page | integer Default: 10 Number of items per page |
| sort | string Default: "created_at" Sort order |
| filter | string Filter invoices |
| include | string Default: "customer,items" Related resources to include |
[- {
- "id": 1001,
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "customer_id": 5,
- "billing_address": "",
- "due_date": "2024-05-15T00:00:00Z",
- "total": 99.99,
- "subtotal": 83.33,
- "tax": 16.66,
- "setupfees": 10,
- "currency": "EUR",
- "status": "pending",
- "external_id": "ext-123456",
- "notes": "Payment pending confirmation.",
- "paymethod": "stripe",
- "fees": 2.5,
- "invoice_number": "CTX-2024-05-0001",
- "paid_at": "2024-05-10T08:00:00Z",
- "payment_method_id": "pm_1J2Y3Z4A5B6C7D8E9F0G",
- "balance": 0,
- "created_at": "2024-05-01T12:00:00Z",
- "updated_at": "2024-05-10T09:00:00Z",
- "items": [
- {
- "id": 3001,
- "invoice_id": 1001,
- "name": "Web Hosting - Premium",
- "description": "Includes 10GB of storage and SSL certificate",
- "quantity": 1,
- "unit_price_ht": 50,
- "unit_setup_ht": 10,
- "unit_price_ttc": 72,
- "unit_setup_ttc": 12,
- "type": "service",
- "related_id": 5,
- "delivered_at": "2024-05-10T09:00:00Z",
- "cancelled_at": null,
- "refunded_at": null,
- "data": { },
- "discount": { },
- "parent_id": null
}
], - "customer": {
- "email": "string",
- "password": "string",
- "firstname": "string",
- "lastname": "string",
- "phone": "string",
- "address": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "locale": "string",
- "region": "string",
- "zipcode": "string",
- "email_verified_at": "2019-08-24T14:15:22Z",
- "is_confirmed": true,
- "is_deleted": true,
- "dark_mode": true,
- "last_login": "2019-08-24T14:15:22Z",
- "last_ip": "string",
- "company_name": "string",
- "billing_details": "string",
- "gdpr_compliment": true
}
}
]| customer_id | integer The ID of the customer |
| currency | string The currency of the invoice |
{- "customer_id": 0,
- "currency": "string"
}{- "id": 1001,
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "customer_id": 5,
- "billing_address": "",
- "due_date": "2024-05-15T00:00:00Z",
- "total": 99.99,
- "subtotal": 83.33,
- "tax": 16.66,
- "setupfees": 10,
- "currency": "EUR",
- "status": "pending",
- "external_id": "ext-123456",
- "notes": "Payment pending confirmation.",
- "paymethod": "stripe",
- "fees": 2.5,
- "invoice_number": "CTX-2024-05-0001",
- "paid_at": "2024-05-10T08:00:00Z",
- "payment_method_id": "pm_1J2Y3Z4A5B6C7D8E9F0G",
- "balance": 0,
- "created_at": "2024-05-01T12:00:00Z",
- "updated_at": "2024-05-10T09:00:00Z",
- "items": [
- {
- "id": 3001,
- "invoice_id": 1001,
- "name": "Web Hosting - Premium",
- "description": "Includes 10GB of storage and SSL certificate",
- "quantity": 1,
- "unit_price_ht": 50,
- "unit_setup_ht": 10,
- "unit_price_ttc": 72,
- "unit_setup_ttc": 12,
- "type": "service",
- "related_id": 5,
- "delivered_at": "2024-05-10T09:00:00Z",
- "cancelled_at": null,
- "refunded_at": null,
- "data": { },
- "discount": { },
- "parent_id": null
}
], - "customer": {
- "email": "string",
- "password": "string",
- "firstname": "string",
- "lastname": "string",
- "phone": "string",
- "address": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "locale": "string",
- "region": "string",
- "zipcode": "string",
- "email_verified_at": "2019-08-24T14:15:22Z",
- "is_confirmed": true,
- "is_deleted": true,
- "dark_mode": true,
- "last_login": "2019-08-24T14:15:22Z",
- "last_ip": "string",
- "company_name": "string",
- "billing_details": "string",
- "gdpr_compliment": true
}
}| invoice required | string ID or UUID of the invoice |
{- "id": 1001,
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "customer_id": 5,
- "billing_address": "",
- "due_date": "2024-05-15T00:00:00Z",
- "total": 99.99,
- "subtotal": 83.33,
- "tax": 16.66,
- "setupfees": 10,
- "currency": "EUR",
- "status": "pending",
- "external_id": "ext-123456",
- "notes": "Payment pending confirmation.",
- "paymethod": "stripe",
- "fees": 2.5,
- "invoice_number": "CTX-2024-05-0001",
- "paid_at": "2024-05-10T08:00:00Z",
- "payment_method_id": "pm_1J2Y3Z4A5B6C7D8E9F0G",
- "balance": 0,
- "created_at": "2024-05-01T12:00:00Z",
- "updated_at": "2024-05-10T09:00:00Z",
- "items": [
- {
- "id": 3001,
- "invoice_id": 1001,
- "name": "Web Hosting - Premium",
- "description": "Includes 10GB of storage and SSL certificate",
- "quantity": 1,
- "unit_price_ht": 50,
- "unit_setup_ht": 10,
- "unit_price_ttc": 72,
- "unit_setup_ttc": 12,
- "type": "service",
- "related_id": 5,
- "delivered_at": "2024-05-10T09:00:00Z",
- "cancelled_at": null,
- "refunded_at": null,
- "data": { },
- "discount": { },
- "parent_id": null
}
], - "customer": {
- "email": "string",
- "password": "string",
- "firstname": "string",
- "lastname": "string",
- "phone": "string",
- "address": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "locale": "string",
- "region": "string",
- "zipcode": "string",
- "email_verified_at": "2019-08-24T14:15:22Z",
- "is_confirmed": true,
- "is_deleted": true,
- "dark_mode": true,
- "last_login": "2019-08-24T14:15:22Z",
- "last_ip": "string",
- "company_name": "string",
- "billing_details": "string",
- "gdpr_compliment": true
}
}| status | string Enum: "draft" "sent" "paid" "cancelled" The status of the invoice |
| notes | string Additional notes for the invoice |
| paymethod | string The payment method used for the invoice |
| fees | number <float> Any additional fees for the invoice |
| tax | number <float> The tax amount for the invoice |
| currency | string The currency of the invoice |
| due_date | string <date> The due date for the invoice |
| paid_at | string <date> The date the invoice was paid |
| balance | number <float> The remaining balance for the invoice |
| payment_method_id | integer The ID of the payment method used |
| billing_address | Array of strings The billing address for the invoice |
| external_id | string An external ID for the invoice |
{- "status": "draft",
- "notes": "string",
- "paymethod": "string",
- "fees": 0.1,
- "tax": 0.1,
- "currency": "string",
- "due_date": "2019-08-24",
- "paid_at": "2019-08-24",
- "balance": 0.1,
- "payment_method_id": 0,
- "billing_address": [
- "string"
], - "external_id": "string"
}{- "id": 1001,
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "customer_id": 5,
- "billing_address": "",
- "due_date": "2024-05-15T00:00:00Z",
- "total": 99.99,
- "subtotal": 83.33,
- "tax": 16.66,
- "setupfees": 10,
- "currency": "EUR",
- "status": "pending",
- "external_id": "ext-123456",
- "notes": "Payment pending confirmation.",
- "paymethod": "stripe",
- "fees": 2.5,
- "invoice_number": "CTX-2024-05-0001",
- "paid_at": "2024-05-10T08:00:00Z",
- "payment_method_id": "pm_1J2Y3Z4A5B6C7D8E9F0G",
- "balance": 0,
- "created_at": "2024-05-01T12:00:00Z",
- "updated_at": "2024-05-10T09:00:00Z",
- "items": [
- {
- "id": 3001,
- "invoice_id": 1001,
- "name": "Web Hosting - Premium",
- "description": "Includes 10GB of storage and SSL certificate",
- "quantity": 1,
- "unit_price_ht": 50,
- "unit_setup_ht": 10,
- "unit_price_ttc": 72,
- "unit_setup_ttc": 12,
- "type": "service",
- "related_id": 5,
- "delivered_at": "2024-05-10T09:00:00Z",
- "cancelled_at": null,
- "refunded_at": null,
- "data": { },
- "discount": { },
- "parent_id": null
}
], - "customer": {
- "email": "string",
- "password": "string",
- "firstname": "string",
- "lastname": "string",
- "phone": "string",
- "address": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "locale": "string",
- "region": "string",
- "zipcode": "string",
- "email_verified_at": "2019-08-24T14:15:22Z",
- "is_confirmed": true,
- "is_deleted": true,
- "dark_mode": true,
- "last_login": "2019-08-24T14:15:22Z",
- "last_ip": "string",
- "company_name": "string",
- "billing_details": "string",
- "gdpr_compliment": true
}
}| invoice required | string ID or UUID of the invoice |
{- "id": 1001,
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "customer_id": 5,
- "billing_address": "",
- "due_date": "2024-05-15T00:00:00Z",
- "total": 99.99,
- "subtotal": 83.33,
- "tax": 16.66,
- "setupfees": 10,
- "currency": "EUR",
- "status": "pending",
- "external_id": "ext-123456",
- "notes": "Payment pending confirmation.",
- "paymethod": "stripe",
- "fees": 2.5,
- "invoice_number": "CTX-2024-05-0001",
- "paid_at": "2024-05-10T08:00:00Z",
- "payment_method_id": "pm_1J2Y3Z4A5B6C7D8E9F0G",
- "balance": 0,
- "created_at": "2024-05-01T12:00:00Z",
- "updated_at": "2024-05-10T09:00:00Z",
- "items": [
- {
- "id": 3001,
- "invoice_id": 1001,
- "name": "Web Hosting - Premium",
- "description": "Includes 10GB of storage and SSL certificate",
- "quantity": 1,
- "unit_price_ht": 50,
- "unit_setup_ht": 10,
- "unit_price_ttc": 72,
- "unit_setup_ttc": 12,
- "type": "service",
- "related_id": 5,
- "delivered_at": "2024-05-10T09:00:00Z",
- "cancelled_at": null,
- "refunded_at": null,
- "data": { },
- "discount": { },
- "parent_id": null
}
], - "customer": {
- "email": "string",
- "password": "string",
- "firstname": "string",
- "lastname": "string",
- "phone": "string",
- "address": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "locale": "string",
- "region": "string",
- "zipcode": "string",
- "email_verified_at": "2019-08-24T14:15:22Z",
- "is_confirmed": true,
- "is_deleted": true,
- "dark_mode": true,
- "last_login": "2019-08-24T14:15:22Z",
- "last_ip": "string",
- "company_name": "string",
- "billing_details": "string",
- "gdpr_compliment": true
}
}| invoice required | string ID or UUID of the invoice |
{- "id": 1001,
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "customer_id": 5,
- "billing_address": "",
- "due_date": "2024-05-15T00:00:00Z",
- "total": 99.99,
- "subtotal": 83.33,
- "tax": 16.66,
- "setupfees": 10,
- "currency": "EUR",
- "status": "pending",
- "external_id": "ext-123456",
- "notes": "Payment pending confirmation.",
- "paymethod": "stripe",
- "fees": 2.5,
- "invoice_number": "CTX-2024-05-0001",
- "paid_at": "2024-05-10T08:00:00Z",
- "payment_method_id": "pm_1J2Y3Z4A5B6C7D8E9F0G",
- "balance": 0,
- "created_at": "2024-05-01T12:00:00Z",
- "updated_at": "2024-05-10T09:00:00Z",
- "items": [
- {
- "id": 3001,
- "invoice_id": 1001,
- "name": "Web Hosting - Premium",
- "description": "Includes 10GB of storage and SSL certificate",
- "quantity": 1,
- "unit_price_ht": 50,
- "unit_setup_ht": 10,
- "unit_price_ttc": 72,
- "unit_setup_ttc": 12,
- "type": "service",
- "related_id": 5,
- "delivered_at": "2024-05-10T09:00:00Z",
- "cancelled_at": null,
- "refunded_at": null,
- "data": { },
- "discount": { },
- "parent_id": null
}
], - "customer": {
- "email": "string",
- "password": "string",
- "firstname": "string",
- "lastname": "string",
- "phone": "string",
- "address": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "locale": "string",
- "region": "string",
- "zipcode": "string",
- "email_verified_at": "2019-08-24T14:15:22Z",
- "is_confirmed": true,
- "is_deleted": true,
- "dark_mode": true,
- "last_login": "2019-08-24T14:15:22Z",
- "last_ip": "string",
- "company_name": "string",
- "billing_details": "string",
- "gdpr_compliment": true
}
}| invoice required | string ID or UUID of the invoice |
{- "id": 1001,
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "customer_id": 5,
- "billing_address": "",
- "due_date": "2024-05-15T00:00:00Z",
- "total": 99.99,
- "subtotal": 83.33,
- "tax": 16.66,
- "setupfees": 10,
- "currency": "EUR",
- "status": "pending",
- "external_id": "ext-123456",
- "notes": "Payment pending confirmation.",
- "paymethod": "stripe",
- "fees": 2.5,
- "invoice_number": "CTX-2024-05-0001",
- "paid_at": "2024-05-10T08:00:00Z",
- "payment_method_id": "pm_1J2Y3Z4A5B6C7D8E9F0G",
- "balance": 0,
- "created_at": "2024-05-01T12:00:00Z",
- "updated_at": "2024-05-10T09:00:00Z",
- "items": [
- {
- "id": 3001,
- "invoice_id": 1001,
- "name": "Web Hosting - Premium",
- "description": "Includes 10GB of storage and SSL certificate",
- "quantity": 1,
- "unit_price_ht": 50,
- "unit_setup_ht": 10,
- "unit_price_ttc": 72,
- "unit_setup_ttc": 12,
- "type": "service",
- "related_id": 5,
- "delivered_at": "2024-05-10T09:00:00Z",
- "cancelled_at": null,
- "refunded_at": null,
- "data": { },
- "discount": { },
- "parent_id": null
}
], - "customer": {
- "email": "string",
- "password": "string",
- "firstname": "string",
- "lastname": "string",
- "phone": "string",
- "address": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "locale": "string",
- "region": "string",
- "zipcode": "string",
- "email_verified_at": "2019-08-24T14:15:22Z",
- "is_confirmed": true,
- "is_deleted": true,
- "dark_mode": true,
- "last_login": "2019-08-24T14:15:22Z",
- "last_ip": "string",
- "company_name": "string",
- "billing_details": "string",
- "gdpr_compliment": true
}
}| invoice required | string ID or UUID of the invoice |
{- "id": 1001,
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "customer_id": 5,
- "billing_address": "",
- "due_date": "2024-05-15T00:00:00Z",
- "total": 99.99,
- "subtotal": 83.33,
- "tax": 16.66,
- "setupfees": 10,
- "currency": "EUR",
- "status": "pending",
- "external_id": "ext-123456",
- "notes": "Payment pending confirmation.",
- "paymethod": "stripe",
- "fees": 2.5,
- "invoice_number": "CTX-2024-05-0001",
- "paid_at": "2024-05-10T08:00:00Z",
- "payment_method_id": "pm_1J2Y3Z4A5B6C7D8E9F0G",
- "balance": 0,
- "created_at": "2024-05-01T12:00:00Z",
- "updated_at": "2024-05-10T09:00:00Z",
- "items": [
- {
- "id": 3001,
- "invoice_id": 1001,
- "name": "Web Hosting - Premium",
- "description": "Includes 10GB of storage and SSL certificate",
- "quantity": 1,
- "unit_price_ht": 50,
- "unit_setup_ht": 10,
- "unit_price_ttc": 72,
- "unit_setup_ttc": 12,
- "type": "service",
- "related_id": 5,
- "delivered_at": "2024-05-10T09:00:00Z",
- "cancelled_at": null,
- "refunded_at": null,
- "data": { },
- "discount": { },
- "parent_id": null
}
], - "customer": {
- "email": "string",
- "password": "string",
- "firstname": "string",
- "lastname": "string",
- "phone": "string",
- "address": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "locale": "string",
- "region": "string",
- "zipcode": "string",
- "email_verified_at": "2019-08-24T14:15:22Z",
- "is_confirmed": true,
- "is_deleted": true,
- "dark_mode": true,
- "last_login": "2019-08-24T14:15:22Z",
- "last_ip": "string",
- "company_name": "string",
- "billing_details": "string",
- "gdpr_compliment": true
}
}| invoice required | string ID or UUID of the invoice |
{- "id": 1001,
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "customer_id": 5,
- "billing_address": "",
- "due_date": "2024-05-15T00:00:00Z",
- "total": 99.99,
- "subtotal": 83.33,
- "tax": 16.66,
- "setupfees": 10,
- "currency": "EUR",
- "status": "pending",
- "external_id": "ext-123456",
- "notes": "Payment pending confirmation.",
- "paymethod": "stripe",
- "fees": 2.5,
- "invoice_number": "CTX-2024-05-0001",
- "paid_at": "2024-05-10T08:00:00Z",
- "payment_method_id": "pm_1J2Y3Z4A5B6C7D8E9F0G",
- "balance": 0,
- "created_at": "2024-05-01T12:00:00Z",
- "updated_at": "2024-05-10T09:00:00Z",
- "items": [
- {
- "id": 3001,
- "invoice_id": 1001,
- "name": "Web Hosting - Premium",
- "description": "Includes 10GB of storage and SSL certificate",
- "quantity": 1,
- "unit_price_ht": 50,
- "unit_setup_ht": 10,
- "unit_price_ttc": 72,
- "unit_setup_ttc": 12,
- "type": "service",
- "related_id": 5,
- "delivered_at": "2024-05-10T09:00:00Z",
- "cancelled_at": null,
- "refunded_at": null,
- "data": { },
- "discount": { },
- "parent_id": null
}
], - "customer": {
- "email": "string",
- "password": "string",
- "firstname": "string",
- "lastname": "string",
- "phone": "string",
- "address": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "locale": "string",
- "region": "string",
- "zipcode": "string",
- "email_verified_at": "2019-08-24T14:15:22Z",
- "is_confirmed": true,
- "is_deleted": true,
- "dark_mode": true,
- "last_login": "2019-08-24T14:15:22Z",
- "last_ip": "string",
- "company_name": "string",
- "billing_details": "string",
- "gdpr_compliment": true
}
}| page | integer Default: 1 Page number |
| per_page | integer Default: 10 Number of items per page |
| sort | string Default: "created_at" Sort order |
| filter | string Filter departments |
| include | string Default: "tickets" Related resources to include |
[- {
- "id": 1,
- "name": "Technical Support",
- "description": "Handles all technical issues related to services.",
- "icon": "bi bi-question-circle",
- "staff_subscribers": [
- 2,
- 5,
- 9
], - "created_at": "2024-03-01T10:00:00Z",
- "updated_at": "2024-04-01T15:30:00Z",
- "deleted_at": null,
- "tickets": [
- {
- "id": 101,
- "subject": "Problème de facturation",
- "priority": "medium",
- "status": "open",
- "department_id": 3,
- "customer_id": 5,
- "assigned_to": 12,
- "staff_subscribers": [
- 1,
- 2,
- 3
], - "closed_at": "2019-08-24T14:15:22Z",
- "close_reason": "Demande résolue",
- "closed_by": "admin",
- "closed_by_id": 2,
- "related_type": "service",
- "related_id": 41,
- "created_at": "2019-08-24T14:15:22Z",
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "updated_at": "2019-08-24T14:15:22Z",
- "customer": {
- "email": "string",
- "password": "string",
- "firstname": "string",
- "lastname": "string",
- "phone": "string",
- "address": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "locale": "string",
- "region": "string",
- "zipcode": "string",
- "email_verified_at": "2019-08-24T14:15:22Z",
- "is_confirmed": true,
- "is_deleted": true,
- "dark_mode": true,
- "last_login": "2019-08-24T14:15:22Z",
- "last_ip": "string",
- "company_name": "string",
- "billing_details": "string",
- "gdpr_compliment": true
}, - "assignedTo": {
- "id": 1,
- "username": "adminmaster",
- "firstname": "John",
- "lastname": "Doe",
- "email_verified_at": "2024-03-15T10:45:00Z",
- "last_login": "2024-04-12T09:00:00Z",
- "last_login_ip": "192.168.1.10",
- "signature": "Best regards,\\nThe Admin Team",
- "dark_mode": false,
- "expires_at": "2025-01-01T00:00:00Z",
- "locale": "en_US",
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "role": {
- "id": 1,
- "name": "Administrator",
- "level": 100,
- "is_admin": true,
- "is_default": false,
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "permissions": [
- {
- "id": 10,
- "name": "admin.manage_settings",
- "label": "Manage settings",
- "group": "Settings",
- "created_at": "2024-01-01T10:00:00Z",
- "updated_at": "2024-04-01T12:30:00Z"
}
]
}
}, - "department": { },
- "attachments": [
- {
- "id": 102,
- "filename": "screenshot.png",
- "path": "helpdesk/attachments/1234/8732_screenshot.png",
- "mime": "image/png",
- "size": 204800,
- "ticket_id": 12,
- "message_id": 87,
- "customer_id": 5,
- "admin_id": 2,
- "created_at": "2024-04-14T10:00:00Z",
- "updated_at": "2024-04-14T10:05:00Z",
- "deleted_at": null
}
], - "messages": [
- {
- "id": 12,
- "ticket_id": 101,
- "customer_id": 5,
- "admin_id": 2,
- "message": "Hello i have problem.",
- "read_at": "2024-04-13T15:30:00Z",
- "created_at": "2024-04-12T10:00:00Z",
- "updated_at": "2024-04-12T10:15:00Z",
- "deleted_at": null,
- "customer": {
- "email": "string",
- "password": "string",
- "firstname": "string",
- "lastname": "string",
- "phone": "string",
- "address": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "locale": "string",
- "region": "string",
- "zipcode": "string",
- "email_verified_at": "2019-08-24T14:15:22Z",
- "is_confirmed": true,
- "is_deleted": true,
- "dark_mode": true,
- "last_login": "2019-08-24T14:15:22Z",
- "last_ip": "string",
- "company_name": "string",
- "billing_details": "string",
- "gdpr_compliment": true
}, - "admin": {
- "id": 1,
- "username": "adminmaster",
- "firstname": "John",
- "lastname": "Doe",
- "email_verified_at": "2024-03-15T10:45:00Z",
- "last_login": "2024-04-12T09:00:00Z",
- "last_login_ip": "192.168.1.10",
- "signature": "Best regards,\\nThe Admin Team",
- "dark_mode": false,
- "expires_at": "2025-01-01T00:00:00Z",
- "locale": "en_US",
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "role": {
- "id": 1,
- "name": "Administrator",
- "level": 100,
- "is_admin": true,
- "is_default": false,
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "permissions": [
- {
- "id": null,
- "name": null,
- "label": null,
- "group": null,
- "created_at": null,
- "updated_at": null
}
]
}
}
}
], - "comments": [
- {
- "id": 14,
- "ticket_id": 101,
- "admin_id": 2,
- "comment": "This is an internal comment.",
- "created_at": "2024-04-14T11:00:00Z",
- "updated_at": "2024-04-14T12:00:00Z",
- "staff": {
- "id": 1,
- "username": "adminmaster",
- "firstname": "John",
- "lastname": "Doe",
- "email_verified_at": "2024-03-15T10:45:00Z",
- "last_login": "2024-04-12T09:00:00Z",
- "last_login_ip": "192.168.1.10",
- "signature": "Best regards,\\nThe Admin Team",
- "dark_mode": false,
- "expires_at": "2025-01-01T00:00:00Z",
- "locale": "en_US",
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "role": {
- "id": 1,
- "name": "Administrator",
- "level": 100,
- "is_admin": true,
- "is_default": false,
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "permissions": [
- {
- "id": null,
- "name": null,
- "label": null,
- "group": null,
- "created_at": null,
- "updated_at": null
}
]
}
}
}
]
}
]
}
]| name required | string |
| description required | string |
| icon required | string |
{- "name": "Technical Support",
- "description": "Handles all technical issues",
- "icon": "bi bi-question-circle"
}{- "id": 1,
- "name": "Technical Support",
- "description": "Handles all technical issues related to services.",
- "icon": "bi bi-question-circle",
- "staff_subscribers": [
- 2,
- 5,
- 9
], - "created_at": "2024-03-01T10:00:00Z",
- "updated_at": "2024-04-01T15:30:00Z",
- "deleted_at": null,
- "tickets": [
- {
- "id": 101,
- "subject": "Problème de facturation",
- "priority": "medium",
- "status": "open",
- "department_id": 3,
- "customer_id": 5,
- "assigned_to": 12,
- "staff_subscribers": [
- 1,
- 2,
- 3
], - "closed_at": "2019-08-24T14:15:22Z",
- "close_reason": "Demande résolue",
- "closed_by": "admin",
- "closed_by_id": 2,
- "related_type": "service",
- "related_id": 41,
- "created_at": "2019-08-24T14:15:22Z",
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "updated_at": "2019-08-24T14:15:22Z",
- "customer": {
- "email": "string",
- "password": "string",
- "firstname": "string",
- "lastname": "string",
- "phone": "string",
- "address": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "locale": "string",
- "region": "string",
- "zipcode": "string",
- "email_verified_at": "2019-08-24T14:15:22Z",
- "is_confirmed": true,
- "is_deleted": true,
- "dark_mode": true,
- "last_login": "2019-08-24T14:15:22Z",
- "last_ip": "string",
- "company_name": "string",
- "billing_details": "string",
- "gdpr_compliment": true
}, - "assignedTo": {
- "id": 1,
- "username": "adminmaster",
- "firstname": "John",
- "lastname": "Doe",
- "email_verified_at": "2024-03-15T10:45:00Z",
- "last_login": "2024-04-12T09:00:00Z",
- "last_login_ip": "192.168.1.10",
- "signature": "Best regards,\\nThe Admin Team",
- "dark_mode": false,
- "expires_at": "2025-01-01T00:00:00Z",
- "locale": "en_US",
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "role": {
- "id": 1,
- "name": "Administrator",
- "level": 100,
- "is_admin": true,
- "is_default": false,
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "permissions": [
- {
- "id": 10,
- "name": "admin.manage_settings",
- "label": "Manage settings",
- "group": "Settings",
- "created_at": "2024-01-01T10:00:00Z",
- "updated_at": "2024-04-01T12:30:00Z"
}
]
}
}, - "department": { },
- "attachments": [
- {
- "id": 102,
- "filename": "screenshot.png",
- "path": "helpdesk/attachments/1234/8732_screenshot.png",
- "mime": "image/png",
- "size": 204800,
- "ticket_id": 12,
- "message_id": 87,
- "customer_id": 5,
- "admin_id": 2,
- "created_at": "2024-04-14T10:00:00Z",
- "updated_at": "2024-04-14T10:05:00Z",
- "deleted_at": null
}
], - "messages": [
- {
- "id": 12,
- "ticket_id": 101,
- "customer_id": 5,
- "admin_id": 2,
- "message": "Hello i have problem.",
- "read_at": "2024-04-13T15:30:00Z",
- "created_at": "2024-04-12T10:00:00Z",
- "updated_at": "2024-04-12T10:15:00Z",
- "deleted_at": null,
- "customer": {
- "email": "string",
- "password": "string",
- "firstname": "string",
- "lastname": "string",
- "phone": "string",
- "address": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "locale": "string",
- "region": "string",
- "zipcode": "string",
- "email_verified_at": "2019-08-24T14:15:22Z",
- "is_confirmed": true,
- "is_deleted": true,
- "dark_mode": true,
- "last_login": "2019-08-24T14:15:22Z",
- "last_ip": "string",
- "company_name": "string",
- "billing_details": "string",
- "gdpr_compliment": true
}, - "admin": {
- "id": 1,
- "username": "adminmaster",
- "firstname": "John",
- "lastname": "Doe",
- "email_verified_at": "2024-03-15T10:45:00Z",
- "last_login": "2024-04-12T09:00:00Z",
- "last_login_ip": "192.168.1.10",
- "signature": "Best regards,\\nThe Admin Team",
- "dark_mode": false,
- "expires_at": "2025-01-01T00:00:00Z",
- "locale": "en_US",
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "role": {
- "id": 1,
- "name": "Administrator",
- "level": 100,
- "is_admin": true,
- "is_default": false,
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "permissions": [
- {
- "id": 10,
- "name": "admin.manage_settings",
- "label": "Manage settings",
- "group": "Settings",
- "created_at": "2024-01-01T10:00:00Z",
- "updated_at": "2024-04-01T12:30:00Z"
}
]
}
}
}
], - "comments": [
- {
- "id": 14,
- "ticket_id": 101,
- "admin_id": 2,
- "comment": "This is an internal comment.",
- "created_at": "2024-04-14T11:00:00Z",
- "updated_at": "2024-04-14T12:00:00Z",
- "staff": {
- "id": 1,
- "username": "adminmaster",
- "firstname": "John",
- "lastname": "Doe",
- "email_verified_at": "2024-03-15T10:45:00Z",
- "last_login": "2024-04-12T09:00:00Z",
- "last_login_ip": "192.168.1.10",
- "signature": "Best regards,\\nThe Admin Team",
- "dark_mode": false,
- "expires_at": "2025-01-01T00:00:00Z",
- "locale": "en_US",
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "role": {
- "id": 1,
- "name": "Administrator",
- "level": 100,
- "is_admin": true,
- "is_default": false,
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "permissions": [
- {
- "id": 10,
- "name": "admin.manage_settings",
- "label": "Manage settings",
- "group": "Settings",
- "created_at": "2024-01-01T10:00:00Z",
- "updated_at": "2024-04-01T12:30:00Z"
}
]
}
}
}
]
}
]
}| department required | integer ID of the department |
{- "id": 1,
- "name": "Technical Support",
- "description": "Handles all technical issues related to services.",
- "icon": "bi bi-question-circle",
- "staff_subscribers": [
- 2,
- 5,
- 9
], - "created_at": "2024-03-01T10:00:00Z",
- "updated_at": "2024-04-01T15:30:00Z",
- "deleted_at": null,
- "tickets": [
- {
- "id": 101,
- "subject": "Problème de facturation",
- "priority": "medium",
- "status": "open",
- "department_id": 3,
- "customer_id": 5,
- "assigned_to": 12,
- "staff_subscribers": [
- 1,
- 2,
- 3
], - "closed_at": "2019-08-24T14:15:22Z",
- "close_reason": "Demande résolue",
- "closed_by": "admin",
- "closed_by_id": 2,
- "related_type": "service",
- "related_id": 41,
- "created_at": "2019-08-24T14:15:22Z",
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "updated_at": "2019-08-24T14:15:22Z",
- "customer": {
- "email": "string",
- "password": "string",
- "firstname": "string",
- "lastname": "string",
- "phone": "string",
- "address": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "locale": "string",
- "region": "string",
- "zipcode": "string",
- "email_verified_at": "2019-08-24T14:15:22Z",
- "is_confirmed": true,
- "is_deleted": true,
- "dark_mode": true,
- "last_login": "2019-08-24T14:15:22Z",
- "last_ip": "string",
- "company_name": "string",
- "billing_details": "string",
- "gdpr_compliment": true
}, - "assignedTo": {
- "id": 1,
- "username": "adminmaster",
- "firstname": "John",
- "lastname": "Doe",
- "email_verified_at": "2024-03-15T10:45:00Z",
- "last_login": "2024-04-12T09:00:00Z",
- "last_login_ip": "192.168.1.10",
- "signature": "Best regards,\\nThe Admin Team",
- "dark_mode": false,
- "expires_at": "2025-01-01T00:00:00Z",
- "locale": "en_US",
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "role": {
- "id": 1,
- "name": "Administrator",
- "level": 100,
- "is_admin": true,
- "is_default": false,
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "permissions": [
- {
- "id": 10,
- "name": "admin.manage_settings",
- "label": "Manage settings",
- "group": "Settings",
- "created_at": "2024-01-01T10:00:00Z",
- "updated_at": "2024-04-01T12:30:00Z"
}
]
}
}, - "department": { },
- "attachments": [
- {
- "id": 102,
- "filename": "screenshot.png",
- "path": "helpdesk/attachments/1234/8732_screenshot.png",
- "mime": "image/png",
- "size": 204800,
- "ticket_id": 12,
- "message_id": 87,
- "customer_id": 5,
- "admin_id": 2,
- "created_at": "2024-04-14T10:00:00Z",
- "updated_at": "2024-04-14T10:05:00Z",
- "deleted_at": null
}
], - "messages": [
- {
- "id": 12,
- "ticket_id": 101,
- "customer_id": 5,
- "admin_id": 2,
- "message": "Hello i have problem.",
- "read_at": "2024-04-13T15:30:00Z",
- "created_at": "2024-04-12T10:00:00Z",
- "updated_at": "2024-04-12T10:15:00Z",
- "deleted_at": null,
- "customer": {
- "email": "string",
- "password": "string",
- "firstname": "string",
- "lastname": "string",
- "phone": "string",
- "address": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "locale": "string",
- "region": "string",
- "zipcode": "string",
- "email_verified_at": "2019-08-24T14:15:22Z",
- "is_confirmed": true,
- "is_deleted": true,
- "dark_mode": true,
- "last_login": "2019-08-24T14:15:22Z",
- "last_ip": "string",
- "company_name": "string",
- "billing_details": "string",
- "gdpr_compliment": true
}, - "admin": {
- "id": 1,
- "username": "adminmaster",
- "firstname": "John",
- "lastname": "Doe",
- "email_verified_at": "2024-03-15T10:45:00Z",
- "last_login": "2024-04-12T09:00:00Z",
- "last_login_ip": "192.168.1.10",
- "signature": "Best regards,\\nThe Admin Team",
- "dark_mode": false,
- "expires_at": "2025-01-01T00:00:00Z",
- "locale": "en_US",
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "role": {
- "id": 1,
- "name": "Administrator",
- "level": 100,
- "is_admin": true,
- "is_default": false,
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "permissions": [
- {
- "id": 10,
- "name": "admin.manage_settings",
- "label": "Manage settings",
- "group": "Settings",
- "created_at": "2024-01-01T10:00:00Z",
- "updated_at": "2024-04-01T12:30:00Z"
}
]
}
}
}
], - "comments": [
- {
- "id": 14,
- "ticket_id": 101,
- "admin_id": 2,
- "comment": "This is an internal comment.",
- "created_at": "2024-04-14T11:00:00Z",
- "updated_at": "2024-04-14T12:00:00Z",
- "staff": {
- "id": 1,
- "username": "adminmaster",
- "firstname": "John",
- "lastname": "Doe",
- "email_verified_at": "2024-03-15T10:45:00Z",
- "last_login": "2024-04-12T09:00:00Z",
- "last_login_ip": "192.168.1.10",
- "signature": "Best regards,\\nThe Admin Team",
- "dark_mode": false,
- "expires_at": "2025-01-01T00:00:00Z",
- "locale": "en_US",
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "role": {
- "id": 1,
- "name": "Administrator",
- "level": 100,
- "is_admin": true,
- "is_default": false,
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "permissions": [
- {
- "id": 10,
- "name": "admin.manage_settings",
- "label": "Manage settings",
- "group": "Settings",
- "created_at": "2024-01-01T10:00:00Z",
- "updated_at": "2024-04-01T12:30:00Z"
}
]
}
}
}
]
}
]
}| department required | integer ID of the department |
| name required | string |
| description required | string |
| icon required | string |
{- "name": "Technical Support",
- "description": "Handles all technical issues",
- "icon": "bi bi-question-circle"
}{- "id": 1,
- "name": "Technical Support",
- "description": "Handles all technical issues related to services.",
- "icon": "bi bi-question-circle",
- "staff_subscribers": [
- 2,
- 5,
- 9
], - "created_at": "2024-03-01T10:00:00Z",
- "updated_at": "2024-04-01T15:30:00Z",
- "deleted_at": null,
- "tickets": [
- {
- "id": 101,
- "subject": "Problème de facturation",
- "priority": "medium",
- "status": "open",
- "department_id": 3,
- "customer_id": 5,
- "assigned_to": 12,
- "staff_subscribers": [
- 1,
- 2,
- 3
], - "closed_at": "2019-08-24T14:15:22Z",
- "close_reason": "Demande résolue",
- "closed_by": "admin",
- "closed_by_id": 2,
- "related_type": "service",
- "related_id": 41,
- "created_at": "2019-08-24T14:15:22Z",
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "updated_at": "2019-08-24T14:15:22Z",
- "customer": {
- "email": "string",
- "password": "string",
- "firstname": "string",
- "lastname": "string",
- "phone": "string",
- "address": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "locale": "string",
- "region": "string",
- "zipcode": "string",
- "email_verified_at": "2019-08-24T14:15:22Z",
- "is_confirmed": true,
- "is_deleted": true,
- "dark_mode": true,
- "last_login": "2019-08-24T14:15:22Z",
- "last_ip": "string",
- "company_name": "string",
- "billing_details": "string",
- "gdpr_compliment": true
}, - "assignedTo": {
- "id": 1,
- "username": "adminmaster",
- "firstname": "John",
- "lastname": "Doe",
- "email_verified_at": "2024-03-15T10:45:00Z",
- "last_login": "2024-04-12T09:00:00Z",
- "last_login_ip": "192.168.1.10",
- "signature": "Best regards,\\nThe Admin Team",
- "dark_mode": false,
- "expires_at": "2025-01-01T00:00:00Z",
- "locale": "en_US",
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "role": {
- "id": 1,
- "name": "Administrator",
- "level": 100,
- "is_admin": true,
- "is_default": false,
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "permissions": [
- {
- "id": 10,
- "name": "admin.manage_settings",
- "label": "Manage settings",
- "group": "Settings",
- "created_at": "2024-01-01T10:00:00Z",
- "updated_at": "2024-04-01T12:30:00Z"
}
]
}
}, - "department": { },
- "attachments": [
- {
- "id": 102,
- "filename": "screenshot.png",
- "path": "helpdesk/attachments/1234/8732_screenshot.png",
- "mime": "image/png",
- "size": 204800,
- "ticket_id": 12,
- "message_id": 87,
- "customer_id": 5,
- "admin_id": 2,
- "created_at": "2024-04-14T10:00:00Z",
- "updated_at": "2024-04-14T10:05:00Z",
- "deleted_at": null
}
], - "messages": [
- {
- "id": 12,
- "ticket_id": 101,
- "customer_id": 5,
- "admin_id": 2,
- "message": "Hello i have problem.",
- "read_at": "2024-04-13T15:30:00Z",
- "created_at": "2024-04-12T10:00:00Z",
- "updated_at": "2024-04-12T10:15:00Z",
- "deleted_at": null,
- "customer": {
- "email": "string",
- "password": "string",
- "firstname": "string",
- "lastname": "string",
- "phone": "string",
- "address": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "locale": "string",
- "region": "string",
- "zipcode": "string",
- "email_verified_at": "2019-08-24T14:15:22Z",
- "is_confirmed": true,
- "is_deleted": true,
- "dark_mode": true,
- "last_login": "2019-08-24T14:15:22Z",
- "last_ip": "string",
- "company_name": "string",
- "billing_details": "string",
- "gdpr_compliment": true
}, - "admin": {
- "id": 1,
- "username": "adminmaster",
- "firstname": "John",
- "lastname": "Doe",
- "email_verified_at": "2024-03-15T10:45:00Z",
- "last_login": "2024-04-12T09:00:00Z",
- "last_login_ip": "192.168.1.10",
- "signature": "Best regards,\\nThe Admin Team",
- "dark_mode": false,
- "expires_at": "2025-01-01T00:00:00Z",
- "locale": "en_US",
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "role": {
- "id": 1,
- "name": "Administrator",
- "level": 100,
- "is_admin": true,
- "is_default": false,
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "permissions": [
- {
- "id": 10,
- "name": "admin.manage_settings",
- "label": "Manage settings",
- "group": "Settings",
- "created_at": "2024-01-01T10:00:00Z",
- "updated_at": "2024-04-01T12:30:00Z"
}
]
}
}
}
], - "comments": [
- {
- "id": 14,
- "ticket_id": 101,
- "admin_id": 2,
- "comment": "This is an internal comment.",
- "created_at": "2024-04-14T11:00:00Z",
- "updated_at": "2024-04-14T12:00:00Z",
- "staff": {
- "id": 1,
- "username": "adminmaster",
- "firstname": "John",
- "lastname": "Doe",
- "email_verified_at": "2024-03-15T10:45:00Z",
- "last_login": "2024-04-12T09:00:00Z",
- "last_login_ip": "192.168.1.10",
- "signature": "Best regards,\\nThe Admin Team",
- "dark_mode": false,
- "expires_at": "2025-01-01T00:00:00Z",
- "locale": "en_US",
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "role": {
- "id": 1,
- "name": "Administrator",
- "level": 100,
- "is_admin": true,
- "is_default": false,
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "permissions": [
- {
- "id": 10,
- "name": "admin.manage_settings",
- "label": "Manage settings",
- "group": "Settings",
- "created_at": "2024-01-01T10:00:00Z",
- "updated_at": "2024-04-01T12:30:00Z"
}
]
}
}
}
]
}
]
}| page | integer Default: 1 Page number |
| per_page | integer Default: 10 Number of items per page |
| sort | string Default: "created_at" Sort order |
| filter[status] | string Filter by status (open, closed, answered) |
| filter[priority] | string Filter by priority (low, medium, high) |
| filter[department_id] | integer Filter by department ID |
| filter[customer_id] | integer Filter by customer ID |
| include | string Default: "customer,department,messages" Related resources to include |
[- {
- "id": 101,
- "subject": "Problème de facturation",
- "priority": "medium",
- "status": "open",
- "department_id": 3,
- "customer_id": 5,
- "assigned_to": 12,
- "staff_subscribers": [
- 1,
- 2,
- 3
], - "closed_at": "2019-08-24T14:15:22Z",
- "close_reason": "Demande résolue",
- "closed_by": "admin",
- "closed_by_id": 2,
- "related_type": "service",
- "related_id": 41,
- "created_at": "2019-08-24T14:15:22Z",
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "updated_at": "2019-08-24T14:15:22Z",
- "customer": {
- "email": "string",
- "password": "string",
- "firstname": "string",
- "lastname": "string",
- "phone": "string",
- "address": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "locale": "string",
- "region": "string",
- "zipcode": "string",
- "email_verified_at": "2019-08-24T14:15:22Z",
- "is_confirmed": true,
- "is_deleted": true,
- "dark_mode": true,
- "last_login": "2019-08-24T14:15:22Z",
- "last_ip": "string",
- "company_name": "string",
- "billing_details": "string",
- "gdpr_compliment": true
}, - "assignedTo": {
- "id": 1,
- "username": "adminmaster",
- "firstname": "John",
- "lastname": "Doe",
- "email_verified_at": "2024-03-15T10:45:00Z",
- "last_login": "2024-04-12T09:00:00Z",
- "last_login_ip": "192.168.1.10",
- "signature": "Best regards,\\nThe Admin Team",
- "dark_mode": false,
- "expires_at": "2025-01-01T00:00:00Z",
- "locale": "en_US",
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "role": {
- "id": 1,
- "name": "Administrator",
- "level": 100,
- "is_admin": true,
- "is_default": false,
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "permissions": [
- {
- "id": 10,
- "name": "admin.manage_settings",
- "label": "Manage settings",
- "group": "Settings",
- "created_at": "2024-01-01T10:00:00Z",
- "updated_at": "2024-04-01T12:30:00Z"
}
]
}
}, - "department": {
- "id": 1,
- "name": "Technical Support",
- "description": "Handles all technical issues related to services.",
- "icon": "bi bi-question-circle",
- "staff_subscribers": [
- 2,
- 5,
- 9
], - "created_at": "2024-03-01T10:00:00Z",
- "updated_at": "2024-04-01T15:30:00Z",
- "deleted_at": null,
- "tickets": [
- { }
]
}, - "attachments": [
- {
- "id": 102,
- "filename": "screenshot.png",
- "path": "helpdesk/attachments/1234/8732_screenshot.png",
- "mime": "image/png",
- "size": 204800,
- "ticket_id": 12,
- "message_id": 87,
- "customer_id": 5,
- "admin_id": 2,
- "created_at": "2024-04-14T10:00:00Z",
- "updated_at": "2024-04-14T10:05:00Z",
- "deleted_at": null
}
], - "messages": [
- {
- "id": 12,
- "ticket_id": 101,
- "customer_id": 5,
- "admin_id": 2,
- "message": "Hello i have problem.",
- "read_at": "2024-04-13T15:30:00Z",
- "created_at": "2024-04-12T10:00:00Z",
- "updated_at": "2024-04-12T10:15:00Z",
- "deleted_at": null,
- "customer": {
- "email": "string",
- "password": "string",
- "firstname": "string",
- "lastname": "string",
- "phone": "string",
- "address": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "locale": "string",
- "region": "string",
- "zipcode": "string",
- "email_verified_at": "2019-08-24T14:15:22Z",
- "is_confirmed": true,
- "is_deleted": true,
- "dark_mode": true,
- "last_login": "2019-08-24T14:15:22Z",
- "last_ip": "string",
- "company_name": "string",
- "billing_details": "string",
- "gdpr_compliment": true
}, - "admin": {
- "id": 1,
- "username": "adminmaster",
- "firstname": "John",
- "lastname": "Doe",
- "email_verified_at": "2024-03-15T10:45:00Z",
- "last_login": "2024-04-12T09:00:00Z",
- "last_login_ip": "192.168.1.10",
- "signature": "Best regards,\\nThe Admin Team",
- "dark_mode": false,
- "expires_at": "2025-01-01T00:00:00Z",
- "locale": "en_US",
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "role": {
- "id": 1,
- "name": "Administrator",
- "level": 100,
- "is_admin": true,
- "is_default": false,
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "permissions": [
- {
- "id": 10,
- "name": "admin.manage_settings",
- "label": "Manage settings",
- "group": "Settings",
- "created_at": "2024-01-01T10:00:00Z",
- "updated_at": "2024-04-01T12:30:00Z"
}
]
}
}
}
], - "comments": [
- {
- "id": 14,
- "ticket_id": 101,
- "admin_id": 2,
- "comment": "This is an internal comment.",
- "created_at": "2024-04-14T11:00:00Z",
- "updated_at": "2024-04-14T12:00:00Z",
- "staff": {
- "id": 1,
- "username": "adminmaster",
- "firstname": "John",
- "lastname": "Doe",
- "email_verified_at": "2024-03-15T10:45:00Z",
- "last_login": "2024-04-12T09:00:00Z",
- "last_login_ip": "192.168.1.10",
- "signature": "Best regards,\\nThe Admin Team",
- "dark_mode": false,
- "expires_at": "2025-01-01T00:00:00Z",
- "locale": "en_US",
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "role": {
- "id": 1,
- "name": "Administrator",
- "level": 100,
- "is_admin": true,
- "is_default": false,
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "permissions": [
- {
- "id": 10,
- "name": "admin.manage_settings",
- "label": "Manage settings",
- "group": "Settings",
- "created_at": "2024-01-01T10:00:00Z",
- "updated_at": "2024-04-01T12:30:00Z"
}
]
}
}
}
]
}
]| department_id required | integer |
| customer_id required | integer |
| subject required | string |
| priority required | string Enum: "low" "medium" "high" |
| content required | string |
| related_type | string or null Enum: "service" "invoice" |
| related_id | integer or null |
{- "department_id": 1,
- "customer_id": 1,
- "subject": "Issue with my service",
- "priority": "medium",
- "content": "I'm having issues with my service...",
- "related_type": "service",
- "related_id": 0
}{- "id": 101,
- "subject": "Problème de facturation",
- "priority": "medium",
- "status": "open",
- "department_id": 3,
- "customer_id": 5,
- "assigned_to": 12,
- "staff_subscribers": [
- 1,
- 2,
- 3
], - "closed_at": "2019-08-24T14:15:22Z",
- "close_reason": "Demande résolue",
- "closed_by": "admin",
- "closed_by_id": 2,
- "related_type": "service",
- "related_id": 41,
- "created_at": "2019-08-24T14:15:22Z",
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "updated_at": "2019-08-24T14:15:22Z",
- "customer": {
- "email": "string",
- "password": "string",
- "firstname": "string",
- "lastname": "string",
- "phone": "string",
- "address": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "locale": "string",
- "region": "string",
- "zipcode": "string",
- "email_verified_at": "2019-08-24T14:15:22Z",
- "is_confirmed": true,
- "is_deleted": true,
- "dark_mode": true,
- "last_login": "2019-08-24T14:15:22Z",
- "last_ip": "string",
- "company_name": "string",
- "billing_details": "string",
- "gdpr_compliment": true
}, - "assignedTo": {
- "id": 1,
- "username": "adminmaster",
- "firstname": "John",
- "lastname": "Doe",
- "email_verified_at": "2024-03-15T10:45:00Z",
- "last_login": "2024-04-12T09:00:00Z",
- "last_login_ip": "192.168.1.10",
- "signature": "Best regards,\\nThe Admin Team",
- "dark_mode": false,
- "expires_at": "2025-01-01T00:00:00Z",
- "locale": "en_US",
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "role": {
- "id": 1,
- "name": "Administrator",
- "level": 100,
- "is_admin": true,
- "is_default": false,
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "permissions": [
- {
- "id": 10,
- "name": "admin.manage_settings",
- "label": "Manage settings",
- "group": "Settings",
- "created_at": "2024-01-01T10:00:00Z",
- "updated_at": "2024-04-01T12:30:00Z"
}
]
}
}, - "department": {
- "id": 1,
- "name": "Technical Support",
- "description": "Handles all technical issues related to services.",
- "icon": "bi bi-question-circle",
- "staff_subscribers": [
- 2,
- 5,
- 9
], - "created_at": "2024-03-01T10:00:00Z",
- "updated_at": "2024-04-01T15:30:00Z",
- "deleted_at": null,
- "tickets": [
- { }
]
}, - "attachments": [
- {
- "id": 102,
- "filename": "screenshot.png",
- "path": "helpdesk/attachments/1234/8732_screenshot.png",
- "mime": "image/png",
- "size": 204800,
- "ticket_id": 12,
- "message_id": 87,
- "customer_id": 5,
- "admin_id": 2,
- "created_at": "2024-04-14T10:00:00Z",
- "updated_at": "2024-04-14T10:05:00Z",
- "deleted_at": null
}
], - "messages": [
- {
- "id": 12,
- "ticket_id": 101,
- "customer_id": 5,
- "admin_id": 2,
- "message": "Hello i have problem.",
- "read_at": "2024-04-13T15:30:00Z",
- "created_at": "2024-04-12T10:00:00Z",
- "updated_at": "2024-04-12T10:15:00Z",
- "deleted_at": null,
- "customer": {
- "email": "string",
- "password": "string",
- "firstname": "string",
- "lastname": "string",
- "phone": "string",
- "address": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "locale": "string",
- "region": "string",
- "zipcode": "string",
- "email_verified_at": "2019-08-24T14:15:22Z",
- "is_confirmed": true,
- "is_deleted": true,
- "dark_mode": true,
- "last_login": "2019-08-24T14:15:22Z",
- "last_ip": "string",
- "company_name": "string",
- "billing_details": "string",
- "gdpr_compliment": true
}, - "admin": {
- "id": 1,
- "username": "adminmaster",
- "firstname": "John",
- "lastname": "Doe",
- "email_verified_at": "2024-03-15T10:45:00Z",
- "last_login": "2024-04-12T09:00:00Z",
- "last_login_ip": "192.168.1.10",
- "signature": "Best regards,\\nThe Admin Team",
- "dark_mode": false,
- "expires_at": "2025-01-01T00:00:00Z",
- "locale": "en_US",
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "role": {
- "id": 1,
- "name": "Administrator",
- "level": 100,
- "is_admin": true,
- "is_default": false,
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "permissions": [
- {
- "id": 10,
- "name": "admin.manage_settings",
- "label": "Manage settings",
- "group": "Settings",
- "created_at": "2024-01-01T10:00:00Z",
- "updated_at": "2024-04-01T12:30:00Z"
}
]
}
}
}
], - "comments": [
- {
- "id": 14,
- "ticket_id": 101,
- "admin_id": 2,
- "comment": "This is an internal comment.",
- "created_at": "2024-04-14T11:00:00Z",
- "updated_at": "2024-04-14T12:00:00Z",
- "staff": {
- "id": 1,
- "username": "adminmaster",
- "firstname": "John",
- "lastname": "Doe",
- "email_verified_at": "2024-03-15T10:45:00Z",
- "last_login": "2024-04-12T09:00:00Z",
- "last_login_ip": "192.168.1.10",
- "signature": "Best regards,\\nThe Admin Team",
- "dark_mode": false,
- "expires_at": "2025-01-01T00:00:00Z",
- "locale": "en_US",
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "role": {
- "id": 1,
- "name": "Administrator",
- "level": 100,
- "is_admin": true,
- "is_default": false,
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "permissions": [
- {
- "id": 10,
- "name": "admin.manage_settings",
- "label": "Manage settings",
- "group": "Settings",
- "created_at": "2024-01-01T10:00:00Z",
- "updated_at": "2024-04-01T12:30:00Z"
}
]
}
}
}
]
}| ticket required | string ID or UUID of the ticket |
{- "id": 101,
- "subject": "Problème de facturation",
- "priority": "medium",
- "status": "open",
- "department_id": 3,
- "customer_id": 5,
- "assigned_to": 12,
- "staff_subscribers": [
- 1,
- 2,
- 3
], - "closed_at": "2019-08-24T14:15:22Z",
- "close_reason": "Demande résolue",
- "closed_by": "admin",
- "closed_by_id": 2,
- "related_type": "service",
- "related_id": 41,
- "created_at": "2019-08-24T14:15:22Z",
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "updated_at": "2019-08-24T14:15:22Z",
- "customer": {
- "email": "string",
- "password": "string",
- "firstname": "string",
- "lastname": "string",
- "phone": "string",
- "address": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "locale": "string",
- "region": "string",
- "zipcode": "string",
- "email_verified_at": "2019-08-24T14:15:22Z",
- "is_confirmed": true,
- "is_deleted": true,
- "dark_mode": true,
- "last_login": "2019-08-24T14:15:22Z",
- "last_ip": "string",
- "company_name": "string",
- "billing_details": "string",
- "gdpr_compliment": true
}, - "assignedTo": {
- "id": 1,
- "username": "adminmaster",
- "firstname": "John",
- "lastname": "Doe",
- "email_verified_at": "2024-03-15T10:45:00Z",
- "last_login": "2024-04-12T09:00:00Z",
- "last_login_ip": "192.168.1.10",
- "signature": "Best regards,\\nThe Admin Team",
- "dark_mode": false,
- "expires_at": "2025-01-01T00:00:00Z",
- "locale": "en_US",
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "role": {
- "id": 1,
- "name": "Administrator",
- "level": 100,
- "is_admin": true,
- "is_default": false,
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "permissions": [
- {
- "id": 10,
- "name": "admin.manage_settings",
- "label": "Manage settings",
- "group": "Settings",
- "created_at": "2024-01-01T10:00:00Z",
- "updated_at": "2024-04-01T12:30:00Z"
}
]
}
}, - "department": {
- "id": 1,
- "name": "Technical Support",
- "description": "Handles all technical issues related to services.",
- "icon": "bi bi-question-circle",
- "staff_subscribers": [
- 2,
- 5,
- 9
], - "created_at": "2024-03-01T10:00:00Z",
- "updated_at": "2024-04-01T15:30:00Z",
- "deleted_at": null,
- "tickets": [
- { }
]
}, - "attachments": [
- {
- "id": 102,
- "filename": "screenshot.png",
- "path": "helpdesk/attachments/1234/8732_screenshot.png",
- "mime": "image/png",
- "size": 204800,
- "ticket_id": 12,
- "message_id": 87,
- "customer_id": 5,
- "admin_id": 2,
- "created_at": "2024-04-14T10:00:00Z",
- "updated_at": "2024-04-14T10:05:00Z",
- "deleted_at": null
}
], - "messages": [
- {
- "id": 12,
- "ticket_id": 101,
- "customer_id": 5,
- "admin_id": 2,
- "message": "Hello i have problem.",
- "read_at": "2024-04-13T15:30:00Z",
- "created_at": "2024-04-12T10:00:00Z",
- "updated_at": "2024-04-12T10:15:00Z",
- "deleted_at": null,
- "customer": {
- "email": "string",
- "password": "string",
- "firstname": "string",
- "lastname": "string",
- "phone": "string",
- "address": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "locale": "string",
- "region": "string",
- "zipcode": "string",
- "email_verified_at": "2019-08-24T14:15:22Z",
- "is_confirmed": true,
- "is_deleted": true,
- "dark_mode": true,
- "last_login": "2019-08-24T14:15:22Z",
- "last_ip": "string",
- "company_name": "string",
- "billing_details": "string",
- "gdpr_compliment": true
}, - "admin": {
- "id": 1,
- "username": "adminmaster",
- "firstname": "John",
- "lastname": "Doe",
- "email_verified_at": "2024-03-15T10:45:00Z",
- "last_login": "2024-04-12T09:00:00Z",
- "last_login_ip": "192.168.1.10",
- "signature": "Best regards,\\nThe Admin Team",
- "dark_mode": false,
- "expires_at": "2025-01-01T00:00:00Z",
- "locale": "en_US",
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "role": {
- "id": 1,
- "name": "Administrator",
- "level": 100,
- "is_admin": true,
- "is_default": false,
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "permissions": [
- {
- "id": 10,
- "name": "admin.manage_settings",
- "label": "Manage settings",
- "group": "Settings",
- "created_at": "2024-01-01T10:00:00Z",
- "updated_at": "2024-04-01T12:30:00Z"
}
]
}
}
}
], - "comments": [
- {
- "id": 14,
- "ticket_id": 101,
- "admin_id": 2,
- "comment": "This is an internal comment.",
- "created_at": "2024-04-14T11:00:00Z",
- "updated_at": "2024-04-14T12:00:00Z",
- "staff": {
- "id": 1,
- "username": "adminmaster",
- "firstname": "John",
- "lastname": "Doe",
- "email_verified_at": "2024-03-15T10:45:00Z",
- "last_login": "2024-04-12T09:00:00Z",
- "last_login_ip": "192.168.1.10",
- "signature": "Best regards,\\nThe Admin Team",
- "dark_mode": false,
- "expires_at": "2025-01-01T00:00:00Z",
- "locale": "en_US",
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "role": {
- "id": 1,
- "name": "Administrator",
- "level": 100,
- "is_admin": true,
- "is_default": false,
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "permissions": [
- {
- "id": 10,
- "name": "admin.manage_settings",
- "label": "Manage settings",
- "group": "Settings",
- "created_at": "2024-01-01T10:00:00Z",
- "updated_at": "2024-04-01T12:30:00Z"
}
]
}
}
}
]
}| ticket required | string ID or UUID of the ticket |
| department_id required | integer |
| subject required | string |
| priority required | string Enum: "low" "medium" "high" |
| assigned_to | integer or null |
| close_reason | string or null |
{- "department_id": 1,
- "subject": "Updated subject",
- "priority": "high",
- "assigned_to": 0,
- "close_reason": "string"
}{- "id": 101,
- "subject": "Problème de facturation",
- "priority": "medium",
- "status": "open",
- "department_id": 3,
- "customer_id": 5,
- "assigned_to": 12,
- "staff_subscribers": [
- 1,
- 2,
- 3
], - "closed_at": "2019-08-24T14:15:22Z",
- "close_reason": "Demande résolue",
- "closed_by": "admin",
- "closed_by_id": 2,
- "related_type": "service",
- "related_id": 41,
- "created_at": "2019-08-24T14:15:22Z",
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "updated_at": "2019-08-24T14:15:22Z",
- "customer": {
- "email": "string",
- "password": "string",
- "firstname": "string",
- "lastname": "string",
- "phone": "string",
- "address": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "locale": "string",
- "region": "string",
- "zipcode": "string",
- "email_verified_at": "2019-08-24T14:15:22Z",
- "is_confirmed": true,
- "is_deleted": true,
- "dark_mode": true,
- "last_login": "2019-08-24T14:15:22Z",
- "last_ip": "string",
- "company_name": "string",
- "billing_details": "string",
- "gdpr_compliment": true
}, - "assignedTo": {
- "id": 1,
- "username": "adminmaster",
- "firstname": "John",
- "lastname": "Doe",
- "email_verified_at": "2024-03-15T10:45:00Z",
- "last_login": "2024-04-12T09:00:00Z",
- "last_login_ip": "192.168.1.10",
- "signature": "Best regards,\\nThe Admin Team",
- "dark_mode": false,
- "expires_at": "2025-01-01T00:00:00Z",
- "locale": "en_US",
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "role": {
- "id": 1,
- "name": "Administrator",
- "level": 100,
- "is_admin": true,
- "is_default": false,
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "permissions": [
- {
- "id": 10,
- "name": "admin.manage_settings",
- "label": "Manage settings",
- "group": "Settings",
- "created_at": "2024-01-01T10:00:00Z",
- "updated_at": "2024-04-01T12:30:00Z"
}
]
}
}, - "department": {
- "id": 1,
- "name": "Technical Support",
- "description": "Handles all technical issues related to services.",
- "icon": "bi bi-question-circle",
- "staff_subscribers": [
- 2,
- 5,
- 9
], - "created_at": "2024-03-01T10:00:00Z",
- "updated_at": "2024-04-01T15:30:00Z",
- "deleted_at": null,
- "tickets": [
- { }
]
}, - "attachments": [
- {
- "id": 102,
- "filename": "screenshot.png",
- "path": "helpdesk/attachments/1234/8732_screenshot.png",
- "mime": "image/png",
- "size": 204800,
- "ticket_id": 12,
- "message_id": 87,
- "customer_id": 5,
- "admin_id": 2,
- "created_at": "2024-04-14T10:00:00Z",
- "updated_at": "2024-04-14T10:05:00Z",
- "deleted_at": null
}
], - "messages": [
- {
- "id": 12,
- "ticket_id": 101,
- "customer_id": 5,
- "admin_id": 2,
- "message": "Hello i have problem.",
- "read_at": "2024-04-13T15:30:00Z",
- "created_at": "2024-04-12T10:00:00Z",
- "updated_at": "2024-04-12T10:15:00Z",
- "deleted_at": null,
- "customer": {
- "email": "string",
- "password": "string",
- "firstname": "string",
- "lastname": "string",
- "phone": "string",
- "address": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "locale": "string",
- "region": "string",
- "zipcode": "string",
- "email_verified_at": "2019-08-24T14:15:22Z",
- "is_confirmed": true,
- "is_deleted": true,
- "dark_mode": true,
- "last_login": "2019-08-24T14:15:22Z",
- "last_ip": "string",
- "company_name": "string",
- "billing_details": "string",
- "gdpr_compliment": true
}, - "admin": {
- "id": 1,
- "username": "adminmaster",
- "firstname": "John",
- "lastname": "Doe",
- "email_verified_at": "2024-03-15T10:45:00Z",
- "last_login": "2024-04-12T09:00:00Z",
- "last_login_ip": "192.168.1.10",
- "signature": "Best regards,\\nThe Admin Team",
- "dark_mode": false,
- "expires_at": "2025-01-01T00:00:00Z",
- "locale": "en_US",
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "role": {
- "id": 1,
- "name": "Administrator",
- "level": 100,
- "is_admin": true,
- "is_default": false,
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "permissions": [
- {
- "id": 10,
- "name": "admin.manage_settings",
- "label": "Manage settings",
- "group": "Settings",
- "created_at": "2024-01-01T10:00:00Z",
- "updated_at": "2024-04-01T12:30:00Z"
}
]
}
}
}
], - "comments": [
- {
- "id": 14,
- "ticket_id": 101,
- "admin_id": 2,
- "comment": "This is an internal comment.",
- "created_at": "2024-04-14T11:00:00Z",
- "updated_at": "2024-04-14T12:00:00Z",
- "staff": {
- "id": 1,
- "username": "adminmaster",
- "firstname": "John",
- "lastname": "Doe",
- "email_verified_at": "2024-03-15T10:45:00Z",
- "last_login": "2024-04-12T09:00:00Z",
- "last_login_ip": "192.168.1.10",
- "signature": "Best regards,\\nThe Admin Team",
- "dark_mode": false,
- "expires_at": "2025-01-01T00:00:00Z",
- "locale": "en_US",
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "role": {
- "id": 1,
- "name": "Administrator",
- "level": 100,
- "is_admin": true,
- "is_default": false,
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "permissions": [
- {
- "id": 10,
- "name": "admin.manage_settings",
- "label": "Manage settings",
- "group": "Settings",
- "created_at": "2024-01-01T10:00:00Z",
- "updated_at": "2024-04-01T12:30:00Z"
}
]
}
}
}
]
}| ticket required | string ID or UUID of the ticket |
| content required | string |
{- "content": "Thank you for contacting us..."
}{- "id": 101,
- "subject": "Problème de facturation",
- "priority": "medium",
- "status": "open",
- "department_id": 3,
- "customer_id": 5,
- "assigned_to": 12,
- "staff_subscribers": [
- 1,
- 2,
- 3
], - "closed_at": "2019-08-24T14:15:22Z",
- "close_reason": "Demande résolue",
- "closed_by": "admin",
- "closed_by_id": 2,
- "related_type": "service",
- "related_id": 41,
- "created_at": "2019-08-24T14:15:22Z",
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "updated_at": "2019-08-24T14:15:22Z",
- "customer": {
- "email": "string",
- "password": "string",
- "firstname": "string",
- "lastname": "string",
- "phone": "string",
- "address": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "locale": "string",
- "region": "string",
- "zipcode": "string",
- "email_verified_at": "2019-08-24T14:15:22Z",
- "is_confirmed": true,
- "is_deleted": true,
- "dark_mode": true,
- "last_login": "2019-08-24T14:15:22Z",
- "last_ip": "string",
- "company_name": "string",
- "billing_details": "string",
- "gdpr_compliment": true
}, - "assignedTo": {
- "id": 1,
- "username": "adminmaster",
- "firstname": "John",
- "lastname": "Doe",
- "email_verified_at": "2024-03-15T10:45:00Z",
- "last_login": "2024-04-12T09:00:00Z",
- "last_login_ip": "192.168.1.10",
- "signature": "Best regards,\\nThe Admin Team",
- "dark_mode": false,
- "expires_at": "2025-01-01T00:00:00Z",
- "locale": "en_US",
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "role": {
- "id": 1,
- "name": "Administrator",
- "level": 100,
- "is_admin": true,
- "is_default": false,
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "permissions": [
- {
- "id": 10,
- "name": "admin.manage_settings",
- "label": "Manage settings",
- "group": "Settings",
- "created_at": "2024-01-01T10:00:00Z",
- "updated_at": "2024-04-01T12:30:00Z"
}
]
}
}, - "department": {
- "id": 1,
- "name": "Technical Support",
- "description": "Handles all technical issues related to services.",
- "icon": "bi bi-question-circle",
- "staff_subscribers": [
- 2,
- 5,
- 9
], - "created_at": "2024-03-01T10:00:00Z",
- "updated_at": "2024-04-01T15:30:00Z",
- "deleted_at": null,
- "tickets": [
- { }
]
}, - "attachments": [
- {
- "id": 102,
- "filename": "screenshot.png",
- "path": "helpdesk/attachments/1234/8732_screenshot.png",
- "mime": "image/png",
- "size": 204800,
- "ticket_id": 12,
- "message_id": 87,
- "customer_id": 5,
- "admin_id": 2,
- "created_at": "2024-04-14T10:00:00Z",
- "updated_at": "2024-04-14T10:05:00Z",
- "deleted_at": null
}
], - "messages": [
- {
- "id": 12,
- "ticket_id": 101,
- "customer_id": 5,
- "admin_id": 2,
- "message": "Hello i have problem.",
- "read_at": "2024-04-13T15:30:00Z",
- "created_at": "2024-04-12T10:00:00Z",
- "updated_at": "2024-04-12T10:15:00Z",
- "deleted_at": null,
- "customer": {
- "email": "string",
- "password": "string",
- "firstname": "string",
- "lastname": "string",
- "phone": "string",
- "address": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "locale": "string",
- "region": "string",
- "zipcode": "string",
- "email_verified_at": "2019-08-24T14:15:22Z",
- "is_confirmed": true,
- "is_deleted": true,
- "dark_mode": true,
- "last_login": "2019-08-24T14:15:22Z",
- "last_ip": "string",
- "company_name": "string",
- "billing_details": "string",
- "gdpr_compliment": true
}, - "admin": {
- "id": 1,
- "username": "adminmaster",
- "firstname": "John",
- "lastname": "Doe",
- "email_verified_at": "2024-03-15T10:45:00Z",
- "last_login": "2024-04-12T09:00:00Z",
- "last_login_ip": "192.168.1.10",
- "signature": "Best regards,\\nThe Admin Team",
- "dark_mode": false,
- "expires_at": "2025-01-01T00:00:00Z",
- "locale": "en_US",
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "role": {
- "id": 1,
- "name": "Administrator",
- "level": 100,
- "is_admin": true,
- "is_default": false,
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "permissions": [
- {
- "id": 10,
- "name": "admin.manage_settings",
- "label": "Manage settings",
- "group": "Settings",
- "created_at": "2024-01-01T10:00:00Z",
- "updated_at": "2024-04-01T12:30:00Z"
}
]
}
}
}
], - "comments": [
- {
- "id": 14,
- "ticket_id": 101,
- "admin_id": 2,
- "comment": "This is an internal comment.",
- "created_at": "2024-04-14T11:00:00Z",
- "updated_at": "2024-04-14T12:00:00Z",
- "staff": {
- "id": 1,
- "username": "adminmaster",
- "firstname": "John",
- "lastname": "Doe",
- "email_verified_at": "2024-03-15T10:45:00Z",
- "last_login": "2024-04-12T09:00:00Z",
- "last_login_ip": "192.168.1.10",
- "signature": "Best regards,\\nThe Admin Team",
- "dark_mode": false,
- "expires_at": "2025-01-01T00:00:00Z",
- "locale": "en_US",
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "role": {
- "id": 1,
- "name": "Administrator",
- "level": 100,
- "is_admin": true,
- "is_default": false,
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "permissions": [
- {
- "id": 10,
- "name": "admin.manage_settings",
- "label": "Manage settings",
- "group": "Settings",
- "created_at": "2024-01-01T10:00:00Z",
- "updated_at": "2024-04-01T12:30:00Z"
}
]
}
}
}
]
}| ticket required | string ID or UUID of the ticket |
| reason | string or null |
{- "reason": "Issue resolved"
}{- "id": 101,
- "subject": "Problème de facturation",
- "priority": "medium",
- "status": "open",
- "department_id": 3,
- "customer_id": 5,
- "assigned_to": 12,
- "staff_subscribers": [
- 1,
- 2,
- 3
], - "closed_at": "2019-08-24T14:15:22Z",
- "close_reason": "Demande résolue",
- "closed_by": "admin",
- "closed_by_id": 2,
- "related_type": "service",
- "related_id": 41,
- "created_at": "2019-08-24T14:15:22Z",
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "updated_at": "2019-08-24T14:15:22Z",
- "customer": {
- "email": "string",
- "password": "string",
- "firstname": "string",
- "lastname": "string",
- "phone": "string",
- "address": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "locale": "string",
- "region": "string",
- "zipcode": "string",
- "email_verified_at": "2019-08-24T14:15:22Z",
- "is_confirmed": true,
- "is_deleted": true,
- "dark_mode": true,
- "last_login": "2019-08-24T14:15:22Z",
- "last_ip": "string",
- "company_name": "string",
- "billing_details": "string",
- "gdpr_compliment": true
}, - "assignedTo": {
- "id": 1,
- "username": "adminmaster",
- "firstname": "John",
- "lastname": "Doe",
- "email_verified_at": "2024-03-15T10:45:00Z",
- "last_login": "2024-04-12T09:00:00Z",
- "last_login_ip": "192.168.1.10",
- "signature": "Best regards,\\nThe Admin Team",
- "dark_mode": false,
- "expires_at": "2025-01-01T00:00:00Z",
- "locale": "en_US",
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "role": {
- "id": 1,
- "name": "Administrator",
- "level": 100,
- "is_admin": true,
- "is_default": false,
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "permissions": [
- {
- "id": 10,
- "name": "admin.manage_settings",
- "label": "Manage settings",
- "group": "Settings",
- "created_at": "2024-01-01T10:00:00Z",
- "updated_at": "2024-04-01T12:30:00Z"
}
]
}
}, - "department": {
- "id": 1,
- "name": "Technical Support",
- "description": "Handles all technical issues related to services.",
- "icon": "bi bi-question-circle",
- "staff_subscribers": [
- 2,
- 5,
- 9
], - "created_at": "2024-03-01T10:00:00Z",
- "updated_at": "2024-04-01T15:30:00Z",
- "deleted_at": null,
- "tickets": [
- { }
]
}, - "attachments": [
- {
- "id": 102,
- "filename": "screenshot.png",
- "path": "helpdesk/attachments/1234/8732_screenshot.png",
- "mime": "image/png",
- "size": 204800,
- "ticket_id": 12,
- "message_id": 87,
- "customer_id": 5,
- "admin_id": 2,
- "created_at": "2024-04-14T10:00:00Z",
- "updated_at": "2024-04-14T10:05:00Z",
- "deleted_at": null
}
], - "messages": [
- {
- "id": 12,
- "ticket_id": 101,
- "customer_id": 5,
- "admin_id": 2,
- "message": "Hello i have problem.",
- "read_at": "2024-04-13T15:30:00Z",
- "created_at": "2024-04-12T10:00:00Z",
- "updated_at": "2024-04-12T10:15:00Z",
- "deleted_at": null,
- "customer": {
- "email": "string",
- "password": "string",
- "firstname": "string",
- "lastname": "string",
- "phone": "string",
- "address": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "locale": "string",
- "region": "string",
- "zipcode": "string",
- "email_verified_at": "2019-08-24T14:15:22Z",
- "is_confirmed": true,
- "is_deleted": true,
- "dark_mode": true,
- "last_login": "2019-08-24T14:15:22Z",
- "last_ip": "string",
- "company_name": "string",
- "billing_details": "string",
- "gdpr_compliment": true
}, - "admin": {
- "id": 1,
- "username": "adminmaster",
- "firstname": "John",
- "lastname": "Doe",
- "email_verified_at": "2024-03-15T10:45:00Z",
- "last_login": "2024-04-12T09:00:00Z",
- "last_login_ip": "192.168.1.10",
- "signature": "Best regards,\\nThe Admin Team",
- "dark_mode": false,
- "expires_at": "2025-01-01T00:00:00Z",
- "locale": "en_US",
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "role": {
- "id": 1,
- "name": "Administrator",
- "level": 100,
- "is_admin": true,
- "is_default": false,
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "permissions": [
- {
- "id": 10,
- "name": "admin.manage_settings",
- "label": "Manage settings",
- "group": "Settings",
- "created_at": "2024-01-01T10:00:00Z",
- "updated_at": "2024-04-01T12:30:00Z"
}
]
}
}
}
], - "comments": [
- {
- "id": 14,
- "ticket_id": 101,
- "admin_id": 2,
- "comment": "This is an internal comment.",
- "created_at": "2024-04-14T11:00:00Z",
- "updated_at": "2024-04-14T12:00:00Z",
- "staff": {
- "id": 1,
- "username": "adminmaster",
- "firstname": "John",
- "lastname": "Doe",
- "email_verified_at": "2024-03-15T10:45:00Z",
- "last_login": "2024-04-12T09:00:00Z",
- "last_login_ip": "192.168.1.10",
- "signature": "Best regards,\\nThe Admin Team",
- "dark_mode": false,
- "expires_at": "2025-01-01T00:00:00Z",
- "locale": "en_US",
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "role": {
- "id": 1,
- "name": "Administrator",
- "level": 100,
- "is_admin": true,
- "is_default": false,
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "permissions": [
- {
- "id": 10,
- "name": "admin.manage_settings",
- "label": "Manage settings",
- "group": "Settings",
- "created_at": "2024-01-01T10:00:00Z",
- "updated_at": "2024-04-01T12:30:00Z"
}
]
}
}
}
]
}| ticket required | string ID or UUID of the ticket |
{- "id": 101,
- "subject": "Problème de facturation",
- "priority": "medium",
- "status": "open",
- "department_id": 3,
- "customer_id": 5,
- "assigned_to": 12,
- "staff_subscribers": [
- 1,
- 2,
- 3
], - "closed_at": "2019-08-24T14:15:22Z",
- "close_reason": "Demande résolue",
- "closed_by": "admin",
- "closed_by_id": 2,
- "related_type": "service",
- "related_id": 41,
- "created_at": "2019-08-24T14:15:22Z",
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "updated_at": "2019-08-24T14:15:22Z",
- "customer": {
- "email": "string",
- "password": "string",
- "firstname": "string",
- "lastname": "string",
- "phone": "string",
- "address": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "locale": "string",
- "region": "string",
- "zipcode": "string",
- "email_verified_at": "2019-08-24T14:15:22Z",
- "is_confirmed": true,
- "is_deleted": true,
- "dark_mode": true,
- "last_login": "2019-08-24T14:15:22Z",
- "last_ip": "string",
- "company_name": "string",
- "billing_details": "string",
- "gdpr_compliment": true
}, - "assignedTo": {
- "id": 1,
- "username": "adminmaster",
- "firstname": "John",
- "lastname": "Doe",
- "email_verified_at": "2024-03-15T10:45:00Z",
- "last_login": "2024-04-12T09:00:00Z",
- "last_login_ip": "192.168.1.10",
- "signature": "Best regards,\\nThe Admin Team",
- "dark_mode": false,
- "expires_at": "2025-01-01T00:00:00Z",
- "locale": "en_US",
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "role": {
- "id": 1,
- "name": "Administrator",
- "level": 100,
- "is_admin": true,
- "is_default": false,
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "permissions": [
- {
- "id": 10,
- "name": "admin.manage_settings",
- "label": "Manage settings",
- "group": "Settings",
- "created_at": "2024-01-01T10:00:00Z",
- "updated_at": "2024-04-01T12:30:00Z"
}
]
}
}, - "department": {
- "id": 1,
- "name": "Technical Support",
- "description": "Handles all technical issues related to services.",
- "icon": "bi bi-question-circle",
- "staff_subscribers": [
- 2,
- 5,
- 9
], - "created_at": "2024-03-01T10:00:00Z",
- "updated_at": "2024-04-01T15:30:00Z",
- "deleted_at": null,
- "tickets": [
- { }
]
}, - "attachments": [
- {
- "id": 102,
- "filename": "screenshot.png",
- "path": "helpdesk/attachments/1234/8732_screenshot.png",
- "mime": "image/png",
- "size": 204800,
- "ticket_id": 12,
- "message_id": 87,
- "customer_id": 5,
- "admin_id": 2,
- "created_at": "2024-04-14T10:00:00Z",
- "updated_at": "2024-04-14T10:05:00Z",
- "deleted_at": null
}
], - "messages": [
- {
- "id": 12,
- "ticket_id": 101,
- "customer_id": 5,
- "admin_id": 2,
- "message": "Hello i have problem.",
- "read_at": "2024-04-13T15:30:00Z",
- "created_at": "2024-04-12T10:00:00Z",
- "updated_at": "2024-04-12T10:15:00Z",
- "deleted_at": null,
- "customer": {
- "email": "string",
- "password": "string",
- "firstname": "string",
- "lastname": "string",
- "phone": "string",
- "address": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "locale": "string",
- "region": "string",
- "zipcode": "string",
- "email_verified_at": "2019-08-24T14:15:22Z",
- "is_confirmed": true,
- "is_deleted": true,
- "dark_mode": true,
- "last_login": "2019-08-24T14:15:22Z",
- "last_ip": "string",
- "company_name": "string",
- "billing_details": "string",
- "gdpr_compliment": true
}, - "admin": {
- "id": 1,
- "username": "adminmaster",
- "firstname": "John",
- "lastname": "Doe",
- "email_verified_at": "2024-03-15T10:45:00Z",
- "last_login": "2024-04-12T09:00:00Z",
- "last_login_ip": "192.168.1.10",
- "signature": "Best regards,\\nThe Admin Team",
- "dark_mode": false,
- "expires_at": "2025-01-01T00:00:00Z",
- "locale": "en_US",
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "role": {
- "id": 1,
- "name": "Administrator",
- "level": 100,
- "is_admin": true,
- "is_default": false,
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "permissions": [
- {
- "id": 10,
- "name": "admin.manage_settings",
- "label": "Manage settings",
- "group": "Settings",
- "created_at": "2024-01-01T10:00:00Z",
- "updated_at": "2024-04-01T12:30:00Z"
}
]
}
}
}
], - "comments": [
- {
- "id": 14,
- "ticket_id": 101,
- "admin_id": 2,
- "comment": "This is an internal comment.",
- "created_at": "2024-04-14T11:00:00Z",
- "updated_at": "2024-04-14T12:00:00Z",
- "staff": {
- "id": 1,
- "username": "adminmaster",
- "firstname": "John",
- "lastname": "Doe",
- "email_verified_at": "2024-03-15T10:45:00Z",
- "last_login": "2024-04-12T09:00:00Z",
- "last_login_ip": "192.168.1.10",
- "signature": "Best regards,\\nThe Admin Team",
- "dark_mode": false,
- "expires_at": "2025-01-01T00:00:00Z",
- "locale": "en_US",
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "role": {
- "id": 1,
- "name": "Administrator",
- "level": 100,
- "is_admin": true,
- "is_default": false,
- "created_at": "2024-01-10T15:00:00Z",
- "updated_at": "2024-04-10T12:00:00Z",
- "deleted_at": null,
- "permissions": [
- {
- "id": 10,
- "name": "admin.manage_settings",
- "label": "Manage settings",
- "group": "Settings",
- "created_at": "2024-01-01T10:00:00Z",
- "updated_at": "2024-04-01T12:30:00Z"
}
]
}
}
}
]
}| page | integer Default: 1 Page number |
| per_page | integer Default: 10 Number of items per page |
| sort | string Sort order |
| filter[type] | string Filter by server type (pterodactyl, plesk, etc.) |
| filter[status] | string Filter by status |
[- {
- "id": 1,
- "name": "Node-Paris-01",
- "hostname": "paris01.clientx.local",
- "address": "192.168.0.10",
- "port": 443,
- "username": "root",
- "password": "s3cur3",
- "type": "pterodactyl",
- "status": "active",
- "maxaccounts": 100,
- "created_at": "2024-01-01T10:00:00Z",
- "updated_at": "2024-01-02T12:00:00Z"
}
]| name required | string |
| hostname | string |
| address required | string |
| port | integer |
| username | string or null |
| password | string or null |
| type required | string |
| status | string Enum: "active" "hidden" "unreferenced" |
| maxaccounts | integer or null |
{- "name": "Node-Paris-01",
- "hostname": "paris01.example.com",
- "address": "192.168.0.10",
- "port": 443,
- "username": "string",
- "password": "string",
- "type": "pterodactyl",
- "status": "active",
- "maxaccounts": 100
}{- "id": 1,
- "name": "Node-Paris-01",
- "hostname": "paris01.clientx.local",
- "address": "192.168.0.10",
- "port": 443,
- "username": "root",
- "password": "s3cur3",
- "type": "pterodactyl",
- "status": "active",
- "maxaccounts": 100,
- "created_at": "2024-01-01T10:00:00Z",
- "updated_at": "2024-01-02T12:00:00Z"
}| server required | integer ID of the server |
{- "id": 1,
- "name": "Node-Paris-01",
- "hostname": "paris01.clientx.local",
- "address": "192.168.0.10",
- "port": 443,
- "username": "root",
- "password": "s3cur3",
- "type": "pterodactyl",
- "status": "active",
- "maxaccounts": 100,
- "created_at": "2024-01-01T10:00:00Z",
- "updated_at": "2024-01-02T12:00:00Z"
}| server required | integer ID of the server |
| name | string |
| hostname | string |
| address | string |
| port | integer |
| username | string |
| password | string |
| type | string |
| status | string |
| maxaccounts | integer |
{- "name": "string",
- "hostname": "string",
- "address": "string",
- "port": 0,
- "username": "string",
- "password": "string",
- "type": "string",
- "status": "string",
- "maxaccounts": 0
}{- "id": 1,
- "name": "Node-Paris-01",
- "hostname": "paris01.clientx.local",
- "address": "192.168.0.10",
- "port": 443,
- "username": "root",
- "password": "s3cur3",
- "type": "pterodactyl",
- "status": "active",
- "maxaccounts": 100,
- "created_at": "2024-01-01T10:00:00Z",
- "updated_at": "2024-01-02T12:00:00Z"
}| address required | string |
| port | integer |
| type required | string |
| username | string |
| password | string |
| hostname | string |
| server_id | integer Existing server ID to use credentials from |
{- "address": "string",
- "port": 0,
- "type": "string",
- "username": "string",
- "password": "string",
- "hostname": "string",
- "server_id": 0
}| page | integer Default: 1 Page number |
| per_page | integer Default: 50 Number of items per page |
| sort | string Sort order (default: -created_at) |
| filter[action] | string Filter by action type |
| filter[model] | string Filter by model name |
| filter[staff_id] | integer Filter by staff ID |
| filter[customer_id] | integer Filter by customer ID |
| include | string Default: "customer,staff,entries" Related resources to include |
| code required | string |
| type required | string Enum: "fixed" "percent" |
| applied_month | integer |
| free_setup | boolean |
| start_at | string or null <date-time> |
| end_at | string or null <date-time> |
| first_order_only | boolean |
| max_uses | integer |
| max_uses_per_customer | integer |
| minimum_order_amount | number |
| is_global | boolean |
| products | Array of integers |
| pricing | object |
{- "code": "SUMMER25",
- "type": "percent",
- "applied_month": -1,
- "free_setup": false,
- "start_at": "2019-08-24T14:15:22Z",
- "end_at": "2019-08-24T14:15:22Z",
- "first_order_only": false,
- "max_uses": 0,
- "max_uses_per_customer": 0,
- "minimum_order_amount": 0,
- "is_global": true,
- "products": [
- 0
], - "pricing": { }
}| coupon required | integer ID of the coupon |
| code | string |
| type | string Enum: "fixed" "percent" |
| is_global | boolean |
| products | Array of integers |
{- "code": "string",
- "type": "fixed",
- "is_global": true,
- "products": [
- 0
]
}