Open API v2 / CRM & Orders / CRM Cases
CRM Cases
→
Every request needs a bearer token: Authorization: Bearer <token>. Base URL https://your-site.webinone.com. New to field types? See the type reference.
Retrieves a list of cases by using a "where" filtering
Parameters
Wherestring · query
JSON filter expression. Combine operators ($eq, $contains, $gt, $in, …) with $and / $or.
Order_Bystring · query
Sort field. Prefix with - for descending; comma-separate for tie-breakers.
Semantic_Querystring · query
Natural-language search, ranked by relevance.
Min_Scorenumber · query
Lowest relevance score to include when using Semantic_Query.
Offsetinteger · query
Number of items to skip before returning results. Defaults to 0.
Limitinteger · query
Maximum number of items to return. Defaults to 100.
Response
Idinteger
Unique identifier. Technical record number in the database. Read-only.
OrderIdinteger
Identifier of the related order.
FormIdinteger
Identifier of the related form.
MemberIdinteger
Identifier of the related member.
CreatedDateTimestring · date-time
Date and time of case creation in UTC. Read-only.
CustomCrmGroupsarray of objects
Custom CRM group field values attached to this record.
Aliasstring · nullable
System alias of the form.
Fieldsarray of objects
The individual field values stored in this CRM group.
Aliasstring · nullable
System alias of the form.
Valuestring · nullable
The value entered for this CRM field.
Typeenum
'StatusShort' technical key (alias). Possible values: DateTime, CheckboxList, DropdownList, ListboxList, RadioList, Multiline, String, Boolean, Recaptcha, Upload, Password, AcceptPayment, AcceptEventSubscription, IsDataUsingAllowed, Country, HiddenValidator.Possible values: DateTimeCheckboxListDropdownListListboxListRadioListMultilineStringBooleanRecaptchaUploadPasswordAcceptPaymentAcceptEventSubscriptionIsDataUsingAllowedCountryHiddenValidator
Memberobject
The member (site user) this record is linked to.
Idinteger
'Member' a unique user identifier in the system. Read-only.
Emailstring · nullable
'Member' contact email to which notifications about order status and invoices are sent.
FirstNamestring · nullable
'Member' buyer's name.
LastNamestring · nullable
'Member' buyer's last name.
Formobject
Form the submission belongs to.
Idinteger
Event ID. Read-only.
Aliasstring · nullable
System alias of the form.
Namestring · nullable
System name of the event.
CaseFieldsarray of objects
This is a dynamic object that contains the values of the form fields on which the Case is created.
Aliasstring · nullable
System alias of the form.
Valuestring · nullable
The value entered for this CRM field.
Typeenum
User category. Possible values: DateTime, CheckboxList, DropdownList, ListboxList, RadioList, Multiline, String, Boolean, Recaptcha, Upload, Password, AcceptPayment, AcceptEventSubscription, IsDataUsingAllowed, Country, HiddenValidator.Possible values: DateTimeCheckboxListDropdownListListboxListRadioListMultilineStringBooleanRecaptchaUploadPasswordAcceptPaymentAcceptEventSubscriptionIsDataUsingAllowedCountryHiddenValidator
curl "https://your-site.webinone.com/api/v2/admin/cases" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/cases", { method: "GET", headers: { "Authorization": "Bearer <token>" } });
import requests requests.get( "https://your-site.webinone.com/api/v2/admin/cases", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/cases', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/cases"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Response · 200
{
"Items": [
{
"Id": 1,
"OrderId": 1,
"FormId": 1,
"MemberId": 1,
"CreatedDateTime": "2026-07-01T00: 00: 00Z",
"CustomCrmGroups": [
{
"Alias": "string",
"Fields": [
{
"Alias": "string",
"Value": "string",
"Type": "DateTime"
}
]
}
],
"Member": {
"Id": 1,
"Email": "user@example.com",
"FirstName": "Example",
"LastName": "Example"
},
"Form": {
"Id": 1,
"Alias": "string",
"Name": "Example"
},
"CaseFields": [
{
"Alias": "string",
"Value": "string",
"Type": "DateTime"
}
]
}
],
"TotalItemsCount": 0
}Creates a new case
Parameters
Response
Idinteger
Unique identifier. Technical record number in the database. Read-only.
OrderIdinteger
Identifier of the related order.
FormIdinteger
Identifier of the related form.
MemberIdinteger
Identifier of the related member.
CreatedDateTimestring · date-time
Date and time of case creation in UTC. Read-only.
CustomCrmGroupsarray of objects
Custom CRM group field values attached to this record.
Aliasstring · nullable
System alias of the form.
Fieldsarray of objects
The individual field values stored in this CRM group.
Aliasstring · nullable
System alias of the form.
Valuestring · nullable
The value entered for this CRM field.
Typeenum
'StatusShort' technical key (alias). Possible values: DateTime, CheckboxList, DropdownList, ListboxList, RadioList, Multiline, String, Boolean, Recaptcha, Upload, Password, AcceptPayment, AcceptEventSubscription, IsDataUsingAllowed, Country, HiddenValidator.Possible values: DateTimeCheckboxListDropdownListListboxListRadioListMultilineStringBooleanRecaptchaUploadPasswordAcceptPaymentAcceptEventSubscriptionIsDataUsingAllowedCountryHiddenValidator
Memberobject
The member (site user) this record is linked to.
Idinteger
'Member' a unique user identifier in the system. Read-only.
Emailstring · nullable
'Member' contact email to which notifications about order status and invoices are sent.
FirstNamestring · nullable
'Member' buyer's name.
LastNamestring · nullable
'Member' buyer's last name.
Formobject
Form the submission belongs to.
Idinteger
Event ID. Read-only.
Aliasstring · nullable
System alias of the form.
Namestring · nullable
System name of the event.
CaseFieldsarray of objects
This is a dynamic object that contains the values of the form fields on which the Case is created.
Aliasstring · nullable
System alias of the form.
Valuestring · nullable
The value entered for this CRM field.
Typeenum
User category. Possible values: DateTime, CheckboxList, DropdownList, ListboxList, RadioList, Multiline, String, Boolean, Recaptcha, Upload, Password, AcceptPayment, AcceptEventSubscription, IsDataUsingAllowed, Country, HiddenValidator.Possible values: DateTimeCheckboxListDropdownListListboxListRadioListMultilineStringBooleanRecaptchaUploadPasswordAcceptPaymentAcceptEventSubscriptionIsDataUsingAllowedCountryHiddenValidator
curl -X POST "https://your-site.webinone.com/api/v2/admin/cases" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/cases", { method: "POST", headers: { "Authorization": "Bearer <token>" } });
import requests requests.post( "https://your-site.webinone.com/api/v2/admin/cases", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('POST', 'https://your-site.webinone.com/api/v2/admin/cases', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Post, "https://your-site.webinone.com/api/v2/admin/cases"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Response · 200
{
"Id": 1,
"OrderId": 1,
"FormId": 1,
"MemberId": 1,
"CreatedDateTime": "2026-07-01T00: 00: 00Z",
"CustomCrmGroups": [
{
"Alias": "string",
"Fields": [
{
"Alias": "string",
"Value": "string",
"Type": "DateTime"
}
]
}
],
"Member": {
"Id": 1,
"Email": "user@example.com",
"FirstName": "Example",
"LastName": "Example"
},
"Form": {
"Id": 1,
"Alias": "string",
"Name": "Example"
},
"CaseFields": [
{
"Alias": "string",
"Value": "string",
"Type": "DateTime"
}
]
}Retrieves a single case
Parameters
idinteger · pathrequired
Case id.
Response
Idinteger
Unique identifier. Technical record number in the database. Read-only.
OrderIdinteger
Identifier of the related order.
FormIdinteger
Identifier of the related form.
MemberIdinteger
Identifier of the related member.
CreatedDateTimestring · date-time
Date and time of case creation in UTC. Read-only.
CustomCrmGroupsarray of objects
Custom CRM group field values attached to this record.
Aliasstring · nullable
System alias of the form.
Fieldsarray of objects
The individual field values stored in this CRM group.
Aliasstring · nullable
System alias of the form.
Valuestring · nullable
The value entered for this CRM field.
Typeenum
'StatusShort' technical key (alias). Possible values: DateTime, CheckboxList, DropdownList, ListboxList, RadioList, Multiline, String, Boolean, Recaptcha, Upload, Password, AcceptPayment, AcceptEventSubscription, IsDataUsingAllowed, Country, HiddenValidator.Possible values: DateTimeCheckboxListDropdownListListboxListRadioListMultilineStringBooleanRecaptchaUploadPasswordAcceptPaymentAcceptEventSubscriptionIsDataUsingAllowedCountryHiddenValidator
Memberobject
The member (site user) this record is linked to.
Idinteger
'Member' a unique user identifier in the system. Read-only.
Emailstring · nullable
'Member' contact email to which notifications about order status and invoices are sent.
FirstNamestring · nullable
'Member' buyer's name.
LastNamestring · nullable
'Member' buyer's last name.
Formobject
Form the submission belongs to.
Idinteger
Event ID. Read-only.
Aliasstring · nullable
System alias of the form.
Namestring · nullable
System name of the event.
CaseFieldsarray of objects
This is a dynamic object that contains the values of the form fields on which the Case is created.
Aliasstring · nullable
System alias of the form.
Valuestring · nullable
The value entered for this CRM field.
Typeenum
User category. Possible values: DateTime, CheckboxList, DropdownList, ListboxList, RadioList, Multiline, String, Boolean, Recaptcha, Upload, Password, AcceptPayment, AcceptEventSubscription, IsDataUsingAllowed, Country, HiddenValidator.Possible values: DateTimeCheckboxListDropdownListListboxListRadioListMultilineStringBooleanRecaptchaUploadPasswordAcceptPaymentAcceptEventSubscriptionIsDataUsingAllowedCountryHiddenValidator
curl "https://your-site.webinone.com/api/v2/admin/cases/1" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/cases/1", { method: "GET", headers: { "Authorization": "Bearer <token>" } });
import requests requests.get( "https://your-site.webinone.com/api/v2/admin/cases/1", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/cases/1', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/cases/1"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Response · 200
{
"Id": 1,
"OrderId": 1,
"FormId": 1,
"MemberId": 1,
"CreatedDateTime": "2026-07-01T00: 00: 00Z",
"CustomCrmGroups": [
{
"Alias": "string",
"Fields": [
{
"Alias": "string",
"Value": "string",
"Type": "DateTime"
}
]
}
],
"Member": {
"Id": 1,
"Email": "user@example.com",
"FirstName": "Example",
"LastName": "Example"
},
"Form": {
"Id": 1,
"Alias": "string",
"Name": "Example"
},
"CaseFields": [
{
"Alias": "string",
"Value": "string",
"Type": "DateTime"
}
]
}Updates an existing case
Parameters
idinteger · pathrequired
Resource identifier.
Response
Idinteger
Unique identifier. Technical record number in the database. Read-only.
OrderIdinteger
Identifier of the related order.
FormIdinteger
Identifier of the related form.
MemberIdinteger
Identifier of the related member.
CreatedDateTimestring · date-time
Date and time of case creation in UTC. Read-only.
CustomCrmGroupsarray of objects
Custom CRM group field values attached to this record.
Aliasstring · nullable
System alias of the form.
Fieldsarray of objects
The individual field values stored in this CRM group.
Aliasstring · nullable
System alias of the form.
Valuestring · nullable
The value entered for this CRM field.
Typeenum
'StatusShort' technical key (alias). Possible values: DateTime, CheckboxList, DropdownList, ListboxList, RadioList, Multiline, String, Boolean, Recaptcha, Upload, Password, AcceptPayment, AcceptEventSubscription, IsDataUsingAllowed, Country, HiddenValidator.Possible values: DateTimeCheckboxListDropdownListListboxListRadioListMultilineStringBooleanRecaptchaUploadPasswordAcceptPaymentAcceptEventSubscriptionIsDataUsingAllowedCountryHiddenValidator
Memberobject
The member (site user) this record is linked to.
Idinteger
'Member' a unique user identifier in the system. Read-only.
Emailstring · nullable
'Member' contact email to which notifications about order status and invoices are sent.
FirstNamestring · nullable
'Member' buyer's name.
LastNamestring · nullable
'Member' buyer's last name.
Formobject
Form the submission belongs to.
Idinteger
Event ID. Read-only.
Aliasstring · nullable
System alias of the form.
Namestring · nullable
System name of the event.
CaseFieldsarray of objects
This is a dynamic object that contains the values of the form fields on which the Case is created.
Aliasstring · nullable
System alias of the form.
Valuestring · nullable
The value entered for this CRM field.
Typeenum
User category. Possible values: DateTime, CheckboxList, DropdownList, ListboxList, RadioList, Multiline, String, Boolean, Recaptcha, Upload, Password, AcceptPayment, AcceptEventSubscription, IsDataUsingAllowed, Country, HiddenValidator.Possible values: DateTimeCheckboxListDropdownListListboxListRadioListMultilineStringBooleanRecaptchaUploadPasswordAcceptPaymentAcceptEventSubscriptionIsDataUsingAllowedCountryHiddenValidator
curl -X PUT "https://your-site.webinone.com/api/v2/admin/cases/1" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/cases/1", { method: "PUT", headers: { "Authorization": "Bearer <token>" } });
import requests requests.put( "https://your-site.webinone.com/api/v2/admin/cases/1", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('PUT', 'https://your-site.webinone.com/api/v2/admin/cases/1', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Put, "https://your-site.webinone.com/api/v2/admin/cases/1"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Response · 200
{
"Id": 1,
"OrderId": 1,
"FormId": 1,
"MemberId": 1,
"CreatedDateTime": "2026-07-01T00: 00: 00Z",
"CustomCrmGroups": [
{
"Alias": "string",
"Fields": [
{
"Alias": "string",
"Value": "string",
"Type": "DateTime"
}
]
}
],
"Member": {
"Id": 1,
"Email": "user@example.com",
"FirstName": "Example",
"LastName": "Example"
},
"Form": {
"Id": 1,
"Alias": "string",
"Name": "Example"
},
"CaseFields": [
{
"Alias": "string",
"Value": "string",
"Type": "DateTime"
}
]
}Deletes an existing case
Parameters
idinteger · pathrequired
Resource identifier.
curl -X DELETE "https://your-site.webinone.com/api/v2/admin/cases/1" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/cases/1", { method: "DELETE", headers: { "Authorization": "Bearer <token>" } });
import requests requests.delete( "https://your-site.webinone.com/api/v2/admin/cases/1", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('DELETE', 'https://your-site.webinone.com/api/v2/admin/cases/1', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Delete, "https://your-site.webinone.com/api/v2/admin/cases/1"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);