Change log

CRM Bookings API

Create, Retrieve, Update and Delete CRM Bookings via the public API endpoint using "where" filtering.

GET CRM Bookings List

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

/api/v2/admin/bookings

Data / Response:

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

{
  "Items": [
    {
      "Id": 0,
      "EventId": 0,
      "OrderId": 0,
      "FormId": 0,
      "MemberId": 0,
      "Allocation": 0,
      "CreatedDateTime": "2024-05-15T20:00:19.006Z",
      "CustomCrmGroups": {
        "<GroupAlias1>": {
          "<FieldAlias1>": "<value>",
          "<FieldAlias2>": false,
          "<FieldAlias3>": 0
        }
      },
      "Member": {
        "Id": 0,
        "Email": "string",
        "FirstName": "string",
        "LastName": "string"
      },
      "Form": {
        "Id": 0,
        "Alias": "string",
        "Name": "string"
      },
      "Event": {
        "Id": 0,
        "Name": "string"
      },
      "EventBookingFields": {
        "<FieldAlias1>": "<value>",
        "<FieldAlias2>": false,
        "<FieldAlias3>": 0
      }
    }
  ],
  "TotalItemsCount": 0
}

POST CRM Booking Create

Creates a new Booking based on the provided data.

/api/v2/admin/bookings

Data / Response:

FormSubmissionData with FormId as required field

{
  "Id": 0,
  "EventId": 0,
  "OrderId": 0,
  "FormId": 0,
  "MemberId": 0,
  "Allocation": 0,
  "CreatedDateTime": "2024-05-15T20:03:25.975Z",
  "CustomCrmGroups": {
    "<GroupAlias1>": {
      "<FieldAlias1>": "<value>",
      "<FieldAlias2>": false,
      "<FieldAlias3>": 0
    }
  },
  "Member": {
    "Id": 0,
    "Email": "string",
    "FirstName": "string",
    "LastName": "string"
  },
  "Form": {
    "Id": 0,
    "Alias": "string",
    "Name": "string"
  },
  "Event": {
    "Id": 0,
    "Name": "string"
  },
  "EventBookingFields": {
    "<FieldAlias1>": "<value>",
    "<FieldAlias2>": false,
    "<FieldAlias3>": 0
  }
}

GET CRM Booking Item

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

/api/v2/admin/bookings/{id}

Data / Response:

N/A

{
  "Id": 0,
  "EventId": 0,
  "OrderId": 0,
  "FormId": 0,
  "MemberId": 0,
  "Allocation": 0,
  "CreatedDateTime": "2024-05-15T20:03:25.975Z",
  "CustomCrmGroups": {
    "<GroupAlias1>": {
      "<FieldAlias1>": "<value>",
      "<FieldAlias2>": false,
      "<FieldAlias3>": 0
    }
  },
  "Member": {
    "Id": 0,
    "Email": "string",
    "FirstName": "string",
    "LastName": "string"
  },
  "Form": {
    "Id": 0,
    "Alias": "string",
    "Name": "string"
  },
  "Event": {
    "Id": 0,
    "Name": "string"
  },
  "EventBookingFields": {
    "<FieldAlias1>": "<value>",
    "<FieldAlias2>": false,
    "<FieldAlias3>": 0
  }
}

PUT CRM Booking Update

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

/api/v2/admin/bookings/{id}

Data / Response:

FormSubmissionData

{
  "Id": 0,
  "EventId": 0,
  "OrderId": 0,
  "FormId": 0,
  "MemberId": 0,
  "Allocation": 0,
  "CreatedDateTime": "2024-05-15T20:03:25.975Z",
  "CustomCrmGroups": {
    "<GroupAlias1>": {
      "<FieldAlias1>": "<value>",
      "<FieldAlias2>": false,
      "<FieldAlias3>": 0
    }
  },
  "Member": {
    "Id": 0,
    "Email": "string",
    "FirstName": "string",
    "LastName": "string"
  },
  "Form": {
    "Id": 0,
    "Alias": "string",
    "Name": "string"
  },
  "Event": {
    "Id": 0,
    "Name": "string"
  },
  "EventBookingFields": {
    "<FieldAlias1>": "<value>",
    "<FieldAlias2>": false,
    "<FieldAlias3>": 0
  }
}

DELETE CRM Booking Delete

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

/api/v2/admin/bookings/{id}

Data / Response:

N/A

Status 204

Related Articles

  • CRM
    Event Bookings
    Event Bookings store all registrations made to an Event item, either via the website front-end or manually allocated via the admin.
  • Liquid Components
    module (Event Group)
    This module component fetches data relating to Event groups. {% component type: "module", source: "Event...
  • Liquid Components
    module (Event)
    This module component fetches data relating to Events. {% component type: "module", source: "Event", layout:...
  • 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.
  • Content Modules
    Events
    Events can be used for listing and taking paid or free bookings for date/time specific events as well as tracking capacity and multiply seat purchases.

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.