CRM Cases API

GET CRM Cases List

Retrieves a list of Cases as a JSON response based on your provided query parameters.

/api/v2/admin/cases

Data / Response:

{
    "Where" : {},
    "Order_By" : "Id",
    "Offset" : 0,
    "Limit" : 100,
}

{
  "Items": [
    {
      "Id": 0,
      "OrderId": 0,
      "FormId": 0,
      "MemberId": 0,
      "CreatedDateTime": "2024-05-17T17:45:27.212Z",
      "CustomCrmGroups": {
        "<GroupAlias1>": {
          "<FieldAlias1>": "<value>",
          "<FieldAlias2>": false,
          "<FieldAlias3>": 0
        }
      },
      "Member": {
        "Id": 0,
        "Email": "string",
        "FirstName": "string",
        "LastName": "string"
      },
      "Form": {
        "Id": 0,
        "Alias": "string",
        "Name": "string"
      },
      "CaseFields": {
        "<FieldAlias1>": "<value>",
        "<FieldAlias2>": false,
        "<FieldAlias3>": 0
      }
    }
  ],
  "TotalItemsCount": 0
}

POST CRM Case Create

Creates a new Case based on the provided data.

/api/v2/admin/cases

Data / Response:

FormSubmissionData with FormId as required field

{
  "Id": 0,
  "OrderId": 0,
  "FormId": 0,
  "MemberId": 0,
  "CreatedDateTime": "2024-05-17T18:14:56.124Z",
  "CustomCrmGroups": {
    "<GroupAlias1>": {
      "<FieldAlias1>": "<value>",
      "<FieldAlias2>": false,
      "<FieldAlias3>": 0
    }
  },
  "Member": {
    "Id": 0,
    "Email": "string",
    "FirstName": "string",
    "LastName": "string"
  },
  "Form": {
    "Id": 0,
    "Alias": "string",
    "Name": "string"
  },
  "CaseFields": {
    "<FieldAlias1>": "<value>",
    "<FieldAlias2>": false,
    "<FieldAlias3>": 0
  }
}

GET CRM Case Item

Retrieves a single Case based on the ID passed in the endpoint URL.

/api/v2/admin/cases/{id}

Data / Response:

N/A

{
  "Id": 0,
  "OrderId": 0,
  "FormId": 0,
  "MemberId": 0,
  "CreatedDateTime": "2024-05-17T18:14:56.124Z",
  "CustomCrmGroups": {
    "<GroupAlias1>": {
      "<FieldAlias1>": "<value>",
      "<FieldAlias2>": false,
      "<FieldAlias3>": 0
    }
  },
  "Member": {
    "Id": 0,
    "Email": "string",
    "FirstName": "string",
    "LastName": "string"
  },
  "Form": {
    "Id": 0,
    "Alias": "string",
    "Name": "string"
  },
  "CaseFields": {
    "<FieldAlias1>": "<value>",
    "<FieldAlias2>": false,
    "<FieldAlias3>": 0
  }
}

PUT CRM Case Update

Updates a single Case based on the ID passed in the endpoint URL and data provided.

/api/v2/admin/cases/{id}

Data / Response:

FormSubmissionData

{
  "Id": 0,
  "OrderId": 0,
  "FormId": 0,
  "MemberId": 0,
  "CreatedDateTime": "2024-05-17T18:14:56.124Z",
  "CustomCrmGroups": {
    "<GroupAlias1>": {
      "<FieldAlias1>": "<value>",
      "<FieldAlias2>": false,
      "<FieldAlias3>": 0
    }
  },
  "Member": {
    "Id": 0,
    "Email": "string",
    "FirstName": "string",
    "LastName": "string"
  },
  "Form": {
    "Id": 0,
    "Alias": "string",
    "Name": "string"
  },
  "CaseFields": {
    "<FieldAlias1>": "<value>",
    "<FieldAlias2>": false,
    "<FieldAlias3>": 0
  }
}

DELETE CRM Case Delete

Deletes a single Case based on the ID passed in the endpoint URL.

/api/v2/admin/cases/{id}

Data / Response:

N/A

Status 204

Related Articles

• Site Settings & Management
  System Pages
  System Pages, under 'Settings', is where you’ll find all those pages required by certain system...
• Reports
  Custom Reports
  Custom reports can be used to bring CRM data together, as a spreadsheet, based on your requirements.
• Liquid Components
  form
  This component outputs data relating to a specific Form. {% component type: "form", alias: "<form_alias>"...
• CRM
  Form Submissions
  Form Submissions store the captured data from any form submission made on your website (from a form created under ‘Content’ > ‘Forms’).
• Email Notifications
  System Emails
  System emails are emails that are sent when a particular action is carried out on the website and/or via the admin.
• Liquid Objects & Usage
  {{ formSubmissionData }} object
  This liquid object will output the submission details of a Form.
• CRM
  Advanced CRM Groups
  Advanced CRM Groups allow you to extend the data fields within multiple areas of the CRM, either globally or on a per-record basis.
• Liquid Objects & Usage
  {{ workflow }} object
  This liquid object will output the Workflow details of a submitted Form. You can use...
• Content Modules
  Forms
  Forms are an essential part of collecting user information on your website.
  Treepl CMS makes managing forms easy and powerful
• Liquid Objects & Usage
  {{ order }} object
  This liquid object will output the order details of a submitted payment. {{ this.order }}...
• Content Modules
  Secure Zones
  Secure Zones provide a way of creating restricted content on your website that only registered Secure Zone Members are able to access after successfully logging in.
• OpenAPI (Admin)
  Forms API
  Retrieve Forms via the public API endpoint using "where" filtering.
• eCommerce
  Payment Form Javascript
  Options for controlling and further customising payment form submissions are available via javascript events.
• Extras
  ReCaptcha Styling
  Treepl CMS supports Google reCAPTCHA v2 and v3 implementations. Below are some additional options you...

External Resources

There are currently no external resources available.

Please let us know if you have any other contributions or know of any helpful resources you'd like to see added here.

Questions?

We are always happy to help with any questions you may have.
Visit the Treepl Forum for community support and to search previously asked questions or send us a message at support@treepl.co and we will consult you as soon as possible.