Skip to main content
GET
/
api
/
spaces
/
coworkermessages
Search CoworkerMessages
curl --request GET \
  --url https://spaces.nexudus.com/api/spaces/coworkermessages \
  --header 'Authorization: Basic <encoded-value>'
{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}
A message sent to or received from a customer. These can be sent using the default email settings associated with the location or via any of the connected email accounts. Messages can be composed directly from a customer’s record in the Admin Panel. Use Incoming to distinguish messages received from a customer from messages sent to them.

​
Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the CoworkerMessage-List role.

​
Enums

ValueName
0ResetPassword
1PaidInvoice
2UnPaidInvoice
3NewInvoice
4PreauthSignUp
5NewUser
6NewContact
7BookingConfirmation
8BookingReminder
9LowTimePasses
10AutoCheckout
11EventProduct
12TermsAndConditionsAgreed
13NewEventComment
14NewBlogComment
15NewCreditNote
16NewWallMessage
17NewDataFile
18NewEsignedFile
19VisitorCheckin
20VisitorRegistered
21ReferralInvite
22HelpDeskReply
23TourRegistered
24SignupRestore
25BookingTerminationConfirmation
26DeliveryReceived
27Proposal
28BookingDeletedConfirmation
29PasswordChanged
30EventAttendeeCancelledConfirmation
31VisitorBookingNotification
32EventUpdateNotification
33EventAttendeeReminder
34SurveyInvitation
35VisitorBookingCancelledNotification
36BrivoOnAirCode
37EventAttendeeEventFinished
38PinReminder
39FormPageInvitation

​
Query Parameters

​
Pagination & Sorting

​
page
integer
default:"1"
The page number to retrieve.
​
size
integer
default:"25"
The number of records per page.
​
orderBy
string
The property name to sort results by (e.g. Name, CreatedOn).
​
dir
integer
Sort direction. 1 for ascending, -1 for descending.

​
Filters

​
CoworkerMessage_Coworker
integer
Filter by customer sending or receiving the message.
​
CoworkerMessage_Coworker_FullName
string
Filter by customer full name.
​
CoworkerMessage_Coworker_Email
string
Filter by customer email address.
​
CoworkerMessage_Coworker_BillingName
string
Filter by customer billing name.
​
CoworkerMessage_Coworker_CompanyName
string
Filter by customer company name.
​
CoworkerMessage_EmailAccount
integer
Filter by email account used to send or receive the message. If not set, the default email settings configured for the location are used.
​
CoworkerMessage_EmailAccount_DisplayName
string
Filter by email account display name.
​
CoworkerMessage_EmailAccount_EmailAddress
string
Filter by email account email address.
​
CoworkerMessage_Subject
string
Filter by message subject.
​
CoworkerMessage_Body
string
Filter by message body.
​
CoworkerMessage_IsNewMessage
boolean
Filter by whether the message has not been read yet.
​
CoworkerMessage_Incoming
boolean
Filter by whether the message was received from the customer (true) or sent to the customer (false).
​
CoworkerMessage_MessageId
integer
Filter by automated message template that triggered this message, if sent by the system.
​
CoworkerMessage_ReminderUniqueId
string
Filter by unique identifier of the reminder that triggered this message, if any.

​
Range Filters

​
from_CoworkerMessage_MessageId
integer
Filter by automated message template that triggered this message, if sent by the system greater than or equal to this value.
​
to_CoworkerMessage_MessageId
integer
Filter by automated message template that triggered this message, if sent by the system less than or equal to this value.
​
from_CoworkerMessage_CreatedOn
string
Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
​
to_CoworkerMessage_CreatedOn
string
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
​
from_CoworkerMessage_UpdatedOn
string
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
​
to_CoworkerMessage_UpdatedOn
string
Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

​
Code Examples

​
Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/coworkermessages?page=1&size=15&orderBy=CreatedOn&dir=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Filtering by CreatedOn

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/coworkermessages?CoworkerMessage_CreatedOn=example-value&orderBy=CreatedOn&dir=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/coworkermessages?from_CoworkerMessage_UpdatedOn=2025-01-01T00:00&to_CoworkerMessage_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=-1" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response

​
200

​
Records
CoworkerMessage[]
The list of CoworkerMessage records matching the query. See the Get one CoworkerMessage endpoint for the full list of properties returned for each record.
Partial records — The listing endpoint returns a summary representation of each CoworkerMessage. The following fields are not populated in the Records[] response: Body.To get all fields, fetch the full record using the Get one CoworkerMessage endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.
​
CurrentPage
integer
Current page number.
​
CurrentPageSize
integer
Number of records per page.
​
CurrentOrderField
string
The field used for sorting.
​
CurrentSortDirection
integer
The sort direction (1 = ascending, -1 = descending).
​
FirstItem
integer
Index of the first item on the current page.
​
LastItem
integer
Index of the last item on the current page.
​
TotalItems
integer
Total number of matching records across all pages.
​
TotalPages
integer
Total number of pages.
​
HasNextPage
boolean
Whether there is a next page of results.
​
HasPreviousPage
boolean
Whether there is a previous page of results.
Example Response
{
  "Records": [
    {
      "CoworkerId": 0,
      "CoworkerFullName": null,
      "CoworkerEmail": null,
      "CoworkerBillingName": null,
      "CoworkerCompanyName": null,
      "EmailAccountId": null,
      "EmailAccountDisplayName": null,
      "EmailAccountEmailAddress": null,
      "Subject": null,
      "IsNewMessage": false,
      "Incoming": false,
      "MessageId": 0,
      "ReminderUniqueId": null,
      "Id": 87654321,
      "UpdatedOn": "2025-01-15T10:30:00Z",
      "CreatedOn": "2025-01-10T08:00:00Z",
      "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "UpdatedBy": "admin@example.com",
      "IsNew": false,
      "SystemId": null,
      "ToStringText": "CoworkerMessage Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}