Search CoworkerMessages

GET

api

spaces

coworkermessages

curl --request GET \
  --url https://spaces.nexudus.com/api/spaces/coworkermessages \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/spaces/coworkermessages"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/spaces/coworkermessages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

A customer message (CoworkerMessage) records an incoming or outgoing email communication associated with a customer; operators can create outbound messages and inspect message history by customer or connected email account.

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

eBusinessMessageName

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

Query Parameters

Pagination & Sorting

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

The property name to sort results by (e.g. Name, CreatedOn).

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

Filter by iD of the customer who sent or received this message; location access is determined through the customer’s InvoicingBusiness..

string

Filter by display value for Coworker.FullName..

string

Filter by display value for Coworker.Email..

string

Filter by display value for Coworker.BillingName..

string

Filter by display value for Coworker.CompanyName..

integer

Filter by iD of the optional connected email account used to send or receive this message; when omitted, the customer’s location default email settings are used..

string

Filter by display value for EmailAccount.DisplayName..

string

Filter by display value for EmailAccount.EmailAddress..

string

Filter by message subject, limited to 254 characters..

string

Filter by hTML message body; canned-response tokens are expanded for the customer before an outgoing email is queued..

boolean

Filter by whether the message is unread; the system clears this flag when the message is updated..

boolean

Filter by whether the message was received from the customer (true) rather than sent to the customer (false); inbound messages are created by the email integration..

integer

Filter by internal identifier assigned by the email provider when importing a message; it is not an automated message template ID..

string

Filter by internal unique identifier of the reminder that generated this message, when applicable..

integer

Filter by internal ID of the AI channel session used to associate this message with an AI conversation timeline..

string

Filter by internal RFC 5322 Message-ID header used for email threading and replies; generated by the sending workflow..

Range Filters

integer

Filter by internal identifier assigned by the email provider when importing a message; it is not an automated message template ID. greater than or equal to this value.

integer

Filter by internal identifier assigned by the email provider when importing a message; it is not an automated message template ID. less than or equal to this value.

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

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=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/coworkermessages?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'CreatedOn',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/spaces/coworkermessages',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'CreatedOn',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Filtering by CreatedOn

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

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/coworkermessages?' + new URLSearchParams({
    CoworkerMessage_CreatedOn: 'example-value',
    orderBy: 'CreatedOn',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/spaces/coworkermessages',
    params={
        'CoworkerMessage_CreatedOn': 'example-value',
        'orderBy': 'CreatedOn',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

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=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/coworkermessages?' + new URLSearchParams({
    from_CoworkerMessage_UpdatedOn: '2025-01-01T00:00',
    to_CoworkerMessage_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/spaces/coworkermessages',
    params={
        'from_CoworkerMessage_UpdatedOn': '2025-01-01T00:00',
        'to_CoworkerMessage_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

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.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

The sort direction (0 = ascending, 1 = descending).

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

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,
      "AiChannelSessionId": null,
      "RfcMessageId": 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
}

Search CoworkerMessages

curl --request GET \
  --url https://spaces.nexudus.com/api/spaces/coworkermessages \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/spaces/coworkermessages"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/spaces/coworkermessages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by CreatedOn

Range filters

Response

200

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by CreatedOn

​Range filters

​Response

​200

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by CreatedOn

Range filters

Response

200